TsgcWSPClient_AMQP1 › Methods

TsgcWSPClient_AMQP1 Methods

Public methods grouped by purpose, followed by the full alphabetical list.

Connection

NameDescription
CloseSends the AMQP 1.0 Close frame to the peer, ending the connection at the container level.
PingSends an empty AMQP 1.0 frame as a keep-alive so the peer does not trip its idle-timeout.

Sessions

NameDescription
CreateSessionBegins an AMQP 1.0 session on the container by sending a Begin frame and returns the resulting session object.
CloseSessionEnds an AMQP 1.0 session by sending the End frame on its channel and releasing all links attached to it.

Links

NameDescription
CreateSenderLinkAttaches an AMQP 1.0 sender link to an existing session and returns it, ready to publish messages to the supplied target address.
CreateReceiverLinkAttaches an AMQP 1.0 receiver link to an existing session and returns it, ready to consume messages from the supplied source address.
CloseLinkDetaches an AMQP 1.0 link (sender or receiver) from its session by sending the Detach frame.

CBS tokens

NameDescription
PutCBSTokenSends a Claims-Based Security (CBS) put-token request to the $cbs management link, authorising the given audience with the supplied token.
CreateCBSLinkAttaches the pair of links to the reserved $cbs management node used by Azure Service Bus / Event Hubs for Claims-Based Security.
CreateAzureCbsSasTokenBuilds an Azure Service Bus SAS token from the given SAS key and pushes it via CBS to authorise the specified entity.
CreateAzureCbsJWTPerforms an Azure Active Directory OAuth 2.0 authorisation-code flow and pushes the resulting JWT bearer token to $cbs.

Advanced

NameDescription
WriteDataLow-level method that writes raw bytes straight onto the underlying WebSocket / broker transport, bypassing the AMQP 1.0 codec. Overloaded for string or stream input.

All Methods (alphabetical)

NameDescription
CloseSends the AMQP 1.0 Close frame to the peer, ending the connection at the container level.
CloseLinkDetaches an AMQP 1.0 link (sender or receiver) from its session by sending the Detach frame.
CloseSessionEnds an AMQP 1.0 session by sending the End frame on its channel and releasing all links attached to it.
CreateAzureCbsJWTPerforms an Azure Active Directory OAuth 2.0 authorisation-code flow and pushes the resulting JWT bearer token to $cbs.
CreateAzureCbsSasTokenBuilds an Azure Service Bus SAS token from the given SAS key and pushes it via CBS to authorise the specified entity.
CreateCBSLinkAttaches the pair of links to the reserved $cbs management node used by Azure Service Bus / Event Hubs for Claims-Based Security.
CreateReceiverLinkAttaches an AMQP 1.0 receiver link to an existing session and returns it, ready to consume messages from the supplied source address.
CreateSenderLinkAttaches an AMQP 1.0 sender link to an existing session and returns it, ready to publish messages to the supplied target address.
CreateSessionBegins an AMQP 1.0 session on the container by sending a Begin frame and returns the resulting session object.
PingSends an empty AMQP 1.0 frame as a keep-alive so the peer does not trip its idle-timeout.
PutCBSTokenSends a Claims-Based Security (CBS) put-token request to the $cbs management link, authorising the given audience with the supplied token.
WriteDataLow-level method that writes raw bytes straight onto the underlying WebSocket / broker transport, bypassing the AMQP 1.0 codec. Overloaded for string or stream input.