AMQPClassic Class

Properties Methods Events Config Settings Errors

An easy-to-use AMQP 0.9.1 client implementation, with support for RabbitMQ extensions.

Syntax

ipworksiot.AMQPClassic

Remarks

The AMQPClassic class provides an easy-to-use AMQP 0.9.1 client implementation, and it also supports certain RabbitMQ extensions to the AMQP 0.9.1 specification. The class supports both plaintext and TLS-enabled connections over TCP.

Connecting

The AMQP 0.9.1 transport protocol has two layers: an overall connection between the client and server, and one or more channels running over that connection.

The class implements both layers, so the first step is to initiate the overall connection. Set the AuthScheme, User, Password, SSLEnabled, and VirtualHost properties if necessary, then call the ConnectTo method, passing it the server's hostname and port number. (If the server in question is not running RabbitMQ, disabling the RabbitMQCompatible configuration setting before connecting is also recommended.)

The next step is to create at least one channel, which can be accomplished by using the CreateChannel method. The class allows creating any number of channels, up to the limit specified by the MaxChannelCount configuration setting.

Connecting and Creating a Channel // The examples in this documentation use a RabbitMQ server, which requires SASL Plain auth. amqpc1.AuthScheme = AmqpclassicAuthSchemes.smSASLPlain; amqpc1.User = "guest"; amqpc1.Password = "guest"; amqpc1.SSLEnabled = true; amqpc1.ConnectTo("amqpclassic.test-server.com", 5671); amqpc1.CreateChannel("channel");

Once the class has connected to the server, and one or more channels have been opened, the class can begin manipulating exchanges and queues, publishing messages, and creating consumers.

Note that most AMQP 0.9.1 operations can themselves vary in their complexity. The examples below are intentionally simple for the sake of clarity and brevity, but links are provided for many other parts of the class's API where more detail can be found.

Declaring Exchanges

The DeclareExchange method is used to declare (i.e., create, or verify the existence of) exchanges on the server. While all AMQP servers provide a default, direct-type exchange that all queues are bound to automatically (using their name as the routing key), more complex use-cases will often require creating additional exchanges of varying types.

Declaring an Exchange // Declare a direct-type exchange. amqpc1.DeclareExchange("channel", "MyExchange", "direct", false, false, false, false);

Exchanges can also be deleted using the DeleteExchange method.

Declaring Queues

The DeclareQueue method is used to declare (i.e., create, or verify the existence of) queues on the server. Unlike with exchanges, the server does not provide any queues by default, so declaring a queue is always necessary (unless one has already been created by another client, or configured ahead-of-time on the server itself).

Declaring a Queue // Declare a queue. amqpc1.DeclareQueue("channel", "MyQueue", false, false, false, false, false);

Queues may also be deleted or purged using the DeleteQueue and PurgeQueue methods.

Binding Queues to Exchanges

The BindQueue method is used to bind a queue to an exchange. Exchanges use the information held by their queue bindings to determine which messages to forward to which queues.

Note that all AMQP 0.9.1 servers automatically bind all queues to their default exchange (which is always a direct exchange with no name) using each queue's name as the binding's routing key. This makes it easy to send a message to a specific queue without having to declare bindings; just call PublishMessage, pass empty string for ExchangeName, and the name of the desired queue for RoutingKey.

Binding a Queue to an Exchange // Bind a queue to an exchange. Messages will only be delivered to the queue if their routing key is "MyRoutingKey". amqpc1.BindQueue("channel", "MyQueue", "MyExchange", "MyRoutingKey", false);

Queues can also be unbound from exchanges using the UnbindQueue method.

Publishing Messages

To publish a message, populate the Message property's fields, and then call the PublishMessage method.

Publishing a Message amqpc1.Message.Body = "Hello, world!"; // Publish a message to the server's default (no-name) exchange, using the name of a specific queue as the routing key. amqpc1.PublishMessage("channel", "", "MyQueue", false, false); // Publish a message to the "MyExchange" exchange, using the routing key "MyRoutingKey". amqpc1.PublishMessage("channel", "MyExchange", "MyRoutingKey", false, false);

Note that outgoing messages may be handled differently by the server if the channel they are sent over is in transaction or (for RabbitMQ only) "publish confirmations" mode. Refer to the EnableTransactionMode and EnablePublishConfirms methods for more information.

Receiving Messages

There are two possible ways for the class to receive a message:

Messages can be asynchronously pushed to the class from the server. At any point in time, the server may push a message to the class from a queue that the Consume method has been used to attach a consumer to.
Messages can be synchronously pulled from the server by the class. The RetrieveMessage method is used to attempt to pull (or "retrieve") messages from a specific queue.

Regardless of how they are received, all incoming messages cause the ReceivedMessage property's fields to be populated and the MessageIn event to fire.

Receiving a Message // MessageIn event handler. amqpc1.OnMessageIn += (s, e) => { if (e.MessageCount == -1) { // The server pushed a message to us asynchronously due to a consumer we created. Console.WriteLine("The server pushed this message to us via consumer '" + e.ConsumerTag + "':"); Console.WriteLine(amqpc1.ReceivedMessage.Body); } else if (e.DeliveryTag > 0) { // We pulled a message from a queue with the RetrieveMessage() method. Console.WriteLine("Message successfully pulled:"); Console.WriteLine(amqpc1.ReceivedMessage.Body); Console.WriteLine(e.MessageCount + " messages are still available to pull."); } else { // We tried to pull a message, but there were none available to pull. Console.WriteLine("No messages available to pull."); } }; // Attach a consumer to "MyQueue". amqpc1.Consume("channel", "MyQueue", "consumerTag", false, true, false, false); // Or, try to retrieve a message from "MyQueue". amqpc1.RetrieveMessage("channel", "MyQueue", true);

Note that the MessageIn event always fires if RetrieveMessage is called successfully, even if there were no messages available to retrieve; refer to MessageIn for more information.

Property List

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


Arguments	A collection of table fields that specify arguments to send to the server when calling certain methods.
AuthScheme	The authentication scheme to use when connecting.
Channels	Collection of active channels.
ClientProperties	A collection of table fields that describe properties of the client.
Connected	This property indicates whether the class is connected.
Firewall	A set of properties related to firewall access.
Heartbeat	The heartbeat timeout value.
IncomingMessages	Collection of incoming messages which are waiting for acknowledgment.
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 class binds.
Message	The message to send.
OutgoingMessages	Collection of outgoing messages which are waiting for acknowledgment.
Password	A password to use for SASL authentication.
QueueMessageCount	The message count returned by various queue operations.
ReceivedMessage	The last message received.
RemoteHost	This property includes 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.
ServerProperties	A collection of table fields that describe properties of the server.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLEnabled	This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
Timeout	This property includes the timeout for the class.
User	A username to use for SASL authentication.
VirtualHost	The virtual host to connect to.

Method List

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


BindQueue	Binds a queue to an exchange.
CancelConsume	Cancels an existing consumer.
CloseChannel	Closes a channel.
CommitTransaction	Commits the current transaction for a channel.
Config	Sets or retrieves a configuration setting.
Connect	This method connects to a remote host.
ConnectTo	This method connects to a remote host.
Consume	Starts a new consumer for a given queue.
CreateChannel	Creates a new channel.
DeclareExchange	Verifies that an exchange exists, potentially creating it if necessary.
DeclareQueue	Verifies that a queue exists, potentially creating it if necessary.
DeleteExchange	Deletes an exchange.
DeleteQueue	Deletes a queue.
Disconnect	This method disconnects from the remote host.
DoEvents	This method processes events from the internal message queue.
EnablePublishConfirms	Enables publish confirmations mode for a channel.
EnableTransactionMode	Enables transaction mode for a channel.
Interrupt	Interrupt the current action and disconnects from the remote host.
PublishMessage	Publishes a message.
PurgeQueue	Purges all messages from a queue.
Recover	Request that the server redeliver all messages on a given channel that have not been acknowledged.
Reset	This method will reset the class.
ResetMessage	Resets the Message properties.
RetrieveMessage	Attempts to retrieve a message from a given queue.
RollbackTransaction	Rolls back the current transaction for a channel.
SetChannelAccept	Disables or enables message acceptance for a given channel.
SetQoS	Requests a specific quality of service (QoS).
UnbindQueue	Removes a previously-created queue binding.

Event List

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


ChannelReadyToSend	Fires when a channel is ready to send messages.
Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in the connection state.
Disconnected	Fired when a connection is closed.
Error	Fired when information is available about errors during data delivery.
Log	Fires once for each log message.
MessageIn	Fires when a message is received; as well as when an attempt is made to fetch a message from a currently empty queue.
MessageOut	Fires when a message is published.
MessageReturned	Fires if a previously published message is returned by the server due to it being undeliverable.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.

Config Settings

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


