Class: GRPC::RpcDesc

Inherits:
Struct show all
Includes:
Core::StatusCodes
Defined in:
src/ruby/lib/grpc/generic/rpc_desc.rb

Overview

RpcDesc is a Descriptor of an RPC method.

Defined Under Namespace

Classes: Stream

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#input ⇒ Object

Returns the value of attribute input

Returns:

  • (Object) —

    the current value of input



35
36
37
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 35

def input
  @input
end

#marshal_method ⇒ Object

Returns the value of attribute marshal_method

Returns:

  • (Object) —

    the current value of marshal_method



35
36
37
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 35

def marshal_method
  @marshal_method
end

#name ⇒ Object

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



35
36
37
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 35

def name
  @name
end

#output ⇒ Object

Returns the value of attribute output

Returns:

  • (Object) —

    the current value of output



35
36
37
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 35

def output
  @output
end

#unmarshal_method ⇒ Object

Returns the value of attribute unmarshal_method

Returns:

  • (Object) —

    the current value of unmarshal_method



35
36
37
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 35

def unmarshal_method
  @unmarshal_method
end

Instance Method Details

#arity_error(mth, want, msg) ⇒ Object 



160
161
162
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 160

def arity_error(mth, want, msg)
  "##{mth.name}: bad arg count; got:#{mth.arity}, want:#{want}, #{msg}"
end

#assert_arity_matches(mth) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 125

def assert_arity_matches(mth)
  # A bidi handler function can optionally be passed a second
  # call object parameter for access to metadata, cancelling, etc.
  if bidi_streamer?
    if mth.arity != 2 && mth.arity != 1
      fail arity_error(mth, 2, "should be #{mth.name}(req, call) or " \
        "#{mth.name}(req)")
    end
  elsif request_response? || server_streamer?
    if mth.arity != 2
      fail arity_error(mth, 2, "should be #{mth.name}(req, call)")
    end
  else
    if mth.arity != 1
      fail arity_error(mth, 1, "should be #{mth.name}(call)")
    end
  end
end

#bidi_streamer? ⇒ Boolean

Returns:

  • (Boolean) 


156
157
158
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 156

def bidi_streamer?
  input.is_a?(Stream) && output.is_a?(Stream)
end

#client_streamer? ⇒ Boolean

Returns:

  • (Boolean) 


148
149
150
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 148

def client_streamer?
  input.is_a?(Stream) && !output.is_a?(Stream)
end

#handle_bidi_streamer(active_call, mth) ⇒ Object 



85
86
87
88
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 85

def handle_bidi_streamer(active_call, mth)
  active_call.run_server_bidi(mth)
  send_status(active_call, OK, 'OK', active_call.output_metadata)
end

#handle_client_streamer(active_call, mth) ⇒ Object 



72
73
74
75
76
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 72

def handle_client_streamer(active_call,  mth)
  resp = mth.call(active_call.multi_req_view)
  active_call.server_unary_response(
    resp, trailing_metadata: active_call.output_metadata)
end

#handle_request_response(active_call, mth) ⇒ Object 



65
66
67
68
69
70
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 65

def handle_request_response(active_call, mth)
  req = active_call.remote_read
  resp = mth.call(req, active_call.single_req_view)
  active_call.server_unary_response(
    resp, trailing_metadata: active_call.output_metadata)
end

#handle_server_streamer(active_call, mth) ⇒ Object 



78
79
80
81
82
83
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 78

def handle_server_streamer(active_call, mth)
  req = active_call.remote_read
  replys = mth.call(req, active_call.single_req_view)
  replys.each { |r| active_call.remote_send(r) }
  send_status(active_call, OK, 'OK', active_call.output_metadata)
end

#marshal_proc ⇒ Proc

Returns { |instance| marshalled(instance) }.

Returns:

  • (Proc) —

    { |instance| marshalled(instance) }



49
50
51
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 49

def marshal_proc
  proc { |o| o.class.method(marshal_method).call(o).to_s }
end

#request_response? ⇒ Boolean

Returns:

  • (Boolean) 


144
145
146
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 144

def request_response?
  !input.is_a?(Stream) && !output.is_a?(Stream)
end

#run_server_method(active_call, mth) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 90

def run_server_method(active_call, mth)
  # While a server method is running, it might be cancelled, its deadline
  # might be reached, the handler could throw an unknown error, or a
  # well-behaved handler could throw a StatusError.
  if request_response?
    handle_request_response(active_call, mth)
  elsif client_streamer?
    handle_client_streamer(active_call, mth)
  elsif server_streamer?
    handle_server_streamer(active_call, mth)
  else  # is a bidi_stream
    handle_bidi_streamer(active_call, mth)
  end
rescue BadStatus => e
  # this is raised by handlers that want GRPC to send an application error
  # code and detail message and some additional app-specific metadata.
  GRPC.logger.debug("app err:#{active_call}, status:#{e.code}:#{e.details}")
  send_status(active_call, e.code, e.details, e.metadata)
rescue Core::CallError => e
  # This is raised by GRPC internals but should rarely, if ever happen.
  # Log it, but don't notify the other endpoint..
  GRPC.logger.warn("failed call: #{active_call}\n#{e}")
rescue Core::OutOfTime
  # This is raised when active_call#method.call exceeds the deadline
  # event.  Send a status of deadline exceeded
  GRPC.logger.warn("late call: #{active_call}")
  send_status(active_call, DEADLINE_EXCEEDED, 'late')
rescue StandardError => e
  # This will usuaally be an unhandled error in the handling code.
  # Send back a UNKNOWN status to the client
  GRPC.logger.warn("failed handler: #{active_call}; sending status:UNKNOWN")
  GRPC.logger.warn(e)
  send_status(active_call, UNKNOWN, "#{e.class}: #{e.message}")
end

#send_status(active_client, code, details, metadata = {}) ⇒ Object 



164
165
166
167
168
169
170
171
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 164

def send_status(active_client, code, details, metadata = {})
  details = 'Not sure why' if details.nil?
  GRPC.logger.debug("Sending status  #{code}:#{details}")
  active_client.send_status(code, details, code == OK, metadata: metadata)
rescue StandardError => e
  GRPC.logger.warn("Could not send status #{code}:#{details}")
  GRPC.logger.warn(e)
end

#server_streamer? ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 152

def server_streamer?
  !input.is_a?(Stream) && output.is_a?(Stream)
end

#unmarshal_proc(target) ⇒ Proc

Returns An unmarshal proc { |marshalled(instance)| instance }.

Parameters:

  • target (:input, :output) —

    determines whether to produce the an unmarshal Proc for the rpc input parameter or its output parameter

Returns:

  • (Proc) —

    An unmarshal proc { |marshalled(instance)| instance }



58
59
60
61
62
63
 
# File 'src/ruby/lib/grpc/generic/rpc_desc.rb', line 58

def unmarshal_proc(target)
  fail ArgumentError unless [:input, :output].include?(target)
  unmarshal_class = method(target).call
  unmarshal_class = unmarshal_class.type if unmarshal_class.is_a? Stream
  proc { |o| unmarshal_class.method(unmarshal_method).call(o) }
end