AMQP Component

Properties   Methods   Events   Config Settings   Errors  

An easy-to-use AMQP 1.0 client implementation.

Syntax

nsoftware.IPWorksMQ.Amqp

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

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 ConnectTo 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 amqp1.ContainerId = "testClient"; amqp1.ConnectTo("amqp.test-server.com", 5672); amqp1.CreateSession("TestSession");

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

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

Creating a Sender Link amqp1.OnLinkReadyToSend += (s, e) => { Console.WriteLine("Link '" + e.LinkName + "' is ready to send messages!"); }; amqp1.CreateSenderLink("TestSession", "TestSenderLink", "TestTarget");

Sending Messages

At minimum, the Value and ValueType fields must be set. All other fields 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 property's fields 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 amqp1.OnMessageOut += (s, e) => { Console.WriteLine("Message with Id '" + e.MessageId + "' has been sent on link '" + e.LinkName + "'."); }; amqp1.Message.MessageId = "TestMessageId"; amqp1.Message.Value = "Hello, world!"; amqp1.Message.ValueType = AMQPValueTypes.mvtString; amqp1.SendMessage("TestSenderLink");

The ResetMessage method can be used to reset the Message property's fields to their default values.

Sending Composite AMQP Data

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

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 // Creating an automatic receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmAutomatic; amqp1.CreateReceiverLink("TestSession", "TestAutoReceiverLink", "TestSource1"); // Creating a fetch-based receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmFetch; amqp1.CreateReceiverLink("TestSession", "TestFetchReceiverLink", "TestSource2");

Receiving Messages

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 property's fields.

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 // For automatic receiver links, only the event handler is necessary. amqp1.OnMessageIn += (s, e) => { Console.WriteLine("Message with Id '" + e.MessageId + "' has been received on link '" + e.LinkName + "'. Value:"); Console.WriteLine(amqp1.ReceivedMessage.Value); // The message state is already set to the "Accepted" outcome by default, but we'll set it again // for the purpose of this example. e.State = 0; // 0 = Accepted. }; // For fetch-based links, it's also necessary to call FetchMessage(). It is recommended that the // FetchTimeout property be set to a non-zero value (60 seconds is the default) so that the fetch // request will eventually time out if the sender doesn't have any messages available to deliver. amqp1.FetchTimeout = 60; amqp1.FetchMessage("TestFetchReceiverLink");

Property List

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

Method List

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

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.

Config Settings

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

AuthScheme Property (AMQP Component)

The authentication scheme to use when connecting.

Syntax

• C#
• VB.NET

public AmqpAuthSchemes AuthScheme { get; set; }

enum AmqpAuthSchemes {
  smNone,
  smSASLAnonymous,
  smSASLPlain,
  smSASLExternal
}

Public Property AuthScheme As AmqpAuthSchemes

Enum AmqpAuthSchemes
  smNone
  smSASLAnonymous
  smSASLPlain
  smSASLExternal
End Enum

Default Value

2

Remarks

This property controls what authentication scheme the component should use when connecting to the remote host.

Valid values are:

• smNone (0)
• smSASLAnonymous (1)
• smSASLPlain (2) - Default
• smSASLExternal (3)

This property is not available at design time.

Connected Property (AMQP Component)

This property triggers a connection or disconnection.

Syntax

• C#
• VB.NET

public bool Connected { get; set; }

Public Property Connected As Boolean

Default Value

False

Remarks

This property triggers a connection or disconnection. Setting this property to True makes the component attempt to connect to the host identified by the RemoteHost property. If successful, after the connection is achieved, the value of the property changes to True and the Connected event is fired.

Setting this property to False closes the connection. How and when the connection is closed is controlled by the Linger property.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

ContainerId Property (AMQP Component)

The container Id the component should advertise when connecting.

Syntax

• C#
• VB.NET

public string ContainerId { get; set; }

Public Property ContainerId As String

Default Value

""

Remarks

This property specifies the container Id that the component should advertise when it's connecting to the remote host.

In AMQP, the top-level organizational grouping is called a "container", and each container can contain zero or more "nodes", which are the actual entities which send and receive messages over links.

Since this component handles multiple layers of the AMQP transport protocol (the overall connection, the sessions in that connection, and the links attached to those sessions), it must be given a unique container Id.

Note: The container Id cannot be changed while connected.

This property is not available at design time.

FetchTimeout Property (AMQP Component)

How long the component should wait for a message to be received after FetchMessage is called.

Syntax

• C#
• VB.NET

