Classes | Functions | Variables
grpc._server Namespace Reference

Classes

class  _Context
 
class  _HandlerCallDetails
 
class  _RequestIterator
 
class  _RPCState
 
class  _Server
 
class  _ServerStage
 
class  _ServerState
 

Functions

def _abort (state, call, code, details)
 
def _abortion_code (state, code)
 
def _add_generic_handlers (state, generic_handlers)
 
def _add_insecure_port (state, address)
 
def _add_secure_port (state, address, server_credentials)
 
def _application_code (code)
 
def _augment_options (base_options, compression)
 
def _begin_shutdown_once (state)
 
def _call_behavior (rpc_event, state, behavior, argument, request_deserializer, send_response_callback=None)
 
def _completion_code (state)
 
def _details (state)
 
def _find_method_handler (rpc_event, generic_handlers, interceptor_pipeline)
 
def _get_initial_metadata (state, metadata)
 
def _get_initial_metadata_operation (state, metadata)
 
def _get_send_message_op_flags_from_state (state)
 
def _handle_call (rpc_event, generic_handlers, interceptor_pipeline, thread_pool, concurrency_exceeded)
 
def _handle_stream_stream (rpc_event, state, method_handler, default_thread_pool)
 
def _handle_stream_unary (rpc_event, state, method_handler, default_thread_pool)
 
def _handle_unary_stream (rpc_event, state, method_handler, default_thread_pool)
 
def _handle_unary_unary (rpc_event, state, method_handler, default_thread_pool)
 
def _handle_with_method_handler (rpc_event, method_handler, thread_pool)
 
def _is_rpc_state_active (state)
 
def _on_call_completed (state)
 
def _possibly_finish_call (state, token)
 
def _process_event_and_continue (state, event)
 
def _raise_rpc_error (state)
 
def _receive_close_on_server (state)
 
def _receive_message (state, call, request_deserializer)
 
def _reject_rpc (rpc_event, status, details)
 
def _request_call (state)
 
def _reset_per_message_state (state)
 
def _select_thread_pool_for_behavior (behavior, default_thread_pool)
 
def _send_initial_metadata (state)
 
def _send_message (state, token)
 
def _send_message_callback_to_blocking_iterator_adapter (rpc_event, state, send_response_callback, response_iterator)
 
def _send_response (rpc_event, state, serialized_response)
 
def _send_status_from_server (state, token)
 
def _serialize_response (rpc_event, state, response, response_serializer)
 
def _serialized_request (request_event)
 
def _serve (state)
 
def _start (state)
 
def _status (rpc_event, state, serialized_response)
 
def _stop (state, grace)
 
def _stop_serving (state)
 
def _stream_response_in_pool (rpc_event, state, behavior, argument_thunk, request_deserializer, response_serializer)
 
def _take_response_from_response_iterator (rpc_event, state, response_iterator)
 
def _unary_request (rpc_event, state, request_deserializer)
 
def _unary_response_in_pool (rpc_event, state, behavior, argument_thunk, request_deserializer, response_serializer)
 
def _validate_generic_rpc_handlers (generic_rpc_handlers)
 
def create_server (thread_pool, generic_rpc_handlers, interceptors, options, maximum_concurrent_rpcs, compression, xds)
 

Variables

string _CANCELLED = 'cancelled'
 
string _CLOSED = 'closed'
 
float _DEALLOCATED_SERVER_CHECK_PERIOD_S = 1.0
 
int _EMPTY_FLAGS = 0
 
int _INF_TIMEOUT = 1e9
 
 _LOGGER = logging.getLogger(__name__)
 
string _OPEN = 'open'
 
string _RECEIVE_CLOSE_ON_SERVER_TOKEN = 'receive_close_on_server'
 
string _RECEIVE_MESSAGE_TOKEN = 'receive_message'
 
string _REQUEST_CALL_TAG = 'request_call'
 
tuple _SEND_INITIAL_METADATA_AND_SEND_MESSAGE_TOKEN
 
