Home  > 

Class session

A container of senders and receivers.

Related: Class session-options, Class connection, Class sender, Class receiver

Implementations: C, C++, Java, Python

AMQP: Conceptual overview, Begin performative, End performative

Basic properties and methods

Property	Summary	Type	Default value	Mutable	Nullable
container	The container holding this endpoint object	container	instance	☐	☐
connection	The containing connection	connection	instance	☐	☐
senders	The senders contained in this session	iterator of sender	instance	☐	☐
receivers	The receivers contained in this session	iterator of receiver	instance	☐	☐

Method	Summary	Inputs	Outputs
open	Open the session	[session-options]
close	Close the session	[error-condition]

Endpoint lifecycle

Property	Summary	Type	Default value	Mutable	Nullable
state	The remote endpoint state	endpoint-state	discovered	☐	☐
error	The remote endpoint error condition	error-condition	discovered	☐	☒

Event processing

Method	Summary	Inputs	Outputs
add-work	Register a function to be called	function

Extended attributes

Property	Summary	Type	Default value	Mutable	Nullable
properties	Application-defined properties	map of symbol ⇒ object	discovered	☐	☒
offered-capabilities	Extensions the endpoint supports	array of symbol	discovered	☐	☒
desired-capabilities	Extensions the endpoint can use	array of symbol	discovered	☐	☒

Message operations

Method	Summary	Inputs	Outputs
send proposed	Send a message on a link with the given address	message	tracker
send-request proposed	Send a request message	message	tracker
send-response proposed	Send a response message	response-message, request-message	tracker

Sender and receiver operations

Method	Summary	Inputs	Outputs
open-sender	Create and open a sending link	address, [sender-options]	sender
open-receiver	Create and open a receiving link	address, [receiver-options]	receiver

Flow control

Property	Summary	Type	Default value	Mutable	Nullable
incoming-bytes	The number of incoming bytes currently buffered	uint	discovered	☐	☐
outgoing-bytes	The number of outgoing bytes currently buffered	uint	discovered	☐	☐

Resource limits

Property	Summary	Type	Default value	Mutable	Nullable
incoming-window	The maximum incoming transfer frames	uint	discovered	☐	☐
outgoing-window	The maximum outgoing transfer frames	uint	discovered	☐	☐