AuthorizationIdentity	The value to use as the authorization identity when SASL authentication is used.
ConsumerTag	The consumer tag associated with the most recently created consumer.
Locale	The desired message locale to use.
Locales	The message locales supported by the server.
LogLevel	The level of detail that is logged.
MaxChannelCount	The maximum number of channels.
MaxFrameSize	The maximum frame size.
Mechanisms	The authentication mechanisms supported by the server.
NackMultiple	Whether negative acknowledgments should be cumulative or not.
ProtocolVersion	The AMQP protocol version to conform to.
QueueConsumerCount	The consumer count associated with the most recently created (or verified) queue.
QueueName	The queue name associated with the most recently created (or verified) queue.
RabbitMQCompatible	Whether to operate in a mode compatible with RabbitMQ.
CloseStreamAfterTransfer	If true, the class will close the upload or download stream after the transfer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the class binds to a SOCKS firewall as a server (TCPClient only).
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 class 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.
UseNTLMv2	Whether to use NTLM V2.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLContextProtocol	The protocol used when getting an SSLContext instance.
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.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
SSLTrustManagerFactoryAlgorithm	The algorithm to be used to create a TrustManager through TrustManagerFactory.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
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.
GUIAvailable	Whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseDaemonThreads	Whether threads created by the class are daemon threads.
UseFIPSCompliantAPI	Tells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Arguments Property (AMQPClassic Class)

A collection of table fields that specify arguments to send to the server when calling certain methods.

Syntax

public AMQPCTableFieldList getArguments();
public void setArguments(AMQPCTableFieldList arguments);

Remarks

This property holds a collection of AMQPCTableField objects representing additional arguments sent when one of the following methods is called:

Consume
DeclareExchange
DeclareQueue
BindQueue
UnbindQueue

Arguments are typically server-dependent; refer to your server's documentation to determine what, if any, arguments are supported for each of the above methods.

This property is not available at design time.

Please refer to the AMQPCTableField type for a complete list of fields.

AuthScheme Property (AMQPClassic Class)

The authentication scheme to use when connecting.

Syntax

public int getAuthScheme();
public void setAuthScheme(int authScheme);

Enumerated values:
  public final static int smNone = 0;
  public final static int smSASLAnonymous = 1;
  public final static int smSASLPlain = 2;
  public final static int smSASLExternal = 3;

Default Value

Remarks

This property controls what authentication scheme the class 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.

Channels Property (AMQPClassic Class)

Collection of active channels.

Syntax

public AMQPCChannelList getChannels();

Remarks

This collection property holds a list of AMQPCChannel items, one for each currently active channel.

Refer to CreateChannel and CloseChannel for more information.

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

Please refer to the AMQPCChannel type for a complete list of fields.

ClientProperties Property (AMQPClassic Class)

A collection of table fields that describe properties of the client.

Syntax

public AMQPCTableFieldList getClientProperties();
public void setClientProperties(AMQPCTableFieldList clientProperties);

Remarks

This property holds a collection of AMQPCTableField objects representing client properties. During the connection process, these properties will be sent to the server.

While the class does not send any client properties by default, it is common for AMQP clients to send "product", "version", and "platform" properties to help identify themselves.

This property is not available at design time.

Please refer to the AMQPCTableField type for a complete list of fields.

Connected Property (AMQPClassic Class)

This property indicates whether the class is connected.

Syntax

public boolean isConnected();

Default Value

False

Remarks

This property indicates whether the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

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

Firewall Property (AMQPClassic Class)

A set of properties related to firewall access.

Syntax

public Firewall getFirewall();
public void setFirewall(Firewall firewall);

Remarks

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

Please refer to the Firewall type for a complete list of fields.

Heartbeat Property (AMQPClassic Class)

The heartbeat timeout value.

Syntax

public int getHeartbeat();
public void setHeartbeat(int heartbeat);

Default Value

Remarks

This property specifies the heartbeat timeout value, in seconds. Heartbeats are disabled if set to 0 (default).

Before connecting, this property can be set to indicate the desired heartbeat timeout value. During the connection process, the class and the server will compare their desired heartbeat values and choose the lower one.

Once connected, this property will reflect the agreed-upon heartbeat value. While the connection is idle, heartbeats are sent by both the class and the server approximately once every (Heartbeat / 2) seconds. If either side has not received a heartbeat (or other transmission) for ~Heartbeat seconds, it will consider the other side unreachable and close the connection.

This setting cannot be changed while connected.

This property is not available at design time.

IncomingMessages Property (AMQPClassic Class)

Collection of incoming messages which are waiting for acknowledgment.

Syntax

public AMQPCMessageList getIncomingMessages();

Remarks

This property holds a collection of AMQPCMessage objects that represent incoming messages the class has yet to send acknowledgements to the server for.

Refer to the MessageIn event for more information about message acknowledgements.

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

Please refer to the AMQPCMessage type for a complete list of fields.

LocalHost Property (AMQPClassic Class)

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

Syntax

public String getLocalHost();
public void setLocalHost(String localHost);

Default Value

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class 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 multihomed 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 (AMQPClassic Class)

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

Syntax

public int getLocalPort();
public void setLocalPort(int localPort);

Default Value

Remarks

This property must be set before a connection is attempted. It instructs the class 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 on the client side.

Message Property (AMQPClassic Class)

The message to send.

Syntax

public AMQPCMessage getMessage();
public void setMessage(AMQPCMessage message);

Remarks

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

Refer to PublishMessage for more information.

This property is not available at design time.

Please refer to the AMQPCMessage type for a complete list of fields.

OutgoingMessages Property (AMQPClassic Class)

Collection of outgoing messages which are waiting for acknowledgment.

Syntax

public AMQPCMessageList getOutgoingMessages();

Remarks

This property holds a collection of AMQPCMessage objects that represent outgoing messages the class has yet to receive acknowledgements from the server for.

Refer to the PublishMessage method for more information.

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

Please refer to the AMQPCMessage type for a complete list of fields.

Password Property (AMQPClassic Class)

A password to use for SASL authentication.

Syntax

public String getPassword();
public void setPassword(String password);

Default Value

Remarks

This property contains a password to use for SASL authentication.

This property is not available at design time.

QueueMessageCount Property (AMQPClassic Class)

The message count returned by various queue operations.

Syntax

public int getQueueMessageCount();

Default Value

Remarks

This property is populated with a message count after calling certain queue-related methods.


After calling...	This property will reflect...
DeclareQueue	The number of messages currently in the queue.
PurgeQueue	The number of messages purged from the queue.
DeleteQueue	THe number of messages deleted along with the queue.

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

ReceivedMessage Property (AMQPClassic Class)

The last message received.

Syntax

public AMQPCMessage getReceivedMessage();

Remarks

This property is an AMQPCMessage object which represents the last message received by the class. It is populated by the class automatically each time a message is received.

Refer to Consume, RetrieveMessage, and MessageIn for more information.

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

Please refer to the AMQPCMessage type for a complete list of fields.

RemoteHost Property (AMQPClassic Class)

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

Syntax

public String getRemoteHost();
public void setRemoteHost(String remoteHost);

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 class 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 (AMQPClassic Class)

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

Syntax

public int getRemotePort();
public void setRemotePort(int remotePort);

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.

ServerProperties Property (AMQPClassic Class)

A collection of table fields that describe properties of the server.

Syntax

public AMQPCTableFieldList getServerProperties();

Remarks

After connecting, this property will hold a collection of AMQPCTableField objects representing server properties.

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

Please refer to the AMQPCTableField type for a complete list of fields.

SSLAcceptServerCert Property (AMQPClassic Class)

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

Syntax

public Certificate getSSLAcceptServerCert();
public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the class 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.

