grpc.framework.interfaces.links package¶

Submodules¶

grpc.framework.interfaces.links.links module¶

The low-level ticket-exchanging-links interface of RPC Framework.

class grpc.framework.interfaces.links.links.Link[source]¶

Bases: object

Accepts and emits tickets.

accept_ticket(ticket)[source]¶

Accept a Ticket.

Parameters:	ticket – Any Ticket.

join_link(link)[source]¶

Mates this object with a peer with which it will exchange tickets.

class grpc.framework.interfaces.links.links.Protocol[source]¶

Bases: grpc.framework.interfaces.links.links.Protocol

A sum type for handles to a system that transmits tickets.

kind¶

A Kind value identifying the kind of value being passed.

value¶

The value being passed between the high-level application and the system affording ticket transport.

class Kind[source]¶

Bases: enum.Enum

CALL_OPTION = <Kind.CALL_OPTION: 'call option'>¶

INVOCATION_CONTEXT = <Kind.INVOCATION_CONTEXT: 'invocation context'>¶

SERVICER_CONTEXT = <Kind.SERVICER_CONTEXT: 'servicer context'>¶

class grpc.framework.interfaces.links.links.Ticket[source]¶

Bases: grpc.framework.interfaces.links.links.Ticket

A sum type for all values sent from a front to a back.

operation_id¶

A unique-with-respect-to-equality hashable object identifying a particular operation.

sequence_number¶

A zero-indexed integer sequence number identifying the ticket’s place in the stream of tickets sent in one direction for the particular operation.

group¶

The group to which the method of the operation belongs. Must be present in the first ticket from invocation side to service side. Ignored for all other tickets exchanged during the operation.

method¶

The name of an operation. Must be present in the first ticket from invocation side to service side. Ignored for all other tickets exchanged during the operation.

subscription¶

A Subscription value describing the interest one side has in receiving information from the other side. Must be present in the first ticket from either side. Ignored for all other tickets exchanged during the operation.

timeout¶

A nonzero length of time (measured from the beginning of the operation) to allow for the entire operation. Must be present in the first ticket from invocation side to service side. Optional for all other tickets exchanged during the operation. Receipt of a value from the other side of the operation indicates the value in use by that side. Setting a value on a later ticket allows either side to request time extensions (or even time reductions!) on in-progress operations.

allowance¶

A positive integer granting permission for a number of payloads to be transmitted to the communicating side of the operation, or None if no additional allowance is being granted with this ticket.

initial_metadata¶

An optional metadata value communicated from one side to the other at the beginning of the operation. May be non-None in at most one ticket from each side. Any non-None value must appear no later than the first payload value.

payload¶

A customer payload object. May be None.

terminal_metadata¶

A metadata value comminicated from one side to the other at the end of the operation. May be non-None in the same ticket as the code and message, but must be None for all earlier tickets.

code¶

A value communicated at operation completion. May be None.

message¶

A value communicated at operation completion. May be None.

termination¶

A Termination value describing the end of the operation, or None if the operation has not yet terminated. If set, no further tickets may be sent in the same direction.

protocol¶

A Protocol value or None, with further semantics being a matter between high-level application and underlying ticket transport.

class Subscription[source]¶

Bases: enum.Enum

Identifies the level of subscription of a side of an operation.

FULL = <Subscription.FULL: 'full'>¶

NONE = <Subscription.NONE: 'none'>¶

TERMINATION = <Subscription.TERMINATION: 'termination'>¶

class Ticket.Termination[source]¶

Bases: enum.Enum

Identifies the termination of an operation.

CANCELLATION = <Termination.CANCELLATION: 'cancellation'>¶

COMPLETION = <Termination.COMPLETION: 'completion'>¶

EXPIRATION = <Termination.EXPIRATION: 'expiration'>¶

LOCAL_FAILURE = <Termination.LOCAL_FAILURE: 'local failure'>¶

RECEPTION_FAILURE = <Termination.RECEPTION_FAILURE: 'reception failure'>¶

REMOTE_FAILURE = <Termination.REMOTE_FAILURE: 'remote failure'>¶

SHUTDOWN = <Termination.SHUTDOWN: 'shutdown'>¶

TRANSMISSION_FAILURE = <Termination.TRANSMISSION_FAILURE: 'transmission failure'>¶

grpc.framework.interfaces.links.utilities module¶

Utilities provided as part of the links interface.

Module contents¶