Class: GRPC::ActiveCall

Inherits:
Object
  • Object
show all
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

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Core::TimeConsts

from_relative_time

Constructor Details

#initialize(call, q, marshal, unmarshal, deadline, started: true, metadata_tag: nil) ⇒ 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.

Parameters:

  • call (Call) —

    the call used by the ActiveCall

  • q (CompletionQueue) —

    the completion queue used to accept the call. This queue will be closed on call completion.

  • marshal (Function) —

    f(obj)->string that marshal requests

  • unmarshal (Function) —

    f(string)->obj that unmarshals responses

  • deadline (Fixnum) —

    the deadline for the call to complete

  • metadata_tag (Object) (defaults to: nil) —

    the object use obtain metadata for clients

  • started (true|false) (defaults to: true) —

    indicates if the call has begun



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 112

def initialize(call, q, marshal, unmarshal, deadline, started: true,
               metadata_tag: nil)
  fail(TypeError, '!Core::Call') unless call.is_a? Core::Call
  unless q.is_a? Core::CompletionQueue
    fail(TypeError, '!Core::CompletionQueue')
  end
  @call = call
  @cq = q
  @deadline = deadline
  @marshal = marshal
  @started = started
  @unmarshal = unmarshal
  @metadata_tag = metadata_tag
  @op_notifier = nil
end

Instance Attribute Details

#deadline ⇒ Object (readonly)

Returns the value of attribute deadline.



62
63
64
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 62

def deadline
  @deadline
end

Class Method Details

.client_invoke(call, q, 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

Parameters:

  • call (Call) —

    a call on which to start and invocation

  • q (CompletionQueue) —

    the completion queue

  • metadata (Hash) (defaults to: {}) —

    the metadata



80
81
82
83
84
85
86
87
88
89
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 80

def self.client_invoke(call, q, metadata = {})
  fail(TypeError, '!Core::Call') unless call.is_a? Core::Call
  unless q.is_a? Core::CompletionQueue
    fail(TypeError, '!Core::CompletionQueue')
  end
  metadata_tag = Object.new
  call.run_batch(q, metadata_tag, INFINITE_FUTURE,
                 SEND_INITIAL_METADATA => metadata)
  metadata_tag
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

Parameters:

  • requests (Object) —

    an Enumerable of requests to send

  • metadata (Hash) (defaults to: {}) —

    metadata to be sent to the server. If a value is

Returns:

  • (Enumerator, nil) —

    a response Enumerator



409
410
411
412
413
414
415
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 409

def bidi_streamer(requests, metadata: {}, &blk)
  start_call(metadata) unless @started
  bd = BidiCall.new(@call, @cq, @marshal, @unmarshal,
                    metadata_tag: @metadata_tag)
  @metadata_tag = nil  # run_on_client ensures metadata is read
  bd.run_on_client(requests, @op_notifier, &blk)
end

#cancelled ⇒ Object

cancelled indicates if the call was cancelled



135
136
137
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 135

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

Parameters:

  • requests (Object) —

    an Enumerable of requests to send

  • metadata (Hash) (defaults to: {}) —

    metadata to be sent to the server. If a value is

Returns:

  • (Object) —

    the response received from the server



344
345
346
347
348
349
350
351
352
353
354
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 344

def client_streamer(requests, metadata: {})
  start_call(metadata) unless @started
  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

Returns:

  • (Enumerator) —

    if no block was given



271
272
273
274
275
276
277
278
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 271

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

Returns:

  • (Enumerator) —

    if no block was given



300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 300

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.



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 181

def finished
  batch_result = @call.run_batch(@cq, self, INFINITE_FUTURE,
                                 RECV_STATUS_ON_CLIENT => nil)
  unless batch_result.status.nil?
    if @call.metadata.nil?
      @call.metadata = batch_result.status.metadata
    else
      @call.metadata.merge!(batch_result.status.metadata)
    end
  end
  @call.status = batch_result.status
  op_is_done
  batch_result.check_status
  @call.close
  @cq.close
end

#multi_req_view ⇒ Object

multi_req_view provides a restricted view of this ActiveCall for use in a server client-streaming handler.



141
142
143
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 141

def multi_req_view
  MultiReqView.new(self)
end

#op_is_done ⇒ Object

Signals that an operation is done



441
442
443
444
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 441

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.



153
154
155
156
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 153

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



130
131
132
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 130

def output_metadata
  @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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 235

def remote_read
  ops = { RECV_MESSAGE => nil }
  ops[RECV_INITIAL_METADATA] = nil unless @metadata_tag.nil?
  batch_result = @call.run_batch(@cq, self, INFINITE_FUTURE, ops)
  unless @metadata_tag.nil?
    @call.metadata = batch_result.metadata
    @metadata_tag = nil
  end
  GRPC.logger.debug("received req: #{batch_result}")
  unless batch_result.nil? || batch_result.message.nil?
    GRPC.logger.debug("received req.to_s: #{batch_result.message}")
    res = @unmarshal.call(batch_result.message)
    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.

Parameters:

  • req (Object, String) —

    the object to send or it’s marshal form.

  • marshalled (false, true) (defaults to: false) —

    indicates if the object is already



205
206
207
208
209
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 205

def remote_send(req, marshalled = false)
  GRPC.logger.debug("sending #{req}, marshalled? #{marshalled}")
  payload = marshalled ? req : @marshal.call(req)
  @call.run_batch(@cq, self, INFINITE_FUTURE, 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

Parameters:

  • req (Object) —

    the request sent to the server

  • metadata (Hash) (defaults to: {}) —

    metadata to be sent to the server. If a value is

Returns:

  • (Object) —

    the response received from the server



320
321
322
323
324
325
326
327
328
329
330
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 320

def request_response(req, metadata: {})
  start_call(metadata) unless @started
  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

Parameters:

  • gen_each_reply (Proc) —

    generates the BiDi stream replies



428
429
430
431
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 428

def run_server_bidi(gen_each_reply)
  bd = BidiCall.new(@call, @cq, @marshal, @unmarshal)
  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

Parameters:

  • code (int) (defaults to: OK) —

    the status code to send

  • details (String) (defaults to: '') —

    details

  • assert_finished (true, false) (defaults to: false) —

    when true(default), waits for

  • metadata (Hash) (defaults to: {}) —

    metadata to send to the server. If a value is a



219
220
221
222
223
224
225
226
227
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 219

def send_status(code = OK, details = '', assert_finished = false,
                metadata: {})
  ops = {
    SEND_STATUS_FROM_SERVER => Struct::Status.new(code, details, metadata)
  }
  ops[RECV_CLOSE_ON_SERVER] = nil if assert_finished
  @call.run_batch(@cq, self, INFINITE_FUTURE, 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

Parameters:

  • req (Object) —

    the request sent to the server

  • metadata (Hash) (defaults to: {}) —

    metadata to be sent to the server. If a value is

Returns:

  • (Enumerator|nil) —

    a response Enumerator



370
371
372
373
374
375
376
377
378
379
380
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 370

def server_streamer(req, metadata: {})
  start_call(metadata) unless @started
  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.



147
148
149
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 147

def single_req_view
  SingleReqView.new(self)
end

#wait ⇒ Object

Waits till an operation completes



434
435
436
437
438
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 434

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.

Parameters:

  • assert_finished (true, false) (defaults to: true) —

    when true(default), waits for



166
167
168
169
170
171
172
173
174
175
176
 
# File 'src/ruby/lib/grpc/generic/active_call.rb', line 166

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(@cq, self, INFINITE_FUTURE, ops)
  return unless assert_finished
  @call.status = batch_result.status
  op_is_done
  batch_result.check_status
end