public int FetchTimeout { get; set; }

Public Property FetchTimeout As Integer

Default Value

60

Remarks

This property controls how long, in seconds, the component will wait for a message to be received after FetchMessage is called before timing out the request. If set to zero, the component will wait indefinitely.

Refer to FetchMessage for more information.

This property is not available at design time.

Firewall Property (AMQP Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

IdleTimeout Property (AMQP Component)

The maximum period of inactivity the component will allow before disconnecting.

Syntax

• C#
• VB.NET

public int IdleTimeout { get; set; }

Public Property IdleTimeout As Integer

Default Value

0

Remarks

This property controls how long, in seconds, the component will allow the connection to sit idle before it disconnects from the remote host.

This property may be set to 0 to prevent the component from ever closing the connection due to inactivity.

Note: The idle timeout cannot be changed while connected.

This property is not available at design time.

IncomingMessages Property (AMQP Component)

Collection of incoming messages which have not been fully settled.

Syntax

• C#
• VB.NET

public AMQPMessageList IncomingMessages { get; }

Public ReadOnly Property IncomingMessages As AMQPMessageList

Remarks

This collection property holds a list of AMQPMessage items, one for each incoming message that has not been fully settled by the component (and, potentially, the remote host).

Refer to ReceiveMode for more information.

This property is read-only and not available at design time.

Links Property (AMQP Component)

Collection of active links.

Syntax

• C#
• VB.NET

public AMQPLinkList Links { get; }

Public ReadOnly Property Links As AMQPLinkList

Remarks

This collection property holds a list of AMQPLink items, one for each currently active link.

Refer to CreateReceiverLink, CreateSenderLink, and CloseLink for more information.

This property is read-only and not available at design time.

LocalHost Property (AMQP Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

LocalPort Property (AMQP Component)

The TCP port in the local host where the component binds.

Syntax

• C#
• VB.NET

public int LocalPort { get; set; }

Public Property LocalPort As Integer

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side.

Message Property (AMQP Component)

The message to send.

Syntax

• C#
• VB.NET

public AMQPMessage Message { get; set; }

Public Property Message As AMQPMessage

Remarks

This property holds an AMQPMessage object whose fields are used to construct a message to send when SendMessage is called.

Refer to SendMessage for more information. amqp.Message.ValueType = AMQPValueTypes.mvtString; amqp.Message.Value = "Hello World!"; amqp.SendMessage("SenderLinkName");

This property is not available at design time.

OutgoingMessages Property (AMQP Component)

Collection of outgoing messages which have not been fully settled.

Syntax

• C#
• VB.NET

public AMQPMessageList OutgoingMessages { get; }

Public ReadOnly Property OutgoingMessages As AMQPMessageList

Remarks

This collection property holds a list of AMQPMessage items, one for each outgoing message that has not been fully settled by the component (and, potentially, the remote host).

Refer to SendMessage for more information.

This property is read-only and not available at design time.

Password Property (AMQP Component)

A password to use for SASL authentication.

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

This property contains a password to use for SASL authentication.

This property is not available at design time.

ReadyToSend Property (AMQP Component)

Indicates whether the component is ready to send data.

Syntax

• C#
• VB.NET

public bool ReadyToSend { get; }

Public ReadOnly Property ReadyToSend As Boolean

Default Value

False

Remarks

This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is True after connecting to the remote host, and will become False if a call to SendMessage fails due to a WOULDBLOCK condition.

Once data can be sent again, the ReadyToSend event will fire and this property will be True.

If a WOULDBLOCK error occurs while sending a message the component will automatically complete the transmission when sending is possible. No action needs to be taken to re-send the message. ReadyToSend will fire after the component completes any partially sent messages.

This property is read-only and not available at design time.

ReceivedMessage Property (AMQP Component)

The last message received.

Syntax

• C#
• VB.NET

public AMQPMessage ReceivedMessage { get; }

Public ReadOnly Property ReceivedMessage As AMQPMessage

Remarks

This property is an AMQPMessage object which represents the last message received by the component. It is set by the component automatically each time the MessageIn event fires.

Refer to MessageIn for more information.

This property is read-only and not available at design time.

ReceiveMode Property (AMQP Component)

Controls what mode new receiver links are created with.

Syntax

• C#
• VB.NET

public AmqpReceiveModes ReceiveMode { get; set; }

enum AmqpReceiveModes {
  rmAutomatic,
  rmFetch
}

Public Property ReceiveMode As AmqpReceiveModes

Enum AmqpReceiveModes
  rmAutomatic
  rmFetch
End Enum

Default Value

0

Remarks

This property controls which receive mode newly created receiver links should use to receive messages from the sender. Valid values are:

• rmAutomatic (0 - default)
• rmFetch (1)

Receiving Messages Automatically

In this mode, receiver links will be created with the amount of credit, and the credit threshold, specified by the DefaultCredit and DefaultCreditThreshold configuration settings. Anytime the link's credit reaches the credit threshold, the component will automatically set it back to its initial value.

Fetching Messages On-Demand

In this mode, receiver links will be created with no credit (regardless of what DefaultCredit is set to). When FetchMessage is called, the component will supply the sender with a single credit and then block until a message is received (if the FetchTimeout property is set to zero).

If FetchTimeout is non-zero, the component will only block for the specified number of seconds; once that time expires, it will instruct the sender to consume the credit. If the sender chooses to consume the credit by incrementing the value of the AMQPLink.DeliveryCount field rather than by sending a message, then the component will throw an error indicating a timeout.

Refer to FetchMessage and FetchTimeout for more information. amqp.ReceiveMode = AmqpReceiveModes.rmFetch; amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");

This property is not available at design time.

RemoteHost Property (AMQP Component)

This property includes the address of the remote host. Domain names are resolved to IP addresses.

Syntax

• C#
• VB.NET

public string RemoteHost { get; set; }

Public Property RemoteHost As String

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the component is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Example. Connecting:

TCPClientControl.RemoteHost = "MyHostNameOrIP" TCPClientControl.RemotePort = 777 TCPClientControl.Connected = true

RemotePort Property (AMQP Component)

The port of the AQMP server (default is 5672). The default port for SSL is 5671.

Syntax

• C#
• VB.NET

public int RemotePort { get; set; }

Public Property RemotePort As Integer

Default Value

5672

Remarks

This property specifies a service port on the remote host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

This property is not available at design time.

Sessions Property (AMQP Component)

Collection of active sessions.

Syntax

• C#
• VB.NET

public AMQPSessionList Sessions { get; }

Public ReadOnly Property Sessions As AMQPSessionList

Remarks

This collection property holds a list of AMQPSession items, one for each currently active session.

Refer to CreateSession and CloseSession for more information.

This property is read-only and not available at design time.

SSLAcceptServerCert Property (AMQP Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (AMQP Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

The digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLEnabled Property (AMQP Component)

Whether TLS/SSL is enabled.

Syntax

• C#
• VB.NET

public bool SSLEnabled { get; set; }

Public Property SSLEnabled As Boolean

Default Value

False

Remarks

This setting specifies whether TLS/SSL is enabled in the component. When False (default) the component operates in plaintext mode. When True TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

If the default port (5672) is selected when SSLEnabled is set to true, the port will automatically be changed to the default port for AMQP with SSL (5671). Likewise, if port 5671 is selected when SSLEnabled is set to false, the port will automatically be changed to the default port. If the port has been set to any value other than the default values, it will remain the same when the value of SSLEnabled changes.

This property is not available at design time.

SSLProvider Property (AMQP Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public AmqpSSLProviders SSLProvider { get; set; }

enum AmqpSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As AmqpSSLProviders

Enum AmqpSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (AMQP Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Timeout Property (AMQP Component)

A timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

Remarks

This property defines the timeout when sending data. When SSLEnabled is False a value of 0 means data will be sent asynchronously and a positive value means data is sent synchronously. When SSLEnabled is True all data is sent synchronously regardless of the Timeout value. Please see the notes below for details.

Plaintext

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the component will wait for the operation to complete before returning control. The component will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

SSL

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

Additional Notes

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

User Property (AMQP Component)

A username to use for SASL authentication.

Syntax

• C#
• VB.NET

public string User { get; set; }

Public Property User As String

Default Value

""

Remarks

This property contains a username to use for SASL authentication.

This property is not available at design time.

CloseLink Method (AMQP Component)

Closes a link.

Syntax

• C#
• VB.NET

public void CloseLink(string name);

Async Version
public async Task CloseLink(string name);
public async Task CloseLink(string name, CancellationToken cancellationToken);

Public Sub CloseLink(ByVal Name As String)

Async Version
Public Sub CloseLink(ByVal Name As String) As Task
Public Sub CloseLink(ByVal Name As String, cancellationToken As CancellationToken) As Task

Remarks

This method closes the link named Name and removes it from the Links collection. If no link with the given Name exists, an error will be thrown.

CloseSession Method (AMQP Component)

Closes a session.

Syntax

• C#
• VB.NET

public void CloseSession(string name);

Async Version
public async Task CloseSession(string name);
public async Task CloseSession(string name, CancellationToken cancellationToken);

Public Sub CloseSession(ByVal Name As String)

Async Version
Public Sub CloseSession(ByVal Name As String) As Task
Public Sub CloseSession(ByVal Name As String, cancellationToken As CancellationToken) As Task

Remarks

This method closes the session named Name and removes it from the Sessions collection. If no session with the given Name exists, an error will be thrown.

Any links open on the specified session when this method is called will be automatically closed and removed from the Links collection.

Config Method (AMQP Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (AMQP Component)

This method connects to a remote host.

Syntax

• C#
• VB.NET

public void Connect();

Async Version
public async Task Connect();
public async Task Connect(CancellationToken cancellationToken);

Public Sub Connect()

Async Version
Public Sub Connect() As Task
Public Sub Connect(cancellationToken As CancellationToken) As Task

Remarks

This method connects to the remote host specified by RemoteHost and RemotePort. For instance: component.RemoteHost = "MyHostNameOrIP"; component.RemotePort = 7777; component.Connect();

ConnectTo Method (AMQP Component)

This method connects to a remote host.

Syntax

• C#
• VB.NET

public void ConnectTo(string host, int port);

Async Version
public async Task ConnectTo(string host, int port);
public async Task ConnectTo(string host, int port, CancellationToken cancellationToken);

Public Sub ConnectTo(ByVal Host As String, ByVal Port As Integer)

Async Version
Public Sub ConnectTo(ByVal Host As String, ByVal Port As Integer) As Task
Public Sub ConnectTo(ByVal Host As String, ByVal Port As Integer, cancellationToken As CancellationToken) As Task

Remarks

This method connects to the remote host specified by the Host and Port parameters. For instance: component.ConnectTo("MyHostNameOrIP", 777)

CreateReceiverLink Method (AMQP Component)

Creates a new receiver link with the given name on the specified session.

Syntax

• C#
• VB.NET

public void CreateReceiverLink(string sessionName, string name, string source);

Async Version
public async Task CreateReceiverLink(string sessionName, string name, string source);
public async Task CreateReceiverLink(string sessionName, string name, string source, CancellationToken cancellationToken);

Public Sub CreateReceiverLink(ByVal SessionName As String, ByVal Name As String, ByVal Source As String)

Async Version
Public Sub CreateReceiverLink(ByVal SessionName As String, ByVal Name As String, ByVal Source As String) As Task
Public Sub CreateReceiverLink(ByVal SessionName As String, ByVal Name As String, ByVal Source As String, cancellationToken As CancellationToken) As Task

Remarks

This method creates a new receiver link with the given Name on the session specified by SessionName and adds it to the Links collection. If a link (sender or receiver) with the given Name already exists, or if no session with the given SessionName exists, an error will be thrown.

Source may be set to specify the address of the node at the remote host which should act as the sender. This may not be necessary in all environments, in which case an empty string will suffice.

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.

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. amqp.ReceiveMode = AmqpReceiveModes.rmFetch; amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");

CreateSenderLink Method (AMQP Component)

Creates a new sender link with the given name on the specified session.

Syntax

• C#
• VB.NET

public void CreateSenderLink(string sessionName, string name, string target);

Async Version
public async Task CreateSenderLink(string sessionName, string name, string target);
public async Task CreateSenderLink(string sessionName, string name, string target, CancellationToken cancellationToken);

Public Sub CreateSenderLink(ByVal SessionName As String, ByVal Name As String, ByVal Target As String)

Async Version
Public Sub CreateSenderLink(ByVal SessionName As String, ByVal Name As String, ByVal Target As String) As Task
Public Sub CreateSenderLink(ByVal SessionName As String, ByVal Name As String, ByVal Target As String, cancellationToken As CancellationToken) As Task

Remarks

This method creates a new sender link with the given Name on the session specified by SessionName and adds it to the Links collection. If a link (sender or receiver) with the given Name already exists, or if no session with the given SessionName exists, an error will be thrown.

Target may be set to specify the address of the node at the remote host which should act as the receiver. This may not be necessary in all environments, in which case an empty string will suffice.

The LinkReadyToSend event will fire when a newly-created sender link is ready to send.

Sender links are created using the Mixed settle mode by default, letting the value of the Message.Settled field control whether each message is settled (the default) or unsettled when it is sent. The DefaultSenderSettleMode configuration setting can be used to control the settle mode that new sender links are created with. Refer to SendMessage for more information on message settlement in general.

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.

CreateSession Method (AMQP Component)

Creates a new session with the given name.

Syntax

• C#
• VB.NET

public void CreateSession(string name);

Async Version
public async Task CreateSession(string name);
public async Task CreateSession(string name, CancellationToken cancellationToken);

Public Sub CreateSession(ByVal Name As String)

Async Version
Public Sub CreateSession(ByVal Name As String) As Task
Public Sub CreateSession(ByVal Name As String, cancellationToken As CancellationToken) As Task

Remarks

This method creates a new session with the given Name and adds it to the Sessions collection. If a session with the given Name already exists, an error will be thrown.

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.

Disconnect Method (AMQP Component)

This method disconnects from the remote host.

Syntax

• C#
• VB.NET

public void Disconnect();

Async Version
public async Task Disconnect();
public async Task Disconnect(CancellationToken cancellationToken);

Public Sub Disconnect()

Async Version
Public Sub Disconnect() As Task
Public Sub Disconnect(cancellationToken As CancellationToken) As Task

Remarks

This method disconnects from the remote host. Calling this method is equivalent to setting the Connected property to False.

DoEvents Method (AMQP Component)

Processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

FetchMessage Method (AMQP Component)

Fetches a single message over the specified receiver link.

Syntax

• C#
• VB.NET

public void FetchMessage(string linkName);

Async Version
public async Task FetchMessage(string linkName);
public async Task FetchMessage(string linkName, CancellationToken cancellationToken);

Public Sub FetchMessage(ByVal LinkName As String)

Async Version
Public Sub FetchMessage(ByVal LinkName As String) As Task
Public Sub FetchMessage(ByVal LinkName As String, cancellationToken As CancellationToken) As Task

Remarks

When FetchMessage is called, the component will supply the sender with a single credit and then block until a message is received (if the FetchTimeout property is set to zero).

If FetchTimeout is non-zero, the component will only block for the specified number of seconds; once that time expires, it will instruct the sender to consume the credit. If the sender chooses to consume the credit by incrementing the value of the AMQPLink.DeliveryCount field rather than by sending a message, then the component will throw an error indicating a timeout.

LinkName specifies the receiver link which should fetch a message; if there is no such link, if the specified link is not a receiver link, or if the specified receiver link is not operating in rmSyncGet (1) mode, an error is thrown.

Refer to ReceiveMode and FetchTimeout for more information.

Interrupt Method (AMQP Component)

This method interrupts the current action.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

This method interrupts the current action. If you use SendFile to upload a file, the component will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.

Reset Method (AMQP Component)

Reset the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method will reset the component's properties to their default values.

ResetMessage Method (AMQP Component)

Resets the Message properties.

Syntax

• C#
• VB.NET

public void ResetMessage();

Async Version
public async Task ResetMessage();
public async Task ResetMessage(CancellationToken cancellationToken);

Public Sub ResetMessage()

Async Version
Public Sub ResetMessage() As Task
Public Sub ResetMessage(cancellationToken As CancellationToken) As Task

Remarks

This method resets the Message property.

SendMessage Method (AMQP Component)

Sends a message on the specified link.

Syntax

• C#
• VB.NET

public void SendMessage(string linkName);

Async Version
public async Task SendMessage(string linkName);
public async Task SendMessage(string linkName, CancellationToken cancellationToken);

Public Sub SendMessage(ByVal LinkName As String)

Async Version
Public Sub SendMessage(ByVal LinkName As String) As Task
Public Sub SendMessage(ByVal LinkName As String, cancellationToken As CancellationToken) As Task

Remarks

This method sends a message on the link specified by LinkName.

The Message property holds an AMQPMessage object whose fields are used to construct the message to send. At minimum, specify a Value and a ValueType; all other fields are optional. The ResetMessage method can be used to reset the Message property. amqp.Message.ValueType = AMQPValueTypes.mvtString; amqp.Message.Value = "Hello World!"; amqp.SendMessage("SenderLinkName");

Message Settlement

• Settled - All messages will be sent in a settled state.
• Unsettled - All messages will be sent in an unsettled state.
• Mixed - Messages may be sent either settled or unsettled.

• First - Incoming messages will be settled immediately (and the sender will be notified that the message has been received, if the message was not already settled when sent).
• Second - Incoming messages will be settled after the sender has settled them (and the sender will be notified when a message has been received, if the message was not already settled when sent).

Together, the sender's and receiver's settle modes can form the following delivery guarantees:

It is important to note that the message settlement system has a big caveat: Whichever party opens the link can only request that the other end use a specific settle mode. For example, if the component opens a sender link, it has control over the sender settle mode it will use, but it can only request that the remote host use a specific receiver settle mode; so if the component requests that the receiver use Second, the receiver can instead choose to use First (if, e.g., it doesn't support Second).

The component currently only ever requests (and itself only supports) the First receiver settle mode since no other AMQP implementations appear to support the Second receiver settle mode at this time.

The component requests (and uses) the Mixed sender settle mode by default, but supports all of the sender settle modes (the default can be changed using the DefaultSenderSettleMode configuration setting). Sender links created with the Mixed sender use the value of the Message.Settled field to determine whether to send messages as settled or unsettled.

Sending Composite Data

Composite Data JSON Schema

The component uses JSON with a well-defined schema to represent composite data. The composite data JSON schema consists almost entirely of "type-value" objects, which hold an AMQP typename and a value. The syntax for a type-value object is:

{
  "type": "typename",
  "value": value
}

The following table provides a complete list of valid typenames, and describes how the associated values should be represented:

Arrays, Lists, and Maps

The AMQP data model defines three data structure types: array, list, and map. In the composite data JSON schema, their value is always a JSON array that contains zero or more type-value objects. Data structure types may be nested arbitrarily to any depth.

Note that the array and map data structures each have restrictions on their content:

• The elements in an array must all be of the same type (e.g., their typenames must match).
• The elements in a map represent keys (odd-numbered elements) and values (even-numbered elements). There must be an even number of elements (or none), and the values of the "key" elements must be unique.

{
  "type": "map",
  "value": [
    { "type": "symbol", "value": "key1" },
    { "type": "string", "value": "value1" },
    { "type": "symbol", "value": "key2" },
    { "type": "int", "value": 100 }
  ]
}

Described Types

As noted above, AMQP's data model includes the idea of "described types", which is simply a normal AMQP type annotated by a descriptor. The descriptor defines what the data it is associated with represents as a whole.

In the composite data JSON schema, a described type object is just a normal type-value object with an extra "descriptor" property on it (and the "descriptor" property's value is itself a normal type-value object). The syntax for a described type object is:

{
  "descriptor": { "type": "typename", "value": value },
  "type": "typename",
  "value": value
}

Described type objects can be used anywhere that normal type-value objects can be, except as the value of the "descriptor" property for another described type object, which must be a normal type-value object.

Note that, according to the AMQP specification, the type of the descriptor itself ulong or symbol, but the component does not enforce this.

Abbreviated Value Syntax

For brevity, it is possible to abbreviate both normal type-value objects and described type objects when their value type is null, boolean, or string.

For normal type-value objects, instead of using the standard syntax (e.g., { "type": "string", "value": "Hello, world!" }), just use the raw value itself (e.g., "Hello, world!"). Keep in mind that the abbreviated value must still be valid JSON; notably, strings must still be surrounded by quotes (e.g., "value", not value).

The abbreviated syntax for a described type object is a bit different; the "descriptor" property still needs to be associated with the value using a JSON object. To abbreviate a described type object, just exclude the "type" property, like so:

{
  "descriptor": { "type": "typename", "value": value },
  "value": value
}

The abbreviated value syntax can be used anywhere that an unabbreviated type-value object or described type object would normally be used.

The component defaults to using the abbreviated syntax when returning composite data JSON. This can be configured using the SimplifiedJSONFormat configuration setting.

Composite Data JSON Example

{
  "descriptor": { "type": "symbol", "value": "nsoftware:compositeDataExample" },
  "type": "list",
  "value": [
    "Shorthand string value",
    null,
    true,
    { "type": "uuid", "value": "12345678-0000-1000-8000-00805F9B34FB" },
    {
      "type": "array",
      "value": [
        { "type": "uint", "value": 23 },
        { "type": "uint", "value": 52 },
        { "type": "uint", "value": 153325 }
      ]
    },
    {
      "type": "map",
      "value": [
        { "type": "symbol", "value": "name" },
        "Freezer temperature",
        { "type": "symbol", "value": "unit" },
        "Fahrenheit",
        { "type": "symbol", "value": "value" },
        { "type": "int", "value": -2 }
      ]
    },
    {
      "descriptor": { "type": "symbol", "value": "nsoftware:utf8Bytes" },
      "type": "binary",
      "value": "48656C6C6F2C20776F726C6421"
    }
  ]
}

Connected Event (AMQP Component)

This event is fired immediately after a connection completes (or fails).

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, AmqpConnectedEventArgs e);

public class AmqpConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As AmqpConnectedEventArgs)

Public Class AmqpConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (AMQP Component)

This event is fired to indicate changes in the connection state.

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, AmqpConnectionStatusEventArgs e);

public class AmqpConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As AmqpConnectionStatusEventArgs)

Public Class AmqpConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (AMQP Component)

This event is fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, AmqpDisconnectedEventArgs e);

public class AmqpDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As AmqpDisconnectedEventArgs)

Public Class AmqpDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (AMQP Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, AmqpErrorEventArgs e);

public class AmqpErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As AmqpErrorEventArgs)

Public Class AmqpErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

LinkReadyToSend Event (AMQP Component)

Fires when a sender link is ready to send messages.

Syntax

• C#
• VB.NET

public event OnLinkReadyToSendHandler OnLinkReadyToSend;

public delegate void OnLinkReadyToSendHandler(object sender, AmqpLinkReadyToSendEventArgs e);

public class AmqpLinkReadyToSendEventArgs : EventArgs {
  public string LinkName { get; }
  public int LinkIndex { get; }
}

Public Event OnLinkReadyToSend As OnLinkReadyToSendHandler

Public Delegate Sub OnLinkReadyToSendHandler(sender As Object, e As AmqpLinkReadyToSendEventArgs)

Public Class AmqpLinkReadyToSendEventArgs Inherits EventArgs
  Public ReadOnly Property LinkName As String
  Public ReadOnly Property LinkIndex As Integer
End Class

Remarks

This event fires when a sender link is ready to send messages.

LinkName is the name of the sender link.

LinkIndex is the index of the sender link in the Links collection.

Log Event (AMQP Component)

Fires once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, AmqpLogEventArgs e);

public class AmqpLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As AmqpLogEventArgs)

