Class: Gruf::Response

Inherits:
Object
  • Object
show all
Defined in:
lib/gruf/response.rb

Overview

Wraps the active call operation to provide metadata and timing around the request

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(op, execution_time = nil) ⇒ Response

Initialize a response object with the given gRPC operation

Parameters:

  • op (GRPC::ActiveCall::Operation) —

    The given operation for the current call

  • execution_time (Float) (defaults to: nil) —

    The amount of time that the response took to occur



41
42
43
44
45
46
47
48
49
 
# File 'lib/gruf/response.rb', line 41

def initialize(op, execution_time = nil)
  @operation = op
  @message = op.execute
  @metadata = op.metadata
  @trailing_metadata = op.trailing_metadata
  @deadline = op.deadline
  @cancelled = op.cancelled?
  @execution_time = execution_time || 0.0
end

Instance Attribute Details

#cancelled ⇒ Boolean (readonly)

Returns Whether or not the operation was cancelled.

Returns:

  • (Boolean) —

    Whether or not the operation was cancelled



31
32
33
 
# File 'lib/gruf/response.rb', line 31

def cancelled
  @cancelled
end

#deadline ⇒ Time (readonly)

Returns The set deadline on the call.

Returns:

  • (Time) —

    The set deadline on the call



29
30
31
 
# File 'lib/gruf/response.rb', line 29

def deadline
  @deadline
end

#execution_time ⇒ Float (readonly)

Returns The time that the request took to execute.

Returns:

  • (Float) —

    The time that the request took to execute



33
34
35
 
# File 'lib/gruf/response.rb', line 33

def execution_time
  @execution_time
end

#metadata ⇒ Hash (readonly)

Returns The metadata that was attached to the operation.

Returns:

  • (Hash) —

    The metadata that was attached to the operation



25
26
27
 
# File 'lib/gruf/response.rb', line 25

def metadata
  @metadata
end

#operation ⇒ GRPC::ActiveCall::Operation (readonly)

Returns The operation that was executed for the given request.

Returns:

  • (GRPC::ActiveCall::Operation) —

    The operation that was executed for the given request



23
24
25
 
# File 'lib/gruf/response.rb', line 23

def operation
  @operation
end

#trailing_metadata ⇒ Hash (readonly)

Returns The trailing metadata that the service returned.

Returns:

  • (Hash) —

    The trailing metadata that the service returned



27
28
29
 
# File 'lib/gruf/response.rb', line 27

def trailing_metadata
  @trailing_metadata
end

Instance Method Details

#internal_execution_time ⇒ Float

Return execution time of the call internally on the server in ms

Returns:

  • (Float) —

    The execution time of the response



65
66
67
 
# File 'lib/gruf/response.rb', line 65

def internal_execution_time
  trailing_metadata['timer'].to_f
end

#message ⇒ Object

Return the message returned by the request

Returns:

  • (Object) —

    The protobuf response message



56
57
58
 
# File 'lib/gruf/response.rb', line 56

def message
  @message ||= op.execute
end