tuple _SEND_INITIAL_METADATA_AND_SEND_STATUS_FROM_SERVER_TOKEN
 
string _SEND_INITIAL_METADATA_TOKEN = 'send_initial_metadata'
 
string _SEND_MESSAGE_TOKEN = 'send_message'
 
string _SEND_STATUS_FROM_SERVER_TOKEN = 'send_status_from_server'
 
string _SHUTDOWN_TAG = 'shutdown'
 

Function Documentation

◆ _abort()

def grpc._server._abort (   state,
  call,
  code,
  details 
)
private

Definition at line 154 of file grpc/_server.py.

◆ _abortion_code()

def grpc._server._abortion_code (   state,
  code 
)
private

Definition at line 71 of file grpc/_server.py.

◆ _add_generic_handlers()

def grpc._server._add_generic_handlers (   state,
  generic_handlers 
)
private

Definition at line 795 of file grpc/_server.py.

◆ _add_insecure_port()

def grpc._server._add_insecure_port (   state,
  address 
)
private

Definition at line 800 of file grpc/_server.py.

◆ _add_secure_port()

def grpc._server._add_secure_port (   state,
  address,
  server_credentials 
)
private

Definition at line 805 of file grpc/_server.py.

◆ _application_code()

def grpc._server._application_code (   code)
private

Definition at line 59 of file grpc/_server.py.

◆ _augment_options()

def grpc._server._augment_options (   base_options,
  compression 
)
private

Definition at line 947 of file grpc/_server.py.

◆ _begin_shutdown_once()

def grpc._server._begin_shutdown_once (   state)
private

Definition at line 891 of file grpc/_server.py.

◆ _call_behavior()

def grpc._server._call_behavior (   rpc_event,
  state,
  behavior,
  argument,
  request_deserializer,
  send_response_callback = None 
)
private

Definition at line 428 of file grpc/_server.py.

◆ _completion_code()

def grpc._server._completion_code (   state)
private

Definition at line 64 of file grpc/_server.py.

◆ _details()

def grpc._server._details (   state)
private

Definition at line 78 of file grpc/_server.py.

◆ _find_method_handler()

def grpc._server._find_method_handler (   rpc_event,
  generic_handlers,
  interceptor_pipeline 
)
private

Definition at line 679 of file grpc/_server.py.

◆ _get_initial_metadata()

def grpc._server._get_initial_metadata (   state,
  metadata 
)
private

Definition at line 134 of file grpc/_server.py.

◆ _get_initial_metadata_operation()

def grpc._server._get_initial_metadata_operation (   state,
  metadata 
)
private

Definition at line 148 of file grpc/_server.py.

◆ _get_send_message_op_flags_from_state()

def grpc._server._get_send_message_op_flags_from_state (   state)
private

Definition at line 488 of file grpc/_server.py.

◆ _handle_call()

def grpc._server._handle_call (   rpc_event,
  generic_handlers,
  interceptor_pipeline,
  thread_pool,
  concurrency_exceeded 
)
private

Definition at line 737 of file grpc/_server.py.

◆ _handle_stream_stream()

def grpc._server._handle_stream_stream (   rpc_event,
  state,
  method_handler,
  default_thread_pool 
)
private

Definition at line 666 of file grpc/_server.py.

◆ _handle_stream_unary()

def grpc._server._handle_stream_unary (   rpc_event,
  state,
  method_handler,
  default_thread_pool 
)
private

Definition at line 654 of file grpc/_server.py.

◆ _handle_unary_stream()

def grpc._server._handle_unary_stream (   rpc_event,
  state,
  method_handler,
  default_thread_pool 
)
private

Definition at line 643 of file grpc/_server.py.

◆ _handle_unary_unary()

def grpc._server._handle_unary_unary (   rpc_event,
  state,
  method_handler,
  default_thread_pool 
)
private

Definition at line 632 of file grpc/_server.py.

◆ _handle_with_method_handler()

def grpc._server._handle_with_method_handler (   rpc_event,
  method_handler,
  thread_pool 
)
private

