Classes
class	Channel

class	ServerOptions

class	StubOptions

Functions
def	dynamic_stub (channel, service, cardinalities, options=None)

def	generic_stub (channel, options=None)

def	google_call_credentials (credentials)

def	insecure_channel (host, port)

def	metadata_call_credentials (metadata_plugin, name=None)

def	secure_channel (host, port, channel_credentials)

def	server (service_implementations, options=None)

def	server_options (multi_method_implementation=None, request_deserializers=None, response_serializers=None, thread_pool=None, thread_pool_size=None, default_timeout=None, maximum_timeout=None)

def	stub_options (host=None, request_serializers=None, response_deserializers=None, metadata_transformer=None, thread_pool=None, thread_pool_size=None)

Variables
	_EMPTY_SERVER_OPTIONS = ServerOptions(None, None, None, None, None, None, None)

	_EMPTY_STUB_OPTIONS = StubOptions(None, None, None, None, None, None)

	access_token_call_credentials = grpc.access_token_call_credentials

	CallCredentials = grpc.CallCredentials

	ChannelCredentials = grpc.ChannelCredentials

	composite_call_credentials = grpc.composite_call_credentials

	composite_channel_credentials = grpc.composite_channel_credentials

	ServerCredentials = grpc.ServerCredentials

	ssl_channel_credentials = grpc.ssl_channel_credentials

	ssl_server_credentials = grpc.ssl_server_credentials

Function Documentation

◆ dynamic_stub()

def grpc.beta.implementations.dynamic_stub	(	channel,
		service,
		cardinalities,
		options = `None`
	)

Creates a face.DynamicStub with which RPCs can be invoked.

  Args:
channel: A Channel for the returned face.DynamicStub to use.
service: The package-qualified full name of the service.
cardinalities: A dictionary from RPC method name to cardinality.Cardinality
  value identifying the cardinality of the RPC method.
options: An optional StubOptions value further customizing the functionality
  of the returned face.DynamicStub.

  Returns:
A face.DynamicStub with which RPCs can be invoked.

Definition at line 206 of file implementations.py.

◆ generic_stub()

def grpc.beta.implementations.generic_stub	(	channel,
		options = `None`
	)

Creates a face.GenericStub on which RPCs can be made.

  Args:
channel: A Channel for use by the created stub.
options: A StubOptions customizing the created stub.

  Returns:
A face.GenericStub on which RPCs can be made.

Definition at line 187 of file implementations.py.

◆ google_call_credentials()

def grpc.beta.implementations.google_call_credentials ( credentials )

Construct CallCredentials from GoogleCredentials.

  Args:
credentials: A GoogleCredentials object from the oauth2client library.

  Returns:
A CallCredentials object for use in a GRPCCallOptions object.

Definition at line 50 of file implementations.py.

◆ insecure_channel()

def grpc.beta.implementations.insecure_channel	(	host,
		port
	)

Creates an insecure Channel to a remote host.

  Args:
host: The name of the remote host to which to connect.
port: The port of the remote host to which to connect.
  If None only the 'host' part will be used.

  Returns:
A Channel to the remote host through which RPCs may be conducted.

Definition at line 103 of file implementations.py.

◆ metadata_call_credentials()

def grpc.beta.implementations.metadata_call_credentials	(	metadata_plugin,
		name = `None`
	)

Definition at line 38 of file implementations.py.

◆ secure_channel()

def grpc.beta.implementations.secure_channel	(	host,
		port,
		channel_credentials
	)

Creates a secure Channel to a remote host.

  Args:
host: The name of the remote host to which to connect.
port: The port of the remote host to which to connect.
  If None only the 'host' part will be used.
channel_credentials: A ChannelCredentials.

  Returns:
A secure Channel to the remote host through which RPCs may be conducted.

Definition at line 119 of file implementations.py.

◆ server()

def grpc.beta.implementations.server	(	service_implementations,
		options = `None`
	)

Creates an interfaces.Server with which RPCs can be serviced.

  Args:
service_implementations: A dictionary from service name-method name pair to
  face.MethodImplementation.