Public Class AmqpLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of the Message. Possible values are:

LogType identifies the type of log entry. Possible values are:

• Info: General information about the component.
• Session: Session status messages.
• Frame: Frame status messages.

MessageIn Event (AMQP Component)

Fires when the component receives a message.

Syntax

• C#
• VB.NET

public event OnMessageInHandler OnMessageIn;

public delegate void OnMessageInHandler(object sender, AmqpMessageInEventArgs e);

public class AmqpMessageInEventArgs : EventArgs {
  public string SessionName { get; }
  public int SessionIndex { get; }
  public string LinkName { get; }
  public int LinkIndex { get; }
  public string MessageId { get; }
  public int State { get; set; }
}

Public Event OnMessageIn As OnMessageInHandler

Public Delegate Sub OnMessageInHandler(sender As Object, e As AmqpMessageInEventArgs)

Public Class AmqpMessageInEventArgs Inherits EventArgs
  Public ReadOnly Property SessionName As String
  Public ReadOnly Property SessionIndex As Integer
  Public ReadOnly Property LinkName As String
  Public ReadOnly Property LinkIndex As Integer
  Public ReadOnly Property MessageId As String
  Public Property State As Integer
End Class

Remarks

This event fires whenever the component receives a message. The message itself is automatically stored as an AMQPMessage object in the ReceivedMessage property.