Definition at line 714 of file grpc/_server.py.

◆ _is_rpc_state_active()

def grpc._server._is_rpc_state_active (   state)
private

Definition at line 606 of file grpc/_server.py.

◆ _on_call_completed()

def grpc._server._on_call_completed (   state)
private

Definition at line 829 of file grpc/_server.py.

◆ _possibly_finish_call()

def grpc._server._possibly_finish_call (   state,
  token 
)
private

Definition at line 115 of file grpc/_server.py.

◆ _process_event_and_continue()

def grpc._server._process_event_and_continue (   state,
  event 
)
private

Definition at line 834 of file grpc/_server.py.

◆ _raise_rpc_error()

def grpc._server._raise_rpc_error (   state)
private

Definition at line 109 of file grpc/_server.py.

◆ _receive_close_on_server()

def grpc._server._receive_close_on_server (   state)
private

Definition at line 178 of file grpc/_server.py.

◆ _receive_message()

def grpc._server._receive_message (   state,
  call,
  request_deserializer 
)
private

Definition at line 192 of file grpc/_server.py.

◆ _reject_rpc()

def grpc._server._reject_rpc (   rpc_event,
  status,
  details 
)
private

Definition at line 699 of file grpc/_server.py.

◆ _request_call()

def grpc._server._request_call (   state)
private

Definition at line 811 of file grpc/_server.py.

◆ _reset_per_message_state()

def grpc._server._reset_per_message_state (   state)
private

Definition at line 495 of file grpc/_server.py.

◆ _select_thread_pool_for_behavior()

def grpc._server._select_thread_pool_for_behavior (   behavior,
  default_thread_pool 
)
private

Definition at line 624 of file grpc/_server.py.

◆ _send_initial_metadata()

def grpc._server._send_initial_metadata (   state)
private

Definition at line 217 of file grpc/_server.py.

◆ _send_message()

def grpc._server._send_message (   state,
  token 
)
private

Definition at line 226 of file grpc/_server.py.

◆ _send_message_callback_to_blocking_iterator_adapter()

def grpc._server._send_message_callback_to_blocking_iterator_adapter (   rpc_event,
  state,
  send_response_callback,
  response_iterator 
)
private

Definition at line 610 of file grpc/_server.py.

◆ _send_response()

def grpc._server._send_response (   rpc_event,
  state,
  serialized_response 
)
private

Definition at line 500 of file grpc/_server.py.

◆ _send_status_from_server()

def grpc._server._send_status_from_server (   state,
  token 
)
private

Definition at line 125 of file grpc/_server.py.

◆ _serialize_response()

def grpc._server._serialize_response (   rpc_event,
  state,
  response,
  response_serializer 
)
private

Definition at line 477 of file grpc/_server.py.

◆ _serialized_request()

def grpc._server._serialized_request (   request_event)
private

Definition at line 55 of file grpc/_server.py.

◆ _serve()

def grpc._server._serve (   state)
private

Definition at line 876 of file grpc/_server.py.

◆ _start()

def grpc._server._start (   state)
private

Definition at line 925 of file grpc/_server.py.

◆ _status()

def grpc._server._status (   rpc_event,
  state,
  serialized_response 
)
private

Definition at line 529 of file grpc/_server.py.

◆ _stop()

def grpc._server._stop (   state,
  grace 
)
private

Definition at line 899 of file grpc/_server.py.

◆ _stop_serving()

def grpc._server._stop_serving (   state)
private

Definition at line 818 of file grpc/_server.py.

◆ _stream_response_in_pool()

def grpc._server._stream_response_in_pool (   rpc_event,
  state,
  behavior,
  argument_thunk,
  request_deserializer,
  response_serializer 
)
private

Definition at line 571 of file grpc/_server.py.

◆ _take_response_from_response_iterator()

def grpc._server._take_response_from_response_iterator (   rpc_event,
  state,
  response_iterator 
)
private

Definition at line 459 of file grpc/_server.py.

◆ _unary_request()

def grpc._server._unary_request (   rpc_event,
  state,
  request_deserializer 
)
private

