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(operation:, message:, execution_time: nil) ⇒ Response

Initialize a response object with the given gRPC operation

Parameters:

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

    The given operation for the current call

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

    The amount of time that the response took to occur



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

def initialize(operation:, message:, execution_time: nil)
  @operation = operation
  @message = message
  @metadata = operation.metadata
  @trailing_metadata = operation.trailing_metadata
  @deadline = operation.deadline
  @cancelled = operation.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



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

def cancelled
  @cancelled
end

#deadline ⇒ Time (readonly)

Returns The set deadline on the call.

Returns:

  • (Time) —

    The set deadline on the call



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

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



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

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



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

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



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

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



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

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



67
68
69
 
# File 'lib/gruf/response.rb', line 67

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



58
59
60
 
# File 'lib/gruf/response.rb', line 58

def message
  @message ||= @operation.execute
end