AMQP Component

Properties   Methods   Events   Configuration Settings   Errors  

An easy-to-use AMQP 1.0 client implementation.

Syntax

TiotAMQP

Remarks

The AMQP component provides an easy-to-use AMQP 1.0 client implementation. The component supports both plaintext and TLS-enabled connections over TCP.

Connecting

AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions.

The component implements all three layers of the AMQP 1.0 transport protocol, so the first step is to initiate the overall connection. Set the ContainerId property and call the Connect method, passing it the server's hostname and port number.

Once connected, the next step is to create at least one session, which can be accomplished by using the CreateSession method. The component allows creating any number of sessions, up to the limit specified by the MaxSessionCount configuration setting.

Connecting and Creating a Session

After creating a session, the next step is to create one or more links (which are created in the context of a session) so that messages can be sent and/or received. Links are unidirectional, so each one has a sender on one end and a receiver on the other.

The component can function both as a sender node (by opening sender links) and as a receiver node (by opening receiver links). But keep in mind that, since the component is implemented as an AMQP 1.0 client, it must be the one to open links (said another way, the component cannot accept any link requests made by other peers).

As with sessions, the component allows creating any number of links for each session, up to the limit specified by the MaxLinkCountPerSession configuration setting.

Creating Sender Links

To create a sender link, call the CreateSenderLink method, passing it the name of an existing session, a unique name for the link, and (if necessary in your environment) the name of a target for the receiver to use to ensure messages are routed correctly.

The LinkReadyToSend event will fire when the newly created sender link is ready to send messages.

Creating a Sender Link

Sending Messages

To send a message, the first step is to set the Message* properties to the desired values.

At minimum, the Value and ValueType properties must be set. All other properties are optional, though specifying a unique value for MessageId is recommended. (If the GenerateMessageId configuration setting is enabled, the component will generate one automatically when the message is sent.)

Once the Message* properties have be assigned as desired, call the SendMessage method, passing it the name of an existing sender link on which the message should be sent.

The MessageOut event will be fired when the message has been sent (and acknowledged, if Settled was set to false). The MessageOutcome event may also fire, if necessary, once the receiver reports the outcome of the message.

Refer to SendMessage, MessageOut, and MessageOutcome for more information.

Sending a Message

The ResetMessage method can be used to reset the Message* properties to their default values.

Sending Composite AMQP Data

The AMQP 1.0 protocol's data model includes the concept of "composite data". Composite data is comprised of one or more type-value pairs (including data structure types), plus a descriptor that describes what the overall data represents.

The component supports sending composite AMQP data in a message through the use of JSON with a well-defined schema. Refer to the SendMessage method's documentation for more information and examples.

Creating Receiver Links

Receiver links can operate in one of two receive modes: automatic, where the component will work to ensure that messages are received as soon as they are available; and fetch-based, where the component will only "fetch" a new message when explicitly instructed to.

The ReceiveMode property controls which receive mode newly-created receiver links will use; refer to its documentation for more information.

After ensuring that ReceiveMode is set as desired, call CreateReceiverLink, passing it the name of an existing session, a unique name for the link, and (if necessary in your environment) the name of a source for the sender to route the link creation request to.

Creating a Receiver Link

Receiving Messages

For receiver links created in automatic receive mode (the default), messages are received automatically.

For receiver links created in fetch-based mode, the component will attempt to "fetch" a message each time the FetchMessage method is called (optionally timing out after a time, if FetchTimeout is non-zero). When calling FetchMessage, pass it the name of a fetch-based receiver link.

Regardless of whether a messages is received automatically or fetched, any incoming message will cause the component to fire the MessageIn event and update the ReceivedMessage* properties.

When the MessageIn event fires, its State event parameter can be used to specify the outcome of the message, which the component will then transmit back to the sender (as well as self-report by firing the MessageOutcome event). Refer to MessageIn for more information.

Receiving a Message

Property List

---

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AuthScheme	The authentication scheme to use when connecting.
Connected	Triggers a connection or disconnection.
ContainerId	The container Id the component should advertise when connecting.
FetchTimeout	How long the component should wait for a message to be received after FetchMessage is called.
Firewall	A set of properties related to firewall access.
IdleTimeout	The maximum period of inactivity the component will allow before disconnecting.
IncomingMessages	Collection of incoming messages which have not been fully settled.
Links	Collection of active links.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
Message	The message to send.
OutgoingMessages	Collection of outgoing messages which have not been fully settled.
Password	A password to use for SASL authentication.
ReadyToSend	Indicates whether the component is ready to send data.
ReceivedMessage	The last message received.
ReceiveMode	Controls what mode new receiver links are created with.
RemoteHost	The address of the remote host. Domain names are resolved to IP addresses.
RemotePort	The port of the AQMP server (default is 5672). The default port for SSL is 5671.
Sessions	Collection of active sessions.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLEnabled	Whether TLS/SSL is enabled.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
Timeout	A timeout for the component.
User	A username to use for SASL authentication.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

CloseLink	Closes a link.
CloseSession	Closes a session.
Config	Sets or retrieves a configuration setting.
Connect	Connects to a remote host.
CreateReceiverLink	Creates a new receiver link with the given name on the specified session.
CreateSenderLink	Creates a new sender link with the given name on the specified session.
CreateSession	Creates a new session with the given name.
Disconnect	Disconnects from the remote host.
DoEvents	Processes events from the internal message queue.
FetchMessage	Fetches a single message over the specified receiver link.
Interrupt	Interrupts the current action.
Reset	Reset the component.
ResetMessage	Resets the Message properties.
SendMessage	Sends a message on the specified link.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
Disconnected	Fired when a connection is closed.
Error	Information about errors during data delivery.
LinkReadyToSend	Fires when a sender link is ready to send messages.
Log	Fires once for each log message.
MessageIn	Fires when the component receives a message.
MessageOut	Fires when the component sends a message.
MessageOutcome	Fires when a message's outcome is available.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.

Configuration Settings

---

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

AuthorizationIdentity	The value to use as the authorization identity when SASL authentication is used.
DefaultCredit	The amount of credit to create new receiver links with.
DefaultCreditThreshold	The credit threshold to create new receiver links with.
DefaultIncomingWindow	The incoming window size to create new sessions with.
DefaultOutgoingWindow	The outgoing window size to create new sessions with.
DefaultSenderSettleMode	The sender settle mode to create new links with.
GenerateMessageId	Whether a unique message Id should be automatically generated when sending a message.
LogLevel	The level of detail that is logged.
MaxFrameSize	The maximum frame size.
MaxLinkCountPerSession	The maximum number of links to restrict new sessions to.
MaxMessageSize	The maximum message size to restrict new links to.
MaxSessionCount	The maximum number of sessions.
ModifiedDeliveryFailed	Whether the sender should treat this transfer as an unsuccessful delivery attempt.
ModifiedMessageAnnotations	The message annotations that the sender should merge into those already on the message.
ModifiedUndeliverableHere	Whether the receiver has indicated that the sender should not attempt to redeliver the message.
ProtocolVersion	The AMQP protocol version to conform to.
RejectErrorCondition	The error condition included with a 'Rejected' delivery outcome.
RejectErrorDescription	The error description included with a 'Rejected' delivery outcome.
SenderSettleMode[LinkName]	Retrieves the negotiated sender settle mode for the specified link.
SimplifiedJSONFormat	Whether to output simplified JSON where possible.
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.