Note: This functionality is provided only for cases in which 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.

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (AMQPClassic Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

public Certificate getSSLCert();
public void setSSLCert(Certificate SSLCert);

Remarks

This property includes the digital certificate that the class 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.

Please refer to the Certificate type for a complete list of fields.

SSLEnabled Property (AMQPClassic Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

public boolean isSSLEnabled();
public void setSSLEnabled(boolean SSLEnabled);

Default Value

False

Remarks

This property specifies whether TLS/SSL is enabled in the class. When False (default), the class 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 (AMQPClassic Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

public int getSSLProvider();
public void setSSLProvider(int SSLProvider);

Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

Default Value

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 class 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 as follows:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

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

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

SSLServerCert Property (AMQPClassic Class)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

Timeout Property (AMQPClassic Class)

This property includes the timeout for the class.

Syntax

public int getTimeout();
public void setTimeout(int timeout);

Default Value

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 class will wait for the operation to complete before returning control. The class 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 class will wait for the operation to complete before returning control.

Additional Notes

The class 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 class throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, 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 (AMQPClassic Class)

A username to use for SASL authentication.

Syntax

public String getUser();
public void setUser(String user);

Default Value

Remarks

This property contains a username to use for SASL authentication.

This property is not available at design time.

VirtualHost Property (AMQPClassic Class)

The virtual host to connect to.

Syntax

public String getVirtualHost();
public void setVirtualHost(String virtualHost);

Default Value

"/"

Remarks

This property specifies the virtual host to connect to on the server, and is set to / by default.

Note that the configuration of the server defines what virtual hosts are available.

This setting cannot be changed while connected.

This property is not available at design time.

BindQueue Method (AMQPClassic Class)

Binds a queue to an exchange.

Syntax

public void bindQueue(String channelName, String queueName, String exchangeName, String routingKey, boolean noWait);

Remarks

This method is used to bind the queue named QueueName to the exchange named ExchangeName. Exchanges use bindings to determine which queues to route messages to.

Multiple bindings between the same queue and exchange with different RoutingKeys and/or arguments are allowed; requests that would create a duplicate binding are ignored. No queue will ever receive duplicate copies of any message, regardless of what bindings are present on the server.

ChannelName controls what channel the class will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.

QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.

The server's default exchange may be specified by passing empty string for ExchangeName. Otherwise, ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.

The RoutingKey parameter specifies the binding's routing key. Exchanges that use routing-key-based logic make some sort of comparison between the routing keys of incoming messages and this value to decide which messages should be forwarded to the specified queue. Examples of exchange types which use routing keys include:

direct exchanges, which compare (for equality) the routing keys of incoming messages to the routing keys of each queue bound to them.
topic exchanges, which match the routing keys of incoming messages against the routing pattern of each queue bound to them.

Not all exchange types make use of routing keys, in which case empty string can be passed for the RoutingKey parameter. Examples of exchange types which don't use routing keys include:

fanout exchanges simply forward incoming messages to all queues bound to them, unconditionally.
header exchanges only forward messages that include certain headers. When binding a queue to a header exchange, add items to the Arguments collection to describe the headers that eligible messages must have, and whether they must have any or all of those headers.

Note that the format of the RoutingKey parameter and/or the content of the Arguments collection may differ slightly between server implementations. Refer to your server's documentation to determine what it expects to receive for each exchange type that it supports.

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:

No queue with the given QueueName exists.
No exchange with the given ExchangeName exists.

Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.

CancelConsume Method (AMQPClassic Class)

Cancels an existing consumer.

Syntax

public void cancelConsume(String channelName, String consumerTag, boolean noWait);

Remarks

This method requests that the server cancel the consumer identified by the given ConsumerTag on the channel specified by ChannelName.

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because no consumer with the given ConsumerTag exists.

CloseChannel Method (AMQPClassic Class)

Closes a channel.

Syntax

public void closeChannel(String channelName);

Remarks

This method closes the channel named ChannelName and removes it from the Channels collection.

If no channel with the given ChannelName exists, an exception will be thrown.

CommitTransaction Method (AMQPClassic Class)

Commits the current transaction for a channel.

Syntax

public void commitTransaction(String channelName);

Remarks

This method commits the current transaction for the channel with the given ChannelName. A new transaction is started immediately after the current one is committed.

Refer to EnableTransactionMode for more information about transactions.

An exception is thrown if a channel with the given ChannelName doesn't exist, or if the server returns an error because the channel does not have transaction mode enabled.

Config Method (AMQPClassic Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (AMQPClassic Class)

This method connects to a remote host.

Syntax

public void connect();

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 (AMQPClassic Class)

This method connects to a remote host.

Syntax

public void connectTo(String host, int port);

Remarks

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

Consume Method (AMQPClassic Class)

Starts a new consumer for a given queue.

Syntax

public void consume(String channelName, String queueName, String consumerTag, boolean noLocal, boolean noAck, boolean exclusive, boolean noWait);

Remarks

This method instructs the server to start a new consumer on the queue named QueueName; once the consumer is created, it will cause messages enqueued to the specified queue to be delivered to the class over the channel specified by ChannelName.

Consumers last as long as the channel they were created on, or until they are cancelled using the CancelConsume method. Each time a message is delivered to the class, it is immediately added to the IncomingMessages collection, the ReceivedMessage property is populated, and the MessageIn event fires.

ConsumerTag is a string which uniquely identifies the new consumer on the specified channel. If empty string is passed for ConsumerTag, the server will generate a consumer tag automatically when it creates the . this auto-generated consumer tag can then be retrieved by querying the ConsumerTag configuration setting after this method returns.

The NoLocal parameter, if True, ensures that the consumer never consumes messages published on the same channel. (Note that this functionality is not available on RabbitMQ servers, which ignore the NoLocal parameter).

The NoAck parameter controls whether the server will expect the class to acknowledge the each message delivered. Refer to MessageIn for more information about acknowledging messages.

The Exclusive parameter, if True, will cause the class to request that the server create an exclusive consumer. Attaching an exclusive consumer to a queue prevents any other consumers from consuming messages from that queue.

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

Additional arguments may be sent with this request by adding them to the Arguments collection. Arguments are server-dependent; refer to your server's documentation to determine if any additional arguments apply for this request.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:

No queue with the given QueueName exists.
The given ConsumerTag is already in use on the specified channel.
An exclusive consumer was requested for a queue which already has consumers attached to it.

CreateChannel Method (AMQPClassic Class)

Creates a new channel.

Syntax

public void createChannel(String channelName);

Remarks

This method creates a new channel with the name ChannelName and adds it to the Channels collection. If a channel with the given ChannelName already exists, an error will be thrown.

DeclareExchange Method (AMQPClassic Class)

Verifies that an exchange exists, potentially creating it if necessary.

Syntax

public void declareExchange(String channelName, String exchangeName, String exchangeType, boolean passive, boolean durable, boolean autoDelete, boolean noWait);

Remarks

This method is used to verify that an exchange named ExchangeName exists; and potentially creates it if no such exchange exists.

ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq. unless the Passive parameter is True.

ExchangeType specifies the exchange type. All servers support the direct and fanout exchange types, and most should also support the topic and header exchange types. Some servers may support additional, custom exchange types as well. Refer to your server's documentation for more information about each exchange type, and to determine what exchange types it supports other than direct and fanout.

If Passive is True, the server will only verify that an exchange with the given ExchangeName actually exists (regardless of how it is configured).

If Passive is False, and no exchange named ExchangeName currently exists, the server will create one.

If Passive is False, and there is a preexisting exchange named ExchangeName, the server will verify that its current configuration matches the given parameters and arguments.

Durable specifies what happens to the exchange in the event of a server restart. Durable exchanges will be recreated, while non-durable (transient) exchanges will not.

AutoDelete specifies whether the server should automatically delete the exchange when all queues have been unbound from it. Note that this parameter is only sent if the RabbitMQCompatible configuration setting is enabled; it is ignored otherwise.

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:

One of the parameter constraints described above was violated.
One of the verification cases described above fails.
The value passed for ExchangeType did not correspond to an exchange type supported by the server.

Declaring an Exchange // Declare a direct-type exchange. amqpc1.DeclareExchange("channel", "MyExchange", "direct", false, false, false, false);

DeclareQueue Method (AMQPClassic Class)

Verifies that a queue exists, potentially creating it if necessary.

Syntax

public void declareQueue(String channelName, String queueName, boolean passive, boolean durable, boolean exclusive, boolean autoDelete, boolean noWait);

Remarks

This method is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.

After each successful call to this method, the class populates the QueueMessageCount property, as well as the QueueConsumerCount and QueueName configuration settings. Refer to each one for more information.

If creating a new queue, empty string can be passed for QueueName to have the server automatically generate a name for the new queue (which can then be retrieved using the QueueName configuration setting). In all other cases, QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq. unless the Passive parameter is True.

If Passive is True, the server will only verify that a queue with the given QueueName actually exists (regardless of how it is configured).

If Passive is False, and no queue named QueueName currently exists, the server will create one.

If Passive is False, and there is a preexisting queue named QueueName, the server will verify that its current configuration matches the given parameters and arguments.

Durable specifies what happens to the queue in the event of a server restart. Durable queue will be recreated, while non-durable (transient) queue will not. (Note that the messages in durable queues will still be lost unless they are marked as persistent.)

Exclusive, if True, indicates that the queue may only be accessed by the current connection. Exclusive queues are deleted when the current connection closes.

AutoDelete specifies whether the server should automatically delete the queue when all consumers have finished using it. (Note that auto-delete queues aren't eligible for deletion until after a consumer attaches to them for the first time.)

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

An exception is thrown if no channel with the given ChannelName exists, if QueueName empty string and NoWait is True, or if the server returns an error because:

One of the parameter constraints described above was violated.
One of the verification cases described above fails.
An attempt was made to verify (i.e., the Passive parameter was True) another connection's exclusive queue.

Declaring a Queue // Declare a queue. amqpc1.DeclareQueue("channel", "MyQueue", false, false, false, false, false);

DeleteExchange Method (AMQPClassic Class)

Deletes an exchange.

Syntax

public void deleteExchange(String channelName, String exchangeName, boolean ifUnused, boolean noWait);

Remarks

This method is used to delete an exchange.

ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq..

When IfUnused is True, the server will only delete the exchange if no queues are bound to it.

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:

The value passed for ExchangeName fails one or more of the constraints described above.
No exchange named ExchangeName exists. (This does not apply for RabbitMQ; attempting to delete a non-existent exchange will always succeed.)
The IfUnused parameter was True, but the exchange still had one or more queues bound to it.

DeleteQueue Method (AMQPClassic Class)

Deletes a queue.

Syntax

public void deleteQueue(String channelName, String queueName, boolean ifUnused, boolean ifEmpty, boolean noWait);

Remarks

This method is used to delete the queue named QueueName.

After each successful call to this method, the class populates the QueueMessageCount property with the number of messages deleted along with the queue. (Note that this does not occur if the NoWait parameter is set to True.)

QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq..

When IfUnused is True, the server will only delete the queue if no consumers are attached to it.

When IfEmpty is True, the server will only delete the queue if it has no messages in it. (When IfEmpty is False, servers will typically move any remaining messages to a dead-letter queue, if one is available.)

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:

The value passed for QueueName fails one or more of the constraints described above.
No queue named QueueName exists. (This does not apply for RabbitMQ; attempting to delete a non-existent queue will always succeed.)
The IfUnused parameter was True, but the queue still had one or more consumers attached to it.
The IfEmpty parameter was True, but the queue still had one or more messages in it.

Disconnect Method (AMQPClassic Class)

This method disconnects from the remote host.

Syntax

public void disconnect();

Remarks

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

DoEvents Method (AMQPClassic Class)

This method processes events from the internal message queue.

Syntax

public void doEvents();

Remarks

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

EnablePublishConfirms Method (AMQPClassic Class)

Enables publish confirmations mode for a channel.

Syntax

public void enablePublishConfirms(String channelName, boolean noWait);

Remarks

This method enables publish confirmations mode for the channel with the given ChannelName.

While a channel is in publish confirmations mode, the server will acknowledge each message published by the class. The class will wait to fire the MessageOut event until it receives this acknowledgment. (Note that this mode is only available when the RabbitMQCompatible configuration setting is enabled.)

Note that a channel will stay in publish confirmations mode, once enabled, until it is deleted.

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

An exception is thrown if the RabbitMQCompatible configuration setting is currently False, if no channel with the given ChannelName exists, or if EnableTransactionMode has been called for the specified channel previously.

EnableTransactionMode Method (AMQPClassic Class)

Enables transaction mode for a channel.

Syntax

public void enableTransactionMode(String channelName);

Remarks

This method enables transaction mode for the channel with the given ChannelName.

While a channel is in transaction mode, all messages published and acknowledgements sent over it will be part of a transaction, and the server will wait to process them until the transaction is either committed or rolled back.

To commit the current transaction on a channel, call CommitTransaction; and to roll it back (and discard the messages and acknowledgements that were part of it), call RollbackTransaction.

Keep in mind that, according to the AMQP 0.9.1 specification:

A new transaction is always started immediately after committing or rolling back the current one, which means that...
...a channel will stay in transaction mode, once enabled, until it is deleted.
Transactions are only guaranteed to be atomic if all messages published and acknowledgements sent affect a single queue.
Any messages published on a channel in transaction mode that have the Mandatory or Immediate flags set are not guaranteed to be included in the transaction.

An exception is thrown if no channel with the given ChannelName exists, or if EnablePublishConfirms has been called for the specified channel previously.

Interrupt Method (AMQPClassic Class)

Interrupt the current action and disconnects from the remote host.

Syntax

public void interrupt();

Remarks

This method will interrupt the current method (if applicable) and cause the class to disconnect from the remote host.

PublishMessage Method (AMQPClassic Class)

Publishes a message.

Syntax

public void publishMessage(String channelName, String exchangeName, String routingKey, boolean mandatory, boolean immediate);

Remarks

This method is used to publish the message specified by the Message property to the exchange named ExchangeName over the channel specified by ChannelName.

When this method is called, the message to publish is immediately added to the OutgoingMessages collection, and the MessageOut event fires once it has been sent (or, if the specified channel is in "publish confirmations" mode, after the server has acknowledged it).

Note that messages published over channels which are in either transaction or "publish confirmations" mode may be handled differently than they would be on a channel in normal mode. Refer to the EnableTransactionMode and EnablePublishConfirms methods for more information about what each mode entails.

The RoutingKey parameter specifies the message's routing key. Whether this parameter needs to be non-empty, and what format it should have if so, depends on the type of exchange it is being sent to. Some exchange types may use information included with the message, such as its Headers. Refer to BindQueue for more information about how routing keys are used, and to your server's documentation for information on what it expects.

The Mandatory parameter controls what the server should do if the message can't be routed to any queue (either because it isn't eligible for any of the queues bound to the specified exchange because of how their bindings are configured, or because no queues are bound to the exchange in the first place). If True, the server will return the message, at which point the MessageReturned event will be fired. If False, the server will drop the message.

The Immediate parameter controls what the server should do if the message can't be immediately delivered to any consumer (either because it cannot be routed to a queue, or because the queues it can be routed to have no active consumers attached to them). If True, the server will return the message, at which point the MessageReturned event will be fired. If False, the server will queue the message if possible, or drop it if not.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:

The value passed for ExchangeName fails one or more of the constraints described above.
No exchange named ExchangeName exists.
The message is rejected for some reason.

PurgeQueue Method (AMQPClassic Class)

Purges all messages from a queue.

Syntax

public void purgeQueue(String channelName, String queueName, boolean noWait);

Remarks

This method purges all messages from the queue named QueueName. Messages which have been sent but are awaiting acknowledgment are not affected.

After each successful call to this method, the class populates the QueueMessageCount property with the number of messages purged from the queue. (Note that this does not occur if the NoWait parameter is set to True.)

QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because no queue named QueueName exists.

Recover Method (AMQPClassic Class)

Request that the server redeliver all messages on a given channel that have not been acknowledged.

Syntax

public void recover(String channelName, boolean requeue);

Remarks

This method is used to request that the server redeliver all messages that it previously sent to the class on the channel specified by ChannelName which are still awaiting acknowledgment.

A call to this method may cause the server to redeliver zero or more messages over the channel specified by ChannelName. Those messages will cause the MessageIn event to fire with its Redelivered event parameter set to True.

The Requeue parameter controls how the server should attempt to redeliver the messages awaiting acknowledgment. If set to True, the server will simple put the messages back on their original queues, and they will be delivered like any other queued messages (potentially to other consumers). If set to False, the server will redeliver the messages to the class directly.

An exception is thrown if no channel with the given ChannelName exists, or (for RabbitMQ only) if the server returns an error because Requeue was False. (RabbitMQ only supports setting Requeue to True.)

Reset Method (AMQPClassic Class)

This method will reset the class.

Syntax

public void reset();

Remarks

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

ResetMessage Method (AMQPClassic Class)

Resets the Message properties.

Syntax

public void resetMessage();

Remarks

This method resets the Message property.

RetrieveMessage Method (AMQPClassic Class)

Attempts to retrieve a message from a given queue.

Syntax

public void retrieveMessage(String channelName, String queueName, boolean noAck);

Remarks

This method attempts to retrieve a message from the queue named QueueName over the channel named ChannelName.

If a message is retrieved as a result of this method being called, it is immediately added to the IncomingMessages collection, the ReceivedMessage property is populated, and the MessageIn event fires.

Even if no message gets retrieved, the MessageIn event will still fire as long as the request was successful. The server returns the number of available messages in the specified queue in response to all successful retrieve requests, and that count is exposed by MessageIn event's MessageCount parameter. Refer to the MessageIn event for more information.

QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.

The NoAck parameter controls whether the server will expect the class to acknowledge the retrieved message. Refer to MessageIn for more information about acknowledging messages.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:

No queue with the given QueueName exists.
The specified queue exists, but is locked or otherwise unavailable to consume from (e.g., an exclusive consumer might be attached to it).

RollbackTransaction Method (AMQPClassic Class)

Rolls back the current transaction for a channel.

Syntax

public void rollbackTransaction(String channelName);

Remarks

This method rolls back the current transaction for the channel with the given ChannelName. A new transaction is started immediately after the current one is rolled back.

Refer to EnableTransactionMode for more information about transactions.

An exception is thrown if a channel with the given ChannelName doesn't exist, or if the server returns an error because the channel does not have transaction mode enabled.

SetChannelAccept Method (AMQPClassic Class)

Disables or enables message acceptance for a given channel.

Syntax

public void setChannelAccept(String channelName, boolean accept);

Remarks

This method is used to disable and enable message acceptance for the channel specified by ChannelName.

A channel is always configured to accept messages when first created, allowing the server to freely deliver messages to the class for any consumers that have been created on that channel using the Consume method.

Disabling message acceptance for a channel prevents the server from automatically delivering messages to the class over it; however, it is still possible to use the RetrieveMessage method to synchronously attempt to retrieve a message on a channel with message acceptance disabled.

An exception is thrown if no channel with the given ChannelName exists, or (for RabbitMQ only) if the server returns an error because Accept was False. (RabbitMQ does not support disabling message acceptance.)

SetQoS Method (AMQPClassic Class)

Requests a specific quality of service (QoS).

Syntax

public void setQoS(String channelName, int prefetchSize, int prefetchCount, boolean global);

Remarks

This method is used to request a specific quality of service for a certain scope. When the PrefetchSize and/or PrefetchCount are set for a certain scope, the server will limit how many messages it sends to the class before stopping to wait for one or more of them to be acknowledged.

ChannelName is the name of the channel which is used to send the request. Depending on the server and what Global is set to, it may also be significant to the request itself (refer to the Global parameter's description, below, for more information).

PrefetchSize specifies a window size in bytes; i.e., the server will stop sending messages if the total size of all of the currently unacknowledged messages already sent, plus the size of the next message that could be sent, exceeds PrefetchSize bytes. A PrefetchSize of 0 indicates no limit. (Note that RabbitMQ does not support prefetch size limits.)

PrefetchCount specifies the number of unacknowledged messages the server will limit itself to sending. A PrefetchCount of 0 indicates no limit.

Global specifies the scope which the QoS request should apply to. It is interpreted differently based on whether the server is RabbitMQ or not. Refer to this table:


Global is...	RabbitMQ	Other Servers
False	QoS will be applied individually to each new consumer on the specified channel (existing consumers are unaffected).	QoS applied to all existing and new consumers on the specified channel.
True	QoS applied to all existing and new consumers on the specified channel.	QoS applied to all existing and new consumers on the whole connection.

Keep the following things in mind when using QoS:

The limits specified by a QoS request only affect messages that require acknowledgment.
How the server chooses to handle interactions between QoS settings at different scopes is server-dependent.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error for any reason.

UnbindQueue Method (AMQPClassic Class)

Removes a previously-created queue binding.

Syntax

public void unbindQueue(String channelName, String queueName, String exchangeName, String routingKey);

Remarks

This method removes a previously-created queue binding.

QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.

RoutingKey should be the same routing key used when originally creating the binding that is to be removed. For bindings created using arguments instead of a routing key, the Arguments collection must contain the same items used originally instead.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:

No queue with the given QueueName exists. (Does not apply to RabbitMQ.)
No exchange with the given ExchangeName exists. (Does not apply to RabbitMQ.)

ChannelReadyToSend Event (AMQPClassic Class)

Fires when a channel is ready to send messages.

Syntax

public class DefaultAMQPClassicEventListener implements AMQPClassicEventListener {
  ...
  public void channelReadyToSend(AMQPClassicChannelReadyToSendEvent e) {}
  ...
}

public class AMQPClassicChannelReadyToSendEvent {
  public String channelName;
}

Remarks

This event fires when a channel is ready to send messages.

ChannelName is the name of the channel.

Connected Event (AMQPClassic Class)

Fired immediately after a connection completes (or fails).

Syntax

public class DefaultAMQPClassicEventListener implements AMQPClassicEventListener {
  ...
  public void connected(AMQPClassicConnectedEvent e) {}
  ...
}

public class AMQPClassicConnectedEvent {
  public int statusCode;
  public String description;
}

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 (AMQPClassic Class)

Fired to indicate changes in the connection state.

Syntax

public class DefaultAMQPClassicEventListener implements AMQPClassicEventListener {
  ...
  public void connectionStatus(AMQPClassicConnectionStatusEvent e) {}
  ...
}

public class AMQPClassicConnectionStatusEvent {
  public String connectionEvent;
  public int statusCode;
  public String description;
}

Remarks

This 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:


	Firewall connection complete.
	Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
	Remote host connection complete.
	Remote host disconnected.
	SSL or S/Shell connection broken.
	Firewall host disconnected.

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.

Disconnected Event (AMQPClassic Class)

Fired when a connection is closed.

Syntax

public class DefaultAMQPClassicEventListener implements AMQPClassicEventListener {
  ...
  public void disconnected(AMQPClassicDisconnectedEvent e) {}
  ...
}

public class AMQPClassicDisconnectedEvent {
  public int statusCode;
  public String description;
}

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 (AMQPClassic Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultAMQPClassicEventListener implements AMQPClassicEventListener {
  ...
  public void error(AMQPClassicErrorEvent e) {}
  ...
}

public class AMQPClassicErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class 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.

Log Event (AMQPClassic Class)

Fires once for each log message.

Syntax

public class DefaultAMQPClassicEventListener implements AMQPClassicEventListener {
  ...
  public void log(AMQPClassicLogEvent e) {}
  ...
}

public class AMQPClassicLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

Remarks

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

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


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data is logged.
3 (Debug)	Debug data is logged.

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

Info: General information about the class.
Frame: Frame status messages.

MessageIn Event (AMQPClassic Class)

Fires when a message is received; as well as when an attempt is made to fetch a message from a currently empty queue.

Syntax

public class DefaultAMQPClassicEventListener implements AMQPClassicEventListener {
  ...
  public void messageIn(AMQPClassicMessageInEvent e) {}
  ...
}

public class AMQPClassicMessageInEvent {
  public String channelName;
  public String consumerTag;
  public long deliveryTag;
  public boolean redelivered;
  public String exchangeName;
  public String routingKey;
  public int messageCount;
  public int accept; //read-write
}

Remarks

This event fires anytime a message is received. There are two possible ways for the class to receive a message:

Messages can be asynchronously pushed to the class from the server. At any point in time, the server may push a message to the class from a queue that the Consume method has been used to attach a consumer to.
Messages can be synchronously pulled from the server by the class. The RetrieveMessage method is used to attempt to pull (or "retrieve") messages from a specific queue.

This event also fires anytime RetrieveMessage is called against a queue that currently has no messages available to pull. This is a special case, and results in only the ChannelName and MessageCount event parameters being populated.

Other than that special case, and any exceptions noted below, this event's parameters are populated the same way regardless of the manner in which messages are received.

ChannelName always reflects the name of the associated channel.

ConsumerTag reflects the consumer tag associated with the consumer that caused the server to push the message to the class. (ConsumerTag is always empty for messages pulled from the server by RetrieveMessage since no consumers are involved.)

DeliveryTag reflects the server-assigned, channel-specific delivery tag number for the incoming message.

Redelivered reflects whether the server is redelivering a message that is has delivered previously.

ExchangeName reflects the name of the exchange to which the incoming message was originally published. (If the message was originally published to the server's default exchange, whose name is always the empty string, ExchangeName will also be empty.)

RoutingKey reflects the routing key that the message was originally published with.

MessageCount is always -1 when this event fires due to a message being pushed to the class by the server. When this event fires as a result of RetrieveMessage being called, MessageCount reflects the number of messages still available in the queue the class tried to pull a message from (even if there were no messages available to pull).

The Accept parameter can be set to control how the class responds to the incoming message, if it needs to be acknowledged (if the message doesn't need to be acknowledged, the value set to the Accept parameter is ignored). Valid values are:

0 - default: Accept the message; send a positive acknowledgment.
1: Silently accept the message; don't send any acknowledgment.
2: Accept the message; send a cumulative positive acknowledgment coving this, and all previously unacknowledged, messages.
3: Reject the message; send a negative acknowledgment for it, and instruct the server not to return it to the queue.
4: Reject the message; send a negative acknowledgment for it, and instruct the server to return it to the queue.

If the RabbitMQCompatible configuration setting is enabled, then the NackMultiple configuration setting can be used to control whether the two "reject" options (3 and 4) should function as cumulative or singular negative acknowledgements. By default NackMultiple is disabled, and all negative acknowledgements are singular.

If the value provided for the Accept parameter isn't one of those described above, the default (0) will be used instead.

MessageOut Event (AMQPClassic Class)

Fires when a message is published.

Syntax

public class DefaultAMQPClassicEventListener implements AMQPClassicEventListener {
  ...
  public void messageOut(AMQPClassicMessageOutEvent e) {}
  ...
}

public class AMQPClassicMessageOutEvent {
  public String channelName;
  public String exchangeName;
  public String routingKey;
  public String messageId;
  public long deliveryTag;
  public boolean accepted;
}

Remarks

This event fires anytime a message is published; or after an outgoing message has been acknowledged by the server, if the channel it was published on is in "publish confirmations" mode.

ChannelName reflects the name of the channel the message was published on.

ExchangeName reflects the name of the exchange the message was published to. (If the message was published to the server's default exchange, whose name is always the empty string, ExchangeName will also be empty.)

RoutingKey reflects the routing key that the message was published with.

MessageId reflects the message's unique Id, if one was set.

DeliveryTag reflects the channel-specific delivery tag number for the message. (Note that this is only populated for messages published on a channel in "publish confirmations" mode; otherwise it will be set to -1.)

Accepted indicates whether the server published back a positive True or negative False acknowledgment for the outgoing message. Note that this is only valid for messages published on a channel in "publish confirmations" mode; Accepted will always be True messages published on a channel in normal or transaction mode.

Refer to EnablePublishConfirms for more information about channels in "publish confirmations" mode.

MessageReturned Event (AMQPClassic Class)

Fires if a previously published message is returned by the server due to it being undeliverable.

Syntax

public class DefaultAMQPClassicEventListener implements AMQPClassicEventListener {
  ...
  public void messageReturned(AMQPClassicMessageReturnedEvent e) {}
  ...
}

public class AMQPClassicMessageReturnedEvent {
  public String channelName;
  public int replyCode;
  public String replyText;
  public String exchangeName;
  public String routingKey;
}

Remarks

This event fires if the server returns a previously published message because it could not deliver it. Typically, messages are only undeliverable in one of the following situations:

The message was originally published with the Mandatory option enabled, but there were no queues it could be routed to.
The message was originally published with the Immediate option enabled, but there were no consumers it could be delivered to immediately on any queue it was routed to (or there were no queues it could be routed to).

The ReceivedMessage property will be populated with the returned message.

ChannelName reflects the name of the channel the message was originally published on.

ReplyCode will be an AMQP error code that indicates the reason why the message was returned. (Tip: The AMQPClassic class's Error Codes page includes the various AMQP error codes.)

ReplyText will be a message with further details about why the message was returned.

ExchangeName reflects the name of the exchange to which the message was originally published. (If the message was originally published to the server's default exchange, whose name is always the empty string, ExchangeName will also be empty.)

RoutingKey reflects the routing key that the message was originally published with.

SSLServerAuthentication Event (AMQPClassic Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultAMQPClassicEventListener implements AMQPClassicEventListener {
  ...
  public void SSLServerAuthentication(AMQPClassicSSLServerAuthenticationEvent e) {}
  ...
}

public class AMQPClassicSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept; //read-write
}

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 (AMQPClassic Class)

Fired when secure connection progress messages are available.

Syntax

public class DefaultAMQPClassicEventListener implements AMQPClassicEventListener {
  ...
  public void SSLStatus(AMQPClassicSSLStatusEvent e) {}
  ...
}

public class AMQPClassicSSLStatusEvent {
  public String message;
}

Remarks

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

AMQPCChannel Type

Represents an AMQP 0.9.1 channel.

Remarks

This type represents an AMQP 0.9.1 channel.

The following fields are available:

Mode

Name

ReadyToSend

Fields

Accept
boolean (read-only)
Default Value: True

Whether the channel is currently accepting new messages from the server.

This field reflects whether the channel is currently accepting new messages from the server. When the channel is created, this field is True by default.

The SetChannelAccept method can be used to disable and re-enable message acceptance at any time; refer to that method for more information.

Mode
int (read-only)
Default Value: 0

What mode the channel is operating in.

This field reflects what mode the channel is operating in. Possible values are:

cmtNormal (0 - default): Normal mode.
cmtTransactional (1): Transaction mode.
cmtPublishConfirms (2): Publish confirmations mode.

All channels are in normal mode when they are created; there's nothing special about a channel in normal mode.

Channels can be put in transaction mode using the EnableTransactionMode method. While a channel is in transaction mode, all messages published and acknowledgements sent over it will be part of a transaction, and the server will wait to process them until the transaction is either committed or rolled back.

Channels can be put in publish confirmations mode using the EnablePublishConfirms method. While a channel is in publish confirmations mode, the server will acknowledge each message published by the class. The class will wait to fire the MessageOut event until it receives this acknowledgment. (Note that this mode is only available when the RabbitMQCompatible configuration setting is enabled.)

Note: Switching a channel to transaction or publish confirmations mode is a permanent action; the channel will then remain in that mode for the remainder of its lifetime.

Name
String (read-only)
Default Value: ""

The name of the channel.

This field reflects the name of the channel.

ReadyToSend
boolean (read-only)
Default Value: True

Whether the channel is ready to send a message.

This field reflects whether the channel is currently ready to send a message or not.

Constructors

public AMQPCChannel();

AMQPCMessage Type

Represents an AMQP 0.9.1 message.

Remarks

This type represents an AMQP 0.9.1 message.

The following fields are available:

Fields

AppId
String
Default Value: ""

The Id of the application that created the message.

This field holds the Id of the application that created the message. It may be empty if the message does not have an application Id set.

This value must be specified as a string no longer than 255 characters.

Body
String
Default Value: ""

The message body.

This field holds the body of the message. It may be empty.

BodyB
byte[]
Default Value: ""

The message body.

This field holds the body of the message. It may be empty.

ChannelName
String (read-only)
Default Value: ""

The name of the channel the message is associated with.

This field reflects the name of the channel which the message is associated with; it is populated automatically by the class.

ContentEncoding
String
Default Value: ""

The content encoding of the message's body.

This field holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set.

This value must be specified as a string no longer than 255 characters.

ContentType
String
Default Value: ""

The content type (MIME type) of the message's body.

This field holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set.

This value must be specified as a string no longer than 255 characters.

CorrelationId
String
Default Value: ""

The correlation Id of the message.

This field holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set.

This value must be specified as a string no longer than 255 characters.

DeliveryMode
int
Default Value: 0

The delivery mode of the message.

This field holds the delivery mode of the message; possible values are:

0: Unspecified.
1: Non-persistent; the message may be lost if the server encounters an error.
2: Persistent; the message will not be lost, even in case of server errors.

The default is 0, which indicates that the message does not have an explicit delivery mode set.

Expiration
String
Default Value: ""

The time-to-live value for this message.

This field specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL.

Headers
String
Default Value: ""

Headers associated with the message.

This field holds additional Headers associated with the message. It may be empty if the message does not have any headers set.

This field must be specified as a JSON object containing name-type-value tuples; for example:

[
  { "name": "Header1", "type": "long", "value": 12345678901234 },
  { "name": "Header2", "type": "boolean", "value": "false" },
  { "name": "Header3", "type": "string", "value": "This is a test." }
]

All "name" values must be ASCII strings that:

Start with an ASCII letter, $, or $ character.
Only contain ASCII letters, digits, underscores, $, and $ characters.
Are unique among their siblings.
Are no longer than 128 characters.

The following table describes all valid "type" values, and how to format the "value" field for each:


JSON Value Type	Description	Value Format
`boolean`	Boolean	"True" or "False"
`byte`	Byte	-128 to 127
`ubyte`	Unsigned byte	0 to 255
`short`	Short	-32768 to 32767
`ushort`	Unsigned short	0 to 65535
`int`	Integer	-2147483648 to 2147483647
`uint`	Unsigned integer	0 to 4294967295
`long`	Long	-9223372036854775808 to 9223372036854775807
`ulong`	Unsigned long	0 to 18446744073709551615
`float`	Float	IEEE 754 32-bit floating point number
`double`	Double	IEEE 754 64-bit floating point number
`decimal`	Decimal	Hex-encoded byte string
`sstring`	Short string	UTF-8 string data, limited to 255 bytes; may not contain null bytes (`\0`)
`string`	String	String data
`array`	Array	JSON array of type-value pairs
`timestamp`	Timestamp	Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC)
`table`	Table	JSON object containing name-type-value tuples
`null`	Null	N/A (Value is ignored)

Note: The ulong and sstring value types are not supported when the RabbitMQCompatible configuration setting is enabled.

Headers of the table type should be specified in the same manner as shown above, while headers of the array type should be specified as a JSON array of type-value pairs; for example:

[
  { "type": "int", "value": 23 },
  { "type": "int", "value": -52 },
  { "type": "int", "value": 153325 }
]

Nesting and mixing multiple levels of arrays and tables is allowed.

MessageId
String
Default Value: ""

The unique Id of the message.

This field holds the unique Id of the message. It may be empty if the message does not have a unique Id.

This value must be specified as a string no longer than 255 characters.

Priority
int
Default Value: 0

The priority of the message.

This field holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent.

ReplyTo
String
Default Value: ""

The address to send replies to for the message.

This field specifies the address to send replies to for the message. It may be empty if the message does not have a specific reply-to address set.

This value must be specified as a string no longer than 255 characters.

Timestamp
long
Default Value: 0

The message's timestamp.

This field holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set.

Type
String
Default Value: ""

The message's type.

This field holds the type of the message. It may be empty if the message does not have a type set.

This value must be specified as a string no longer than 255 characters.

UserId
String
Default Value: ""

The identity of the user responsible for producing the message.

This field specifies the identity of the user responsible for producing the message. It may be empty if no specific user was responsible for creating the message.

A message's user Id may be used for verification or authentication by the server and/or the final consumer.

This value must be specified as a string no longer than 255 characters.

Constructors

public AMQPCMessage();

AMQPCTableField Type

Represents an AMQP 0.9.1 table field.

Remarks

This type represents an AMQP 0.9.1 table field.

The following fields are available:

Name

Value

ValueType

Fields

Name
String
Default Value: ""

The table field's name.

This field specifies the table field's name. The name must be an ASCII string that:

Starts with an ASCII letter, $, or $ character.
Only contains ASCII letters, digits, underscores, $, and $ characters.
Is unique among all sibling table field Names.
Is no longer than 128 characters.

Value
String
Default Value: ""

The table field's value.

This field specifies the table field's value.

ValueType
int
Default Value: 17

The table field's value type.

This field specifies the table field's value type (and thus, the format of the data in the Value field). Acceptable value types are:


Value Type	JSON Value Type	Description	Value Format
fvtBoolean (0)	`boolean`	Boolean	"True" or "False"
fvtByte (1)	`byte`	Byte	-128 to 127
fvtUbyte (2)	`ubyte`	Unsigned byte	0 to 255
fvtShort (3)	`short`	Short	-32768 to 32767
fvtUshort (4)	`ushort`	Unsigned short	0 to 65535
fvtInt (5)	`int`	Integer	-2147483648 to 2147483647
fvtUint (6)	`uint`	Unsigned integer	0 to 4294967295
fvtLong (7)	`long`	Long	-9223372036854775808 to 9223372036854775807
fvtUlong (8)	`ulong`	Unsigned long	0 to 18446744073709551615
fvtFloat (9)	`float`	Float	IEEE 754 32-bit floating point number
fvtDouble (10)	`double`	Double	IEEE 754 64-bit floating point number
fvtDecimal (11)	`decimal`	Decimal	Hex-encoded byte string
fvtSstring (12)	`sstring`	Short string	UTF-8 string data, limited to 255 bytes; may not contain null bytes (`\0`)
fvtString (13)	`string`	String	String data
fvtArray (14)	`array`	Array	JSON array of type-value pairs
fvtTimestamp (15)	`timestamp`	Timestamp	Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC)
fvtTable (16)	`table`	Table	JSON object containing name-type-value tuples
fvtNull (17 - default)	`null`	Null	N/A (Value is ignored)

Note: The fvtUlong (8) and fvtSstring (12) value types are not supported when the RabbitMQCompatible configuration setting is enabled.

For the fvtArray (14) value type, the Value should be specified as a JSON array of type-value pairs; for example:

[
  { "type": "int", "value": 23 },
  { "type": "int", "value": -52 },
  { "type": "int", "value": 153325 }
]

For the fvtTable (16) value type, the Value should be specified as a JSON object containing name-type-value tuples; for example:

{
  { "name": "Test1", "type": "long", "value": 12345678901234 },
  { "name": "Test2", "type": "boolean", "value": "false" },
  { "name": "Test3", "type": "string", "value": "This is a test." }
}

Notes regarding fvtArray (14) and fvtTable (16) type Values:

All "type" fields in the JSON content must be set to one of the value types in the table above.
For fvtTable (16) type Values, all "name" fields must adhere to the rules described by the Key documentation.
Nesting and mixing multiple levels of arrays and tables in the JSON is allowed.

Constructors

public AMQPCTableField();

public AMQPCTableField( name,  value,  valueType);

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.

The following fields are available:

Fields

EffectiveDate
String (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
String (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
String (read-only)
Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
String (read-only)
Default Value: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
String (read-only)
Default Value: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
String (read-only)
Default Value: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
String (read-only)
Default Value: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

KeyPassword
String
Default Value: ""

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. This field can be used to read such password-protected private keys.

Note: This property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey.

PrivateKey
String (read-only)
Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
boolean (read-only)
Default Value: False

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
String (read-only)
Default Value: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
String (read-only)
Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
String (read-only)
Default Value: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
String (read-only)
Default Value: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
String (read-only)
Default Value: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
String
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StoreB
byte[]
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

StorePassword
String
Default Value: ""

If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.

StoreType
int
Default Value: 0

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
String (read-only)
Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
String (read-only)
Default Value: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
String (read-only)
Default Value: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
String (read-only)
Default Value: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
String (read-only)
Default Value: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
String (read-only)
Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
String
Default Value: ""

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, it must be quoted.

Encoded
String
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

EncodedB
byte[]
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

Constructors

public Certificate();

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

public Certificate( certificateFile);

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

public Certificate( encoded);

Parses Encoded as an X.509 public key.

public Certificate( storeType,  store,  storePassword,  subject);

StoreType identifies the type of certificate store to use. See 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 class 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). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

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 the 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.

public Certificate( storeType,  store,  storePassword,  encoded);

After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate( storeType,  store,  storePassword,  subject);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the class 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.

The following fields are available:

Fields

AutoDetect
boolean
Default Value: False

Whether to automatically detect and use firewall system settings, if available.

Connection information will first be obtained from Java system properties, such as http.proxyHost and https.proxyHost. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified.

If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems).

FirewallType
int
Default Value: 0

The type of firewall to connect through. The applicable values are as follows:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
String
Default Value: ""

The name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception.

Password
String
Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.

Port
int
Default Value: 0

The Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.

Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
String
Default Value: ""

A username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class throws an exception.

Constructors

public Firewall();

Config Settings (AMQPClassic Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

AMQPClassic Config Settings

AuthorizationIdentity: The value to use as the authorization identity when SASL authentication is used.

When AuthScheme is set to smSASLPlain you may use this setting to specify an authorization identity to be used when authenticating.

ConsumerTag: The consumer tag associated with the most recently created consumer.

Each time the Consume method is called to create a new consumer, the server will send back a confirmation which includes the consumer tag value for that consumer, and the class will update this setting's value accordingly.

It is possible to pass empty string for the ConsumerTag parameter when calling the Consume method, in which case the server will auto-generate a consumer tag.

Locale: The desired message locale to use.

This setting specifies the desired message locale, which will be compared to the server's list of supported message locales during the connection process. A connection attempt will fail if this setting is set to a locale not supported by the server. This setting cannot be changed while connected.

The default value is "en_US", which is supported by all AMQP 0.9.1 servers.

Locales: The message locales supported by the server.

After a connection attempt (regardless of its success) this setting will reflect the various message locales that the server supports.

The value of this setting is formatted as a space-separated list of message locales.

LogLevel: The level of detail that is logged.

This setting controls the level of detail that is logged through the Log event. Possible values are:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data is logged.
3 (Debug)	Debug data is logged.

MaxChannelCount: The maximum number of channels.

This setting specifies the maximum number of channels which can be opened. This setting cannot be changed while connected.

The default is 65535 (0xFFFF). Note that this value is negotiated during the connection process; if the value provided by the server is lower than the specified value, the server's value will be used instead (and this setting will be updated accordingly).

MaxFrameSize: The maximum frame size.

This setting specifies the maximum frame size (in bytes) that the class will accept. This setting cannot be changed while connected.

The default is 2147483647 (0x7FFFFFFF). Note that this value is negotiated during the connection process; if the value provided by the server is lower than the specified value, the server's value will be used instead (and this setting will be updated accordingly).

Mechanisms: The authentication mechanisms supported by the server.

After a connection attempt (regardless of its success) this setting will reflect the various authentication mechanisms that the server supports.

The value of this setting is formatted as a space-separated list of authentication mechanisms.

NackMultiple: Whether negative acknowledgments should be cumulative or not.

If the RabbitMQCompatible configuration setting is enabled, this setting controls whether the negative message acknowledgments the class sends based on the value of the MessageIn event's Accept parameter should be cumulative (True) or singular (False - default).

This setting does nothing if the RabbitMQCompatible configuration setting is disabled.

ProtocolVersion: The AMQP protocol version to conform to.

This setting can be queried to determine what AMQP protocol version the class conforms to.

Note: Currently this setting will always return "0.9.1", and cannot be changed. The AMQP class may be used instead of this one if AMQP 1.0 support is needed.

QueueConsumerCount: The consumer count associated with the most recently created (or verified) queue.

Each time the DeclareQueue method is called successfully (and with its NoWait parameter set to False), the server returns information about the queue in question, causing the class to update this setting with the number of consumers attached to that queue.

QueueName: The queue name associated with the most recently created (or verified) queue.

It is possible to pass empty string for the QueueName parameter when calling the DeclareQueue method to have the server create a new queue with an automatically generated name, which can then be retrieved by querying this setting.

RabbitMQCompatible: Whether to operate in a mode compatible with RabbitMQ.

This setting controls whether the class will operate in such a way as to be compatible with RabbitMQ. When enabled, the class complies with the parts of the RabbitMQ AMQP 0.9.1 Errata that are relevant to AMQP 0.9.1 client implementations, as well as offering additional features to support RabbitMQ-specific extensions to the AMQP 0.9.1 specification.

The default is True.

TCPClient Config Settings

CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer.

This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallListener: If true, the component binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class throws an exception.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting 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 multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting 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 multihomed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the class binds.

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

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

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

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

UseNTLMv2: Whether to use NTLM V2.

When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.

SSL Config Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

ReuseSSLSession: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the class is the same.

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception.

When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class throws an exception.

When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLContextProtocol: The protocol used when getting an SSLContext instance.

Possible values are SSL, SSLv2, SSLv3, TLS, and TLSv1. Use this configuration setting only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call.

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Note: This value must be set after SSLProvider is set.

Example values: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA"); Possible values when SSLProvider is set to Platform include the following:

SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
SSL_RSA_WITH_RC4_128_SHA
SSL_RSA_WITH_DES_CBC_SHA
SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
SSL_DH_anon_WITH_DES_CBC_SHA
SSL_RSA_EXPORT_WITH_RC4_40_MD5
SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
SSL_DHE_DSS_WITH_DES_CBC_SHA
SSL_RSA_WITH_NULL_MD5
SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
SSL_DHE_RSA_WITH_DES_CBC_SHA
SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
SSL_RSA_WITH_NULL_SHA
SSL_DH_anon_WITH_RC4_128_MD5
SSL_RSA_WITH_RC4_128_MD5
SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
SSL_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_NULL_SHA
TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended)
TLS_ECDH_anon_WITH_RC4_128_SHA
TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended)
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_KRB5_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_KRB5_EXPORT_WITH_RC4_40_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_RC4_128_SHA
TLS_ECDH_ECDSA_WITH_RC4_128_SHA
TLS_ECDH_anon_WITH_NULL_SHA
TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_NULL_SHA256
TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
TLS_KRB5_WITH_RC4_128_MD5
TLS_ECDHE_ECDSA_WITH_NULL_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_RC4_128_SHA
TLS_EMPTY_RENEGOTIATION_INFO_SCSV
TLS_KRB5_WITH_3DES_EDE_CBC_MD5
TLS_KRB5_WITH_RC4_128_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_NULL_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_KRB5_WITH_DES_CBC_MD5
TLS_KRB5_EXPORT_WITH_RC4_40_MD5
TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
TLS_ECDH_anon_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_KRB5_WITH_DES_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_NULL_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA

Possible values when SSLProvider is set to Internal include the following:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

The platform provider is available only on Windows 11/Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

Note: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLServerCACerts: A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLTrustManagerFactoryAlgorithm: The algorithm to be used to create a TrustManager through TrustManagerFactory.

Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call.

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class throws an exception.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable: Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseDaemonThreads: Whether threads created by the class are daemon threads.

If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

UseFIPSCompliantAPI: Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

The Java edition requires installation of the FIPS-certified Bouncy Castle library regardless of the target operating system. This can be downloaded from https://www.bouncycastle.org/fips-java/. Only the "Provider" library is needed. The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;

The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode:

System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider());

When UseFIPSCompliantAPI is true, Secure Sockets Layer (SSL)-enabled classes can optionally be configured to use the Transport Layer Security (TLS) Bouncy Castle library. When SSLProvider is set to sslpAutomatic (default) or sslpInternal, an internal TLS implementation is used, but all cryptographic operations are offloaded to the Bouncy Castle FIPS provider to achieve FIPS-compliant operation. If SSLProvider is set to sslpPlatform, the Bouncy Castle JSSE will be used in place of the internal TLS implementation.

To enable the use of the Bouncy Castle JSSE take the following steps in addition to the steps above. Both the Bouncy Castle FIPS provider and the Bouncy Castle JSSE must be configured to use the Bouncy Castle TLS library in FIPS mode. Obtain the Bouncy Castle TLS library from https://www.bouncycastle.org/fips-java/. The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; //required to use BCJSSE when SSLProvider is set to sslpPlatform import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider;

The Bouncy Castle provider must be added as a valid provider and also must be configured to operate in FIPS mode:

System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider()); //required to use BCJSSE when SSLProvider is set to sslpPlatform Security.addProvider(new BouncyCastleJsseProvider("fips:BCFIPS")); //optional - configure logging level of BCJSSE Logger.getLogger("org.bouncycastle.jsse").setLevel(java.util.logging.Level.OFF); //configure the class to use BCJSSE component.setSSLProvider(1); //platform component.config("UseFIPSCompliantAPI=true"); Note: TLS 1.3 support requires the Bouncy Castle TLS library version 1.0.14 or later.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the FIPS 140-2 Compliance article.

Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (AMQPClassic Class)

AMQPClassic Errors

311	AMQP Channel Error `content-too-large`: Content too large.
312	AMQP Channel Error `no-route`: Cannot deliver message published with "mandatory" flag set; message cannot be routed to any queue.
313	AMQP Channel Error `no-consumers`: Cannot deliver message published with "immediate" flag set; all possible queues are either non-empty or have no consumers.
320	AMQP Connection Error `connection-forced`: Connection forced to close.
402	AMQP Connection Error `invalid-path`: Invalid virtual host path specified.
403	AMQP Channel Error `access-refused`: Attempted to work with a server entity (exchange, queue, etc.) without necessary permissions.
404	AMQP Channel Error `not-found`: Attempted to work with a server entity (exchange, queue, etc.) that does not exist.
405	AMQP Channel Error `resource-locked`: Attempted to work with a server entity (exchange, queue, etc.) that is currently locked by another client.
406	AMQP Channel Error `precondition-failed`: Request failed due to one or more precondition failures.
501	AMQP Connection Error `frame-error`: Server received an AMQP frame that it could not decode.
502	AMQP Connection Error `syntax-error`: Server received an AMQP frame that contained illegal values for one or more fields.
503	AMQP Connection Error `command-invalid`: Server received an invalid sequence of frame, attempting to perform an invalid operation.
504	AMQP Connection Error `channel-error`: Attempted to work with a channel that does not exist (or was not opened correctly).
505	AMQP Connection Error `unexpected-frame`: Server received a frame that was unexpected, typically with regards to the content header and body.
506	AMQP Connection Error `resource-error`: Server could not complete the request due to insufficient resources.
530	AMQP Connection Error `not-allowed`: Attempted to work with some server entity (exchange, queue, etc.) in a manner that is not allowed.
540	AMQP Connection Error `not-implemented`: Requested an operation not supported by the server.
541	AMQP Connection Error `internal-error`: The server encountered an internal error while attempting to process the request.
600	General AMQP protocol error. Refer to the error message for more information.
601	Cannot open another channel.
602	Cannot modify message data.
603	Cannot publish message on inactive channel.
604	Action not supported.
606	Cannot modify configuration setting.

TCPClient Errors

100	You cannot change the RemotePort at this time. A connection is in progress.
101	You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102	The RemoteHost address is invalid (0.0.0.0).
104	Already connected. If you want to reconnect, close the current connection first.
106	You cannot change the LocalPort at this time. A connection is in progress.
107	You cannot change the LocalHost at this time. A connection is in progress.
112	You cannot change MaxLineLength at this time. A connection is in progress.
116	RemotePort cannot be zero. Please specify a valid service port number.
117	You cannot change the UseConnection option while the class is active.
135	Operation would block.
201	Timeout.
211	Action impossible in control's present state.
212	Action impossible while not connected.
213	Action impossible while listening.
301	Timeout.
303	Could not open file.
434	Unable to convert string to selected CodePage.
1105	Already connecting. If you want to reconnect, close the current connection first.
1117	You need to connect first.
1119	You cannot change the LocalHost at this time. A connection is in progress.
1120	Connection dropped by remote host.

SSL Errors

270	Cannot load specified security library.
271	Cannot open certificate store.
272	Cannot find specified certificate.
273	Cannot acquire security credentials.
274	Cannot find certificate chain.
275	Cannot verify certificate chain.
276	Error during handshake.
280	Error verifying certificate.
281	Could not find client certificate.
282	Could not find server certificate.
283	Error encrypting data.
284	Error decrypting data.

TCP/IP Errors

10004	[10004] Interrupted system call.
10009	[10009] Bad file number.
10013	[10013] Access denied.
10014	[10014] Bad address.
10022	[10022] Invalid argument.
10024	[10024] Too many open files.
10035	[10035] Operation would block.
10036	[10036] Operation now in progress.
10037	[10037] Operation already in progress.
10038	[10038] Socket operation on nonsocket.
10039	[10039] Destination address required.
10040	[10040] Message is too long.
10041	[10041] Protocol wrong type for socket.
10042	[10042] Bad protocol option.
10043	[10043] Protocol is not supported.
10044	[10044] Socket type is not supported.
10045	[10045] Operation is not supported on socket.
10046	[10046] Protocol family is not supported.
10047	[10047] Address family is not supported by protocol family.
10048	[10048] Address already in use.
10049	[10049] Cannot assign requested address.
10050	[10050] Network is down.
10051	[10051] Network is unreachable.
10052	[10052] Net dropped connection or reset.
10053	[10053] Software caused connection abort.
10054	[10054] Connection reset by peer.
10055	[10055] No buffer space available.
10056	[10056] Socket is already connected.
10057	[10057] Socket is not connected.
10058	[10058] Cannot send after socket shutdown.
10059	[10059] Too many references, cannot splice.
10060	[10060] Connection timed out.
10061	[10061] Connection refused.
10062	[10062] Too many levels of symbolic links.
10063	[10063] File name is too long.
10064	[10064] Host is down.
10065	[10065] No route to host.
10066	[10066] Directory is not empty
10067	[10067] Too many processes.
10068	[10068] Too many users.
10069	[10069] Disc Quota Exceeded.
10070	[10070] Stale NFS file handle.
10071	[10071] Too many levels of remote in path.
10091	[10091] Network subsystem is unavailable.
10092	[10092] WINSOCK DLL Version out of range.
10093	[10093] Winsock is not loaded yet.
11001	[11001] Host not found.
11002	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004	[11004] Valid name, no data record (check DNS setup).