Class: GRPC::ActiveCall
- Inherits:
-
Object
- Object
- GRPC::ActiveCall
- Extended by:
- Forwardable
- Includes:
- Core::CallOps, Core::TimeConsts
- Defined in:
- src/ruby/lib/grpc/generic/active_call.rb
Overview
The ActiveCall class provides simple methods for sending marshallable data to a call
Instance Attribute Summary collapse
-
#deadline ⇒ Object
readonly
Returns the value of attribute deadline.
Class Method Summary collapse
-
.client_invoke(call, metadata = {}) ⇒ Object
client_invoke begins a client invocation.
Instance Method Summary collapse
-
#bidi_streamer(requests, metadata: {}, &blk) ⇒ Enumerator?
bidi_streamer sends a stream of requests to the GRPC server, and yields a stream of responses.
-
#cancelled? ⇒ Boolean
cancelled indicates if the call was cancelled.
-
#client_streamer(requests, metadata: {}) ⇒ Object
client_streamer sends a stream of requests to a GRPC server, and returns a single response.
-
#each_remote_read ⇒ Enumerator
each_remote_read passes each response to the given block or returns an enumerator the responses if no block is given.
-
#each_remote_read_then_finish ⇒ Enumerator
each_remote_read_then_finish passes each response to the given block or returns an enumerator of the responses if no block is given.
-
#finished ⇒ Object
finished waits until a client call is completed.
-
#initialize(call, marshal, unmarshal, deadline, started: true, metadata_received: false) ⇒ ActiveCall
constructor
Creates an ActiveCall.
-
#multi_req_view ⇒ Object
multi_req_view provides a restricted view of this ActiveCall for use in a server client-streaming handler.
-
#op_is_done ⇒ Object
Signals that an operation is done.
-
#operation ⇒ Object
operation provides a restricted view of this ActiveCall for use as a Operation.
-
#output_metadata ⇒ Object
output_metadata are provides access to hash that can be used to save metadata to be sent as trailer.
-
#remote_read ⇒ Object
remote_read reads a response from the remote endpoint.
-
#remote_send(req, marshalled = false) ⇒ Object
remote_send sends a request to the remote endpoint.
-
#request_response(req, metadata: {}) ⇒ Object
request_response sends a request to a GRPC server, and returns the response.
-
#run_server_bidi(gen_each_reply) ⇒ Object
run_server_bidi orchestrates a BiDi stream processing on a server.
-
#send_status(code = OK, details = '', assert_finished = false, metadata: {}) ⇒ Object
send_status sends a status to the remote endpoint.
-
#server_streamer(req, metadata: {}) ⇒ Enumerator|nil
server_streamer sends one request to the GRPC server, which yields a stream of responses.
-
#single_req_view ⇒ Object
single_req_view provides a restricted view of this ActiveCall for use in a server request-response handler.
-
#wait ⇒ Object
Waits till an operation completes.
-
#writes_done(assert_finished = true) ⇒ Object
writes_done indicates that all writes are completed.
Methods included from Core::TimeConsts
Constructor Details
#initialize(call, marshal, unmarshal, deadline, started: true, metadata_received: false) ⇒ ActiveCall
Creates an ActiveCall.
ActiveCall should only be created after a call is accepted. That means different things on a client and a server. On the client, the call is accepted after calling call.invoke. On the server, this is after call.accept.
#initialize cannot determine if the call is accepted or not; so if a call that’s not accepted is used here, the error won’t be visible until the ActiveCall methods are called.
deadline is the absolute deadline for the call.
103 104 105 106 107 108 109 110 111 112 113 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 103 def initialize(call, marshal, unmarshal, deadline, started: true, metadata_received: false) fail(TypeError, '!Core::Call') unless call.is_a? Core::Call @call = call @deadline = deadline @marshal = marshal @unmarshal = unmarshal @metadata_received = @metadata_sent = started @op_notifier = nil end |
Instance Attribute Details
#deadline ⇒ Object (readonly)
Returns the value of attribute deadline.
61 62 63 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 61 def deadline @deadline end |
Class Method Details
.client_invoke(call, metadata = {}) ⇒ Object
client_invoke begins a client invocation.
Flow Control note: this blocks until flow control accepts that client request can go ahead.
deadline is the absolute deadline for the call.
Keyword Arguments ==
any keyword arguments are treated as metadata to be sent to the server if a keyword value is a list, multiple metadata for it’s key are sent
78 79 80 81 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 78 def self.client_invoke(call, = {}) fail(TypeError, '!Core::Call') unless call.is_a? Core::Call call.run_batch(SEND_INITIAL_METADATA => ) end |
Instance Method Details
#bidi_streamer(requests, metadata: {}, &blk) ⇒ Enumerator?
bidi_streamer sends a stream of requests to the GRPC server, and yields a stream of responses.
This method takes an Enumerable of requests, and returns and enumerable of responses.
requests ==
requests provides an ‘iterable’ of Requests. I.e. it follows Ruby’s #each enumeration protocol. In the simplest case, requests will be an array of marshallable objects; in typical case it will be an Enumerable that allows dynamic construction of the marshallable objects.
responses ==
This is an enumerator of responses. I.e, its #next method blocks waiting for the next response. Also, if at any point the block needs to consume all the remaining responses, this can be done using #each or #collect. Calling #each or #collect should only be done if the_call#writes_done has been called, otherwise the block will loop forever.
a list, multiple metadata for its key are sent
394 395 396 397 398 399 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 394 def bidi_streamer(requests, metadata: {}, &blk) start_call() bd = BidiCall.new(@call, @marshal, @unmarshal, metadata_received: @metadata_received) bd.run_on_client(requests, @op_notifier, &blk) end |
#cancelled? ⇒ Boolean
cancelled indicates if the call was cancelled
122 123 124 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 122 def cancelled? !@call.status.nil? && @call.status.code == Core::StatusCodes::CANCELLED end |
#client_streamer(requests, metadata: {}) ⇒ Object
client_streamer sends a stream of requests to a GRPC server, and returns a single response.
requests provides an ‘iterable’ of Requests. I.e. it follows Ruby’s #each enumeration protocol. In the simplest case, requests will be an array of marshallable objects; in typical case it will be an Enumerable that allows dynamic construction of the marshallable objects.
a list, multiple metadata for its key are sent
329 330 331 332 333 334 335 336 337 338 339 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 329 def client_streamer(requests, metadata: {}) start_call() requests.each { |r| remote_send(r) } writes_done(false) response = remote_read finished unless response.is_a? Struct::Status response rescue GRPC::Core::CallError => e finished # checks for Cancelled raise e end |
#each_remote_read ⇒ Enumerator
each_remote_read passes each response to the given block or returns an enumerator the responses if no block is given.
Enumerator ==
-
#next blocks until the remote endpoint sends a READ or FINISHED
-
for each read, enumerator#next yields the response
-
on status
* if it's is OK, enumerator#next raises StopException * if is not OK, enumerator#next raises RuntimeException
Block ==
-
if provided it is executed for each response
-
the call blocks until no more responses are provided
256 257 258 259 260 261 262 263 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 256 def each_remote_read return enum_for(:each_remote_read) unless block_given? loop do resp = remote_read break if resp.nil? # the last response was received yield resp end end |
#each_remote_read_then_finish ⇒ Enumerator
each_remote_read_then_finish passes each response to the given block or returns an enumerator of the responses if no block is given.
It is like each_remote_read, but it blocks on finishing on detecting the final message.
Enumerator ==
-
#next blocks until the remote endpoint sends a READ or FINISHED
-
for each read, enumerator#next yields the response
-
on status
* if it's is OK, enumerator#next raises StopException * if is not OK, enumerator#next raises RuntimeException
Block ==
-
if provided it is executed for each response
-
the call blocks until no more responses are provided
285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 285 def each_remote_read_then_finish return enum_for(:each_remote_read_then_finish) unless block_given? loop do resp = remote_read break if resp.is_a? Struct::Status # is an OK status if resp.nil? # the last response was received, but not finished yet finished break end yield resp end end |
#finished ⇒ Object
finished waits until a client call is completed.
It blocks until the remote endpoint acknowledges by sending a status.
171 172 173 174 175 176 177 178 179 180 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 171 def finished batch_result = @call.run_batch(RECV_STATUS_ON_CLIENT => nil) unless batch_result.status.nil? @call. = batch_result.status. end @call.status = batch_result.status op_is_done batch_result.check_status @call.close end |
#multi_req_view ⇒ Object
multi_req_view provides a restricted view of this ActiveCall for use in a server client-streaming handler.
128 129 130 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 128 def multi_req_view MultiReqView.new(self) end |
#op_is_done ⇒ Object
Signals that an operation is done
426 427 428 429 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 426 def op_is_done return if @op_notifier.nil? @op_notifier.notify(self) end |
#operation ⇒ Object
operation provides a restricted view of this ActiveCall for use as a Operation.
140 141 142 143 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 140 def operation @op_notifier = Notifier.new Operation.new(self) end |
#output_metadata ⇒ Object
output_metadata are provides access to hash that can be used to save metadata to be sent as trailer
117 118 119 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 117 def @output_metadata ||= {} end |
#remote_read ⇒ Object
remote_read reads a response from the remote endpoint.
It blocks until the remote endpoint replies with a message or status. On receiving a message, it returns the response after unmarshalling it. On receiving a status, it returns nil if the status is OK, otherwise raising BadStatus
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 220 def remote_read ops = { RECV_MESSAGE => nil } ops[RECV_INITIAL_METADATA] = nil unless @metadata_received batch_result = @call.run_batch(ops) unless @metadata_received @call. = batch_result. @metadata_received = true end GRPC.logger.debug("received req: #{batch_result}") unless batch_result.nil? || batch_result..nil? GRPC.logger.debug("received req.to_s: #{batch_result.}") res = @unmarshal.call(batch_result.) GRPC.logger.debug("received_req (unmarshalled): #{res.inspect}") return res end GRPC.logger.debug('found nil; the final response has been sent') nil end |
#remote_send(req, marshalled = false) ⇒ Object
remote_send sends a request to the remote endpoint.
It blocks until the remote endpoint accepts the message.
marshalled.
189 190 191 192 193 194 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 189 def remote_send(req, marshalled = false) # TODO(murgatroid99): ensure metadata was sent GRPC.logger.debug("sending #{req}, marshalled? #{marshalled}") payload = marshalled ? req : @marshal.call(req) @call.run_batch(SEND_MESSAGE => payload) end |
#request_response(req, metadata: {}) ⇒ Object
request_response sends a request to a GRPC server, and returns the response.
a list, multiple metadata for its key are sent
305 306 307 308 309 310 311 312 313 314 315 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 305 def request_response(req, metadata: {}) start_call() remote_send(req) writes_done(false) response = remote_read finished unless response.is_a? Struct::Status response rescue GRPC::Core::CallError => e finished # checks for Cancelled raise e end |
#run_server_bidi(gen_each_reply) ⇒ Object
run_server_bidi orchestrates a BiDi stream processing on a server.
N.B. gen_each_reply is a func(Enumerable<Requests>)
It takes an enumerable of requests as an arg, in case there is a relationship between the stream of requests and the stream of replies.
This does not mean that must necessarily be one. E.g, the replies produced by gen_each_reply could ignore the received_msgs
412 413 414 415 416 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 412 def run_server_bidi(gen_each_reply) bd = BidiCall.new(@call, @marshal, @unmarshal, metadata_received: @metadata_received) bd.run_on_server(gen_each_reply) end |
#send_status(code = OK, details = '', assert_finished = false, metadata: {}) ⇒ Object
send_status sends a status to the remote endpoint.
FINISHED. list, mulitple metadata for its key are sent
204 205 206 207 208 209 210 211 212 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 204 def send_status(code = OK, details = '', assert_finished = false, metadata: {}) ops = { SEND_STATUS_FROM_SERVER => Struct::Status.new(code, details, ) } ops[RECV_CLOSE_ON_SERVER] = nil if assert_finished @call.run_batch(ops) nil end |
#server_streamer(req, metadata: {}) ⇒ Enumerator|nil
server_streamer sends one request to the GRPC server, which yields a stream of responses.
responses provides an enumerator over the streamed responses, i.e. it follows Ruby’s #each iteration protocol. The enumerator blocks while waiting for each response, stops when the server signals that no further responses will be supplied. If the implicit block is provided, it is executed with each response as the argument and no result is returned.
a list, multiple metadata for its key are sent
355 356 357 358 359 360 361 362 363 364 365 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 355 def server_streamer(req, metadata: {}) start_call() remote_send(req) writes_done(false) replies = enum_for(:each_remote_read_then_finish) return replies unless block_given? replies.each { |r| yield r } rescue GRPC::Core::CallError => e finished # checks for Cancelled raise e end |
#single_req_view ⇒ Object
single_req_view provides a restricted view of this ActiveCall for use in a server request-response handler.
134 135 136 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 134 def single_req_view SingleReqView.new(self) end |
#wait ⇒ Object
Waits till an operation completes
419 420 421 422 423 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 419 def wait return if @op_notifier.nil? GRPC.logger.debug("active_call.wait: on #{@op_notifier}") @op_notifier.wait end |
#writes_done(assert_finished = true) ⇒ Object
writes_done indicates that all writes are completed.
It blocks until the remote endpoint acknowledges with at status unless assert_finished is set to false. Any calls to #remote_send after this call will fail.
FINISHED.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 153 def writes_done(assert_finished = true) ops = { SEND_CLOSE_FROM_CLIENT => nil } ops[RECV_STATUS_ON_CLIENT] = nil if assert_finished batch_result = @call.run_batch(ops) return unless assert_finished unless batch_result.status.nil? @call. = batch_result.status. end @call.status = batch_result.status op_is_done batch_result.check_status end |