grpc._channel._StreamUnaryMultiCallable Class Reference

Inheritance diagram for grpc._channel._StreamUnaryMultiCallable:

Public Member Functions
def	__call__ (self, request_iterator, timeout=None, metadata=None, credentials=None, wait_for_ready=None, compression=None)
def	__init__ (self, channel, managed_call, method, request_serializer, response_deserializer)
def	future (self, request_iterator, timeout=None, metadata=None, credentials=None, wait_for_ready=None, compression=None)
def	with_call (self, request_iterator, timeout=None, metadata=None, credentials=None, wait_for_ready=None, compression=None)

Private Member Functions
def	_blocking (self, request_iterator, timeout, metadata, credentials, wait_for_ready, compression)

Private Attributes
	_channel
	_context
	_managed_call
	_method
	_request_serializer
	_response_deserializer

Detailed Description

Definition at line 1085 of file grpc/_channel.py.

Constructor & Destructor Documentation

__init__()

def grpc._channel._StreamUnaryMultiCallable.__init__	(		self,
			channel,
			managed_call,
			method,
			request_serializer,
			response_deserializer
	)

Definition at line 1088 of file grpc/_channel.py.

Member Function Documentation

__call__()

def grpc._channel._StreamUnaryMultiCallable.__call__	(		self,
			request_iterator,
			timeout = None,
			metadata = None,
			credentials = None,
			wait_for_ready = None,
			compression = None
	)

Synchronously invokes the underlying RPC.

Args:
  request_iterator: An iterator that yields request values for
    the RPC.
  timeout: An optional duration of time in seconds to allow for
    the RPC. If None, the timeout is considered infinite.
  metadata: Optional :term:`metadata` to be transmitted to the
    service-side of the RPC.
  credentials: An optional CallCredentials for the RPC. Only valid for
    secure Channel.
  wait_for_ready: This is an EXPERIMENTAL argument. An optional
    flag to enable :term:`wait_for_ready` mechanism.
  compression: An element of grpc.compression, e.g.
    grpc.compression.Gzip. This is an EXPERIMENTAL option.

Returns:
  The response value for the RPC.

Raises:
  RpcError: Indicating that the RPC terminated with non-OK status. The
    raised RpcError will also implement grpc.Call, affording methods
    such as metadata, code, and details.

Reimplemented from grpc.StreamUnaryMultiCallable.

Definition at line 1122 of file grpc/_channel.py.

_blocking()

def grpc._channel._StreamUnaryMultiCallable._blocking (   self,   request_iterator,   timeout,   metadata,   credentials,   wait_for_ready,   compression  )

private

Definition at line 1097 of file grpc/_channel.py.

future()

def grpc._channel._StreamUnaryMultiCallable.future	(		self,
			request_iterator,
			timeout = None,
			metadata = None,
			credentials = None,
			wait_for_ready = None,
			compression = None
	)

Asynchronously invokes the underlying RPC on the client.

Args:
  request_iterator: An iterator that yields request values for the RPC.
  timeout: An optional duration of time in seconds to allow for
    the RPC. If None, the timeout is considered infinite.
  metadata: Optional :term:`metadata` to be transmitted to the
    service-side of the RPC.
  credentials: An optional CallCredentials for the RPC. Only valid for
    secure Channel.
  wait_for_ready: This is an EXPERIMENTAL argument. An optional
    flag to enable :term:`wait_for_ready` mechanism.
  compression: An element of grpc.compression, e.g.
    grpc.compression.Gzip. This is an EXPERIMENTAL option.

Returns:
    An object that is both a Call for the RPC and a Future.
    In the event of RPC completion, the return Call-Future's result value
    will be the response message of the RPC. Should the event terminate
    with non-OK status, the returned Call-Future's exception value will
    be an RpcError.

Reimplemented from grpc.StreamUnaryMultiCallable.

Definition at line 1144 of file grpc/_channel.py.

with_call()

def grpc._channel._StreamUnaryMultiCallable.with_call	(		self,
			request_iterator,
			timeout = None,
			metadata = None,
			credentials = None,
			wait_for_ready = None,
			compression = None
	)

Synchronously invokes the underlying RPC on the client.

Args:
  request_iterator: An iterator that yields request values for
    the RPC.
  timeout: An optional duration of time in seconds to allow for
    the RPC. If None, the timeout is considered infinite.
  metadata: Optional :term:`metadata` to be transmitted to the
    service-side of the RPC.
  credentials: An optional CallCredentials for the RPC. Only valid for
    secure Channel.
  wait_for_ready: This is an EXPERIMENTAL argument. An optional
    flag to enable :term:`wait_for_ready` mechanism.
  compression: An element of grpc.compression, e.g.
    grpc.compression.Gzip. This is an EXPERIMENTAL option.

Returns:
  The response value for the RPC and a Call object for the RPC.

Raises:
  RpcError: Indicating that the RPC terminated with non-OK status. The
    raised RpcError will also be a Call for the RPC affording the RPC's
    metadata, status code, and details.

Reimplemented from grpc.StreamUnaryMultiCallable.

Definition at line 1133 of file grpc/_channel.py.

Member Data Documentation

_channel

grpc._channel._StreamUnaryMultiCallable._channel

private

Definition at line 1089 of file grpc/_channel.py.

_context

grpc._channel._StreamUnaryMultiCallable._context

private

Definition at line 1094 of file grpc/_channel.py.

_managed_call

grpc._channel._StreamUnaryMultiCallable._managed_call

private

Definition at line 1090 of file grpc/_channel.py.

_method

grpc._channel._StreamUnaryMultiCallable._method

private

Definition at line 1091 of file grpc/_channel.py.

_request_serializer

grpc._channel._StreamUnaryMultiCallable._request_serializer

private

Definition at line 1092 of file grpc/_channel.py.

_response_deserializer

grpc._channel._StreamUnaryMultiCallable._response_deserializer

private

Definition at line 1093 of file grpc/_channel.py.

---

The documentation for this class was generated from the following file:

• grpc/_channel.py