Specifying a Delivery Outcome

• 0: Accepted - The message has been processed successfully.
• 1: Rejected - The message failed to process successfully. Includes an error describing why.
• 2: Released - The message has not been (and will not be) processed.
• 3: Modified - Same as "Released", but with additional metadata for the sender.

When State is set to Rejected (1), the component will include error metadata when it informs the sender of the outcome. Set the RejectErrorCondition and RejectErrorDescription configuration settings before the event handler finishes to specify this error information.

When State is set to Modified (3), the component can include additional metadata when it informs the sender of the outcome. Set zero or more of the ModifiedDeliveryFailed, ModifiedMessageAnnotations, and ModifiedUndeliverableHere configuration settings before the event handler finishes to specify this additional metadata.

Other Parameters

SessionIndex is the index of the session in the Sessions collection property.

LinkName is the name of the link the message was transmitted on.

LinkIndex is the index of the link in the Links collection property.

MessageId is the Id of the message; it may be empty if a message Id was not set.

MessageOut Event (AMQP Component)

Fires when the component sends a message.

Syntax

• C#
• VB.NET

public event OnMessageOutHandler OnMessageOut;

public delegate void OnMessageOutHandler(object sender, AmqpMessageOutEventArgs e);

public class AmqpMessageOutEventArgs : EventArgs {
  public string SessionName { get; }
  public int SessionIndex { get; }
  public string LinkName { get; }
  public int LinkIndex { get; }
  public string MessageId { get; }
}

