Home  > 

Class session

A container of senders and receivers.

Basic properties and methods

PropertySummaryTypeDefault valueMutableNullable
client The client holding this endpoint objectclientinstance☐☐
connection The containing connectionconnectioninstance☐☐
MethodSummaryInputsOutputs
wait Block until the remote peer confirms the open operation[timeout]endpoint
(async) wait Wait until the remote peer confirms the open operationtask of endpoint

Endpoint lifecycle

PropertySummaryTypeDefault valueMutableNullable
state The remote endpoint stateendpoint-statediscovered☐☐
error The remote endpoint error conditionerror-conditiondiscovered☐☒
MethodSummaryInputsOutputs
close Start closing the endpoint[error-condition]future of endpoint
(async) close Start closing the endpoint[error-condition]task of endpoint

Extended attributes

PropertySummaryTypeDefault valueMutableNullable
properties Application-defined propertiesmap of symbol ⇒ objectdiscovered☐☒
offered-capabilities Extensions the endpoint supportsarray of symboldiscovered☐☒
desired-capabilities Extensions the endpoint can usearray of symboldiscovered☐☒

Sender and receiver operations

MethodSummaryInputsOutputs
open-sender Create and open a sending linkaddress, [sender-options]sender
open-anonymous-sender Create and open a sender with no target address[sender-options]sender
open-receiver Create and open a receiving linkaddress, [receiver-options]receiver
open-dynamic-receiver Create and open a dynamic receiver[receiver-options], [timeout]receiver
(async) open-dynamic-receiver Create and open a dynamic receiver[receiver-options]task of receiver