options: An optional ServerOptions value further customizing the
  functionality of the returned Server.

  Returns:
An interfaces.Server with which RPCs can be serviced.

Definition at line 294 of file implementations.py.

◆ server_options()

def grpc.beta.implementations.server_options	(	multi_method_implementation = `None`,
		request_deserializers = `None`,
		response_serializers = `None`,
		thread_pool = `None`,
		thread_pool_size = `None`,
		default_timeout = `None`,
		maximum_timeout = `None`
	)

Creates a ServerOptions value to be passed at server creation.

  All parameters are optional and should always be passed by keyword.

  Args:
multi_method_implementation: A face.MultiMethodImplementation to be called
  to service an RPC if the server has no specific method implementation for
  the name of the RPC for which service was requested.
request_deserializers: A dictionary from service name-method name pair to
  request deserialization behavior.
response_serializers: A dictionary from service name-method name pair to
  response serialization behavior.
thread_pool: A thread pool to use in stubs.
thread_pool_size: The size of thread pool to create for use in stubs;
  ignored if thread_pool has been passed.
default_timeout: A duration in seconds to allow for RPC service when
  servicing RPCs that did not include a timeout value when invoked.
maximum_timeout: A duration in seconds to allow for RPC service when
  servicing RPCs no matter what timeout value was passed when the RPC was
  invoked.

  Returns:
A StubOptions value created from the passed parameters.

Definition at line 258 of file implementations.py.

◆ stub_options()

def grpc.beta.implementations.stub_options	(	host = `None`,
		request_serializers = `None`,
		response_deserializers = `None`,
		metadata_transformer = `None`,
		thread_pool = `None`,
		thread_pool_size = `None`
	)

Creates a StubOptions value to be passed at stub creation.

  All parameters are optional and should always be passed by keyword.

  Args:
host: A host string to set on RPC calls.
request_serializers: A dictionary from service name-method name pair to
  request serialization behavior.
response_deserializers: A dictionary from service name-method name pair to
  response deserialization behavior.
metadata_transformer: A callable that given a metadata object produces
  another metadata object to be used in the underlying communication on the
  wire.
thread_pool: A thread pool to use in stubs.
thread_pool_size: The size of thread pool to create for use in stubs;
  ignored if thread_pool has been passed.

  Returns:
A StubOptions value created from the passed parameters.

Definition at line 157 of file implementations.py.

Variable Documentation

◆ _EMPTY_SERVER_OPTIONS

grpc.beta.implementations._EMPTY_SERVER_OPTIONS = ServerOptions(None, None, None, None, None, None, None)

private

Definition at line 255 of file implementations.py.

◆ _EMPTY_STUB_OPTIONS

grpc.beta.implementations._EMPTY_STUB_OPTIONS = StubOptions(None, None, None, None, None, None)

private

Definition at line 154 of file implementations.py.

◆ access_token_call_credentials

grpc.beta.implementations.access_token_call_credentials = grpc.access_token_call_credentials

Definition at line 62 of file implementations.py.

◆ CallCredentials

grpc.beta.implementations.CallCredentials = grpc.CallCredentials

Definition at line 35 of file implementations.py.

◆ ChannelCredentials

grpc.beta.implementations.ChannelCredentials = grpc.ChannelCredentials

Definition at line 33 of file implementations.py.

◆ composite_call_credentials

grpc.beta.implementations.composite_call_credentials = grpc.composite_call_credentials

Definition at line 63 of file implementations.py.

◆ composite_channel_credentials

grpc.beta.implementations.composite_channel_credentials = grpc.composite_channel_credentials

Definition at line 64 of file implementations.py.

◆ ServerCredentials

grpc.beta.implementations.ServerCredentials = grpc.ServerCredentials

Definition at line 231 of file implementations.py.

◆ ssl_channel_credentials

grpc.beta.implementations.ssl_channel_credentials = grpc.ssl_channel_credentials

Definition at line 34 of file implementations.py.

◆ ssl_server_credentials

grpc.beta.implementations.ssl_server_credentials = grpc.ssl_server_credentials

Definition at line 232 of file implementations.py.

Classes

Functions

Variables