Public Event OnMessageOut As OnMessageOutHandler

Public Delegate Sub OnMessageOutHandler(sender As Object, e As AmqpMessageOutEventArgs)

Public Class AmqpMessageOutEventArgs Inherits EventArgs
  Public ReadOnly Property SessionName As String
  Public ReadOnly Property SessionIndex As Integer
  Public ReadOnly Property LinkName As String
  Public ReadOnly Property LinkIndex As Integer
  Public ReadOnly Property MessageId As String
End Class

Remarks

This event fires whenever the component sends a message.

SessionName is the name of the session the message was transmitted on.

SessionIndex is the index of the session in the Sessions collection property.

LinkName is the name of the link the message was transmitted on.

LinkIndex is the index of the link in the Links collection property.

MessageId is the Id of the message; it may be empty if a message Id was not set.

MessageOutcome Event (AMQP Component)

Fires when a message's outcome is available.

Syntax

• C#
• VB.NET

public event OnMessageOutcomeHandler OnMessageOutcome;

public delegate void OnMessageOutcomeHandler(object sender, AmqpMessageOutcomeEventArgs e);

public class AmqpMessageOutcomeEventArgs : EventArgs {
  public string SessionName { get; }
  public int SessionIndex { get; }
  public string LinkName { get; }
  public int LinkIndex { get; }
  public string MessageId { get; }
  public int Direction { get; }
  public int State { get; }
}

