Home  > 

Class connection

A channel for communication between two peers on a network.

In current implementations, a connection corresponds to a TCP connection, represented by a transport.

A connection object contains zero or more session objects, which in turn contain zero or more senders and zero or more receivers.

Related: Class connection-options, Class transport, Class session

Implementations: C, C++, Java, Python

AMQP: Conceptual overview, Open performative, Close performative

Basic properties and methods

Property	Summary	Type	Default value	Mutable	Nullable
container	The container holding this endpoint object	container	instance	☐	☐
transport	The associated network transport	transport	instance	☐	☐
sessions	The sessions contained in this connection	iterator of session	instance	☐	☐
default-session	The session used by open-sender and open-receiver	session	instance	☐	☐

Method	Summary	Inputs	Outputs
open	Open the connection	[connection-options]
close	Close the connection	[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	Send a message on the default session using an anonymous sender	message	tracker

Sender and receiver operations

Method	Summary	Inputs	Outputs
open-sender	Create and open a sender using the default session	address, [sender-options]	sender
open-receiver	Create and open a receiver using the default session	address, [receiver-options]	receiver

Session operations

Method	Summary	Inputs	Outputs
open-session	Create and open a session	[session-options]	session

Identity

Property	Summary	Type	Default value	Mutable	Nullable
container-id	The unique identity of the container	string	discovered	☐	☐
virtual-host	The virtual host name	string	discovered	☐	☐
user	The identity of the user associated with the connection	string	discovered	☐	☐

Resource limits

Property	Summary	Type	Default value	Mutable	Nullable
idle-timeout	The time after which an idle connection expires	duration	discovered	☐	☐
max-sessions	The maximum active sessions allowed	ushort	discovered	☐	☐
max-frame-size	The maximum frame size allowed	uint	discovered	☐	☐