Definition at line 396 of file grpc/_server.py.

◆ _unary_response_in_pool()

def grpc._server._unary_response_in_pool (   rpc_event,
  state,
  behavior,
  argument_thunk,
  request_deserializer,
  response_serializer 
)
private

Definition at line 554 of file grpc/_server.py.

◆ _validate_generic_rpc_handlers()

def grpc._server._validate_generic_rpc_handlers (   generic_rpc_handlers)
private

Definition at line 938 of file grpc/_server.py.

◆ create_server()

def grpc._server.create_server (   thread_pool,
  generic_rpc_handlers,
  interceptors,
  options,
  maximum_concurrent_rpcs,
  compression,
  xds 
)

Definition at line 999 of file grpc/_server.py.

Variable Documentation

◆ _CANCELLED

string grpc._server._CANCELLED = 'cancelled'
private

Definition at line 47 of file grpc/_server.py.

◆ _CLOSED

string grpc._server._CLOSED = 'closed'
private

Definition at line 46 of file grpc/_server.py.

◆ _DEALLOCATED_SERVER_CHECK_PERIOD_S

float grpc._server._DEALLOCATED_SERVER_CHECK_PERIOD_S = 1.0
private

Definition at line 51 of file grpc/_server.py.

◆ _EMPTY_FLAGS

int grpc._server._EMPTY_FLAGS = 0
private

Definition at line 49 of file grpc/_server.py.

◆ _INF_TIMEOUT

int grpc._server._INF_TIMEOUT = 1e9
private

Definition at line 52 of file grpc/_server.py.

◆ _LOGGER

grpc._server._LOGGER = logging.getLogger(__name__)
private

Definition at line 30 of file grpc/_server.py.

◆ _OPEN

string grpc._server._OPEN = 'open'
private

Definition at line 45 of file grpc/_server.py.

◆ _RECEIVE_CLOSE_ON_SERVER_TOKEN

string grpc._server._RECEIVE_CLOSE_ON_SERVER_TOKEN = 'receive_close_on_server'
private

Definition at line 35 of file grpc/_server.py.

◆ _RECEIVE_MESSAGE_TOKEN

string grpc._server._RECEIVE_MESSAGE_TOKEN = 'receive_message'
private

Definition at line 37 of file grpc/_server.py.

◆ _REQUEST_CALL_TAG

string grpc._server._REQUEST_CALL_TAG = 'request_call'
private

Definition at line 33 of file grpc/_server.py.

◆ _SEND_INITIAL_METADATA_AND_SEND_MESSAGE_TOKEN

tuple grpc._server._SEND_INITIAL_METADATA_AND_SEND_MESSAGE_TOKEN
private
Initial value:
1 = (
2  'send_initial_metadata * send_message')

Definition at line 39 of file grpc/_server.py.

◆ _SEND_INITIAL_METADATA_AND_SEND_STATUS_FROM_SERVER_TOKEN

tuple grpc._server._SEND_INITIAL_METADATA_AND_SEND_STATUS_FROM_SERVER_TOKEN
private
Initial value:
1 = (
2  'send_initial_metadata * send_status_from_server')

Definition at line 42 of file grpc/_server.py.

◆ _SEND_INITIAL_METADATA_TOKEN

string grpc._server._SEND_INITIAL_METADATA_TOKEN = 'send_initial_metadata'
private

Definition at line 36 of file grpc/_server.py.

◆ _SEND_MESSAGE_TOKEN

string grpc._server._SEND_MESSAGE_TOKEN = 'send_message'
private

Definition at line 38 of file grpc/_server.py.

◆ _SEND_STATUS_FROM_SERVER_TOKEN

string grpc._server._SEND_STATUS_FROM_SERVER_TOKEN = 'send_status_from_server'
private

Definition at line 41 of file grpc/_server.py.

◆ _SHUTDOWN_TAG

string grpc._server._SHUTDOWN_TAG = 'shutdown'
private

Definition at line 32 of file grpc/_server.py.



grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:32