Public Event OnMessageOutcome As OnMessageOutcomeHandler

Public Delegate Sub OnMessageOutcomeHandler(sender As Object, e As AmqpMessageOutcomeEventArgs)

Public Class AmqpMessageOutcomeEventArgs Inherits EventArgs
  Public ReadOnly Property SessionName As String
  Public ReadOnly Property SessionIndex As Integer
  Public ReadOnly Property LinkName As String
  Public ReadOnly Property LinkIndex As Integer
  Public ReadOnly Property MessageId As String
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property State As Integer
End Class

Remarks

This event fires whenever the outcome for a message (incoming or outgoing) is available.

SessionName is the name of the session the message was transmitted on.

SessionIndex is the index of the session in the Sessions collection property.

LinkName is the name of the link the message was transmitted on.

LinkIndex is the index of the link in the Links collection property.

MessageId is the Id of the message; it may be empty if a message Id was not set.

Direction indicates whether this outcome was sent (0) or received (1).

State indicates the actual message outcome. Possible values are:

• 0: Accepted - The message has been processed successfully.
• 1: Rejected - The message failed to process successfully. Includes an error describing why.
• 2: Released - The message has not been (and will not be) processed.
• 3: Modified - Same as "Released", but with additional metadata for the sender.

When State is Rejected (1), the RejectErrorCondition and RejectErrorDescription configuration settings can be queried before the event handler finishes to retrieve the error information.

When State is Modified (3), the ModifiedDeliveryFailed, ModifiedMessageAnnotations, and ModifiedUndeliverableHere configuration settings can be queried before the event handler finishes to retrieve the additional metadata.

SSLServerAuthentication Event (AMQP Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, AmqpSSLServerAuthenticationEventArgs e);

public class AmqpSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As AmqpSSLServerAuthenticationEventArgs)

Public Class AmqpSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (AMQP Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, AmqpSSLStatusEventArgs e);

public class AmqpSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As AmqpSSLStatusEventArgs)

Public Class AmqpSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

AMQPLink Type

Represents an AMQP link.

Remarks

This type represents an AMQP link.

Fields

Constructors

• C#
• VB.NET

public AMQPLink();

Public AMQPLink()

AMQPMessage Type

Represents an AMQP message.

Remarks

This type represents an AMQP message.

Fields

Constructors

• C#
• VB.NET

public AMQPMessage();

Public AMQPMessage()

AMQPSession Type

Represents an AMQP session.

Remarks

This type represents an AMQP session.

Fields

Constructors

• C#
• VB.NET

public AMQPSession();

Public AMQPSession()

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

Config Settings (AMQP Component)

AMQP Config Settings

{
  "type": "map",
  "value": [
    { "type": "symbol", "value": "key1" },
    { "type": "string", "value": "test" },
    { "type": "symbol", "value": "key2" },
    { "type": "int", "value": 100 }
  ]
}

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Trappable Errors (AMQP Component)

AMQP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors