AMQP Control
Properties Methods Events Config Settings Errors
An easy-to-use AMQP 1.0 client implementation.
Syntax
AMQP
Remarks
The AMQP control provides an easy-to-use AMQP 1.0 client implementation. The control supports both plaintext and TLS-enabled connections over TCP.
Connecting
AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions.The control implements all three layers of the AMQP 1.0 transport protocol, so the first step is to initiate the overall connection. Set the ContainerId property and call the ConnectTo method, passing it the server's hostname and port number.
Once connected, the next step is to create at least one session, which can be accomplished by using the CreateSession method. The control allows creating any number of sessions, up to the limit specified by the MaxSessionCount configuration setting.
Connecting and Creating a Session
amqp1.ContainerId = "testClient";
amqp1.ConnectTo("amqp.test-server.com", 5672);
amqp1.CreateSession("TestSession");
After creating a session, the next step is to create one or more links (which are created in the context of a session) so that messages can be sent and/or received. Links are unidirectional, so each one has a sender on one end and a receiver on the other.
The control can function both as a sender node (by opening sender links) and as a receiver node (by opening receiver links). But keep in mind that, since the control is implemented as an AMQP 1.0 client, it must be the one to open links (said another way, the control cannot accept any link requests made by other peers).
As with sessions, the control allows creating any number of links for each session, up to the limit specified by the MaxLinkCountPerSession configuration setting.
Creating Sender Links
To create a sender link, call the CreateSenderLink method, passing it the name of an existing session, a unique name for the link, and (if necessary in your environment) the name of a target for the receiver to use to ensure messages are routed correctly.The LinkReadyToSend event will fire when the newly created sender link is ready to send messages.
Creating a Sender Link
amqp1.OnLinkReadyToSend += (s, e) => {
Console.WriteLine("Link '" + e.LinkName + "' is ready to send messages!");
};
amqp1.CreateSenderLink("TestSession", "TestSenderLink", "TestTarget");
Sending Messages
To send a message, the first step is to set the Message* properties to the desired values.At minimum, the MessageValue and MessageValueType properties must be set. All other properties are optional, though specifying a unique value for MessageId is recommended. (If the GenerateMessageId configuration setting is enabled, the control will generate one automatically when the message is sent.)
Once the Message* properties have be assigned as desired, call the SendMessage method, passing it the name of an existing sender link on which the message should be sent.
The MessageOut event will be fired when the message has been sent (and acknowledged, if MessageSettled was set to false). The MessageOutcome event may also fire, if necessary, once the receiver reports the outcome of the message.
Refer to SendMessage, MessageOut, and MessageOutcome for more information.
Sending a Message
amqp1.OnMessageOut += (s, e) => {
Console.WriteLine("Message with Id '" + e.MessageId + "' has been sent on link '" + e.LinkName + "'.");
};
amqp1.Message.MessageId = "TestMessageId";
amqp1.Message.Value = "Hello, world!";
amqp1.Message.ValueType = AMQPValueTypes.mvtString;
amqp1.SendMessage("TestSenderLink");
The ResetMessage method can be used to reset the Message* properties to their default values.
Sending Composite AMQP Data
The AMQP 1.0 protocol's data model includes the concept of "composite data". Composite data is comprised of one or more type-value pairs (including data structure types), plus a descriptor that describes what the overall data represents.The control supports sending composite AMQP data in a message through the use of JSON with a well-defined schema. Refer to the SendMessage method's documentation for more information and examples.
Creating Receiver Links
Receiver links can operate in one of two receive modes: automatic, where the control will work to ensure that messages are received as soon as they are available; and fetch-based, where the control will only "fetch" a new message when explicitly instructed to.The ReceiveMode property controls which receive mode newly-created receiver links will use; refer to its documentation for more information.
After ensuring that ReceiveMode is set as desired, call CreateReceiverLink, passing it the name of an existing session, a unique name for the link, and (if necessary in your environment) the name of a source for the sender to route the link creation request to.
Creating a Receiver Link
// Creating an automatic receiver link.
amqp1.ReceiveMode = AmqpReceiveModes.rmAutomatic;
amqp1.CreateReceiverLink("TestSession", "TestAutoReceiverLink", "TestSource1");
// Creating a fetch-based receiver link.
amqp1.ReceiveMode = AmqpReceiveModes.rmFetch;
amqp1.CreateReceiverLink("TestSession", "TestFetchReceiverLink", "TestSource2");
Receiving Messages
For receiver links created in automatic receive mode (the default), messages are received automatically.For receiver links created in fetch-based mode, the control will attempt to "fetch" a message each time the FetchMessage method is called (optionally timing out after a time, if FetchTimeout is non-zero). When calling FetchMessage, pass it the name of a fetch-based receiver link.
Regardless of whether a messages is received automatically or fetched, any incoming message will cause the control to fire the MessageIn event and update the ReceivedMessage* properties.
When the MessageIn event fires, its State event parameter can be used to specify the outcome of the message, which the control will then transmit back to the sender (as well as self-report by firing the MessageOutcome event). Refer to MessageIn for more information.
Receiving a Message
// For automatic receiver links, only the event handler is necessary.
amqp1.OnMessageIn += (s, e) => {
Console.WriteLine("Message with Id '" + e.MessageId + "' has been received on link '" + e.LinkName + "'. Value:");
Console.WriteLine(amqp1.ReceivedMessage.Value);
// The message state is already set to the "Accepted" outcome by default, but we'll set it again
// for the purpose of this example.
e.State = 0; // 0 = Accepted.
};
// For fetch-based links, it's also necessary to call FetchMessage(). It is recommended that the
// FetchTimeout property be set to a non-zero value (60 seconds is the default) so that the fetch
// request will eventually time out if the sender doesn't have any messages available to deliver.
amqp1.FetchTimeout = 60;
amqp1.FetchMessage("TestFetchReceiverLink");
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
AuthScheme | The authentication scheme to use when connecting. |
Connected | This property triggers a connection or disconnection. |
ContainerId | The container Id the control should advertise when connecting. |
FetchTimeout | How long the control should wait for a message to be received after FetchMessage is called. |
FirewallAutoDetect | This property tells the control whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the transmission control protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
IdleTimeout | The maximum period of inactivity the control will allow before disconnecting. |
IncomingMessageCount | The number of records in the IncomingMessage arrays. |
IncomingMessageAbsoluteExpiryTime | The absolute time at which this message should be considered expired. |
IncomingMessageContentEncoding | The content encoding of this message's data. |
IncomingMessageContentType | The content type of this message's data. |
IncomingMessageCorrelationId | The correlation Id of this message. |
IncomingMessageCreationTime | The creation time of this message. |
IncomingMessageDeliveryCount | How many previous attempts there have been to deliver this message. |
IncomingMessageDurable | Whether this message is durable. |
IncomingMessageFirstAcquirer | Whether this message may have been acquired by other links previously. |
IncomingMessageGroupId | The Id of the group this message belongs to. |
IncomingMessageGroupSequence | The position of this message within its group. |
IncomingMessageLinkName | The name of the link this message is associated with. |
IncomingMessageId | The unique Id of this message. |
IncomingMessagePriority | The priority of this message. |
IncomingMessageReplyTo | The address of the node to send replies to for this message. |
IncomingMessageReplyToGroupId | The Id of the group to send replies to for this message. |
IncomingMessageSettled | Whether this message is settled. |
IncomingMessageSubject | The subject of this message. |
IncomingMessageTo | The address of the node which this message is intended for. |
IncomingMessageTTL | The time-to-live value for this message. |
IncomingMessageUserId | The identity of the user responsible for producing this message. |
IncomingMessageValue | This message's value. |
IncomingMessageValueType | This message's value data type. |
LinkCount | The number of records in the Link arrays. |
LinkAvailable | The number of messages which this link's sender could send if it had credit for them. |
LinkChannelName | The channel name this link is using. |
LinkCredit | The amount of credit currently available to this link's sender. |
LinkDeliveryCount | The current delivery count value for this link. |
LinkName | This link's name. |
LinkReadyToSend | Whether this link is ready to send a message. |
LinkReceiveMode | The receive mode this link is operating in. |
LinkRole | The control's role on this link. |
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 control binds. |
MessageAbsoluteExpiryTime | The absolute time at which this message should be considered expired. |
MessageContentEncoding | The content encoding of this message's data. |
MessageContentType | The content type of this message's data. |
MessageCorrelationId | The correlation Id of this message. |
MessageCreationTime | The creation time of this message. |
MessageDeliveryCount | How many previous attempts there have been to deliver this message. |
MessageDurable | Whether this message is durable. |
MessageFirstAcquirer | Whether this message may have been acquired by other links previously. |
MessageGroupId | The Id of the group this message belongs to. |
MessageGroupSequence | The position of this message within its group. |
MessageLinkName | The name of the link this message is associated with. |
MessageId | The unique Id of this message. |
MessagePriority | The priority of this message. |
MessageReplyTo | The address of the node to send replies to for this message. |
MessageReplyToGroupId | The Id of the group to send replies to for this message. |
MessageSettled | Whether this message is settled. |
MessageSubject | The subject of this message. |
MessageTo | The address of the node which this message is intended for. |
MessageTTL | The time-to-live value for this message. |
MessageUserId | The identity of the user responsible for producing this message. |
MessageValue | This message's value. |
MessageValueType | This message's value data type. |
OutgoingMessageCount | The number of records in the OutgoingMessage arrays. |
OutgoingMessageAbsoluteExpiryTime | The absolute time at which this message should be considered expired. |
OutgoingMessageContentEncoding | The content encoding of this message's data. |
OutgoingMessageContentType | The content type of this message's data. |
OutgoingMessageCorrelationId | The correlation Id of this message. |
OutgoingMessageCreationTime | The creation time of this message. |
OutgoingMessageDeliveryCount | How many previous attempts there have been to deliver this message. |
OutgoingMessageDurable | Whether this message is durable. |
OutgoingMessageFirstAcquirer | Whether this message may have been acquired by other links previously. |
OutgoingMessageGroupId | The Id of the group this message belongs to. |
OutgoingMessageGroupSequence | The position of this message within its group. |
OutgoingMessageLinkName | The name of the link this message is associated with. |
OutgoingMessageId | The unique Id of this message. |
OutgoingMessagePriority | The priority of this message. |
OutgoingMessageReplyTo | The address of the node to send replies to for this message. |
OutgoingMessageReplyToGroupId | The Id of the group to send replies to for this message. |
OutgoingMessageSettled | Whether this message is settled. |
OutgoingMessageSubject | The subject of this message. |
OutgoingMessageTo | The address of the node which this message is intended for. |
OutgoingMessageTTL | The time-to-live value for this message. |
OutgoingMessageUserId | The identity of the user responsible for producing this message. |
OutgoingMessageValue | This message's value. |
OutgoingMessageValueType | This message's value data type. |
Password | A password to use for SASL authentication. |
ReadyToSend | Indicates whether the control is ready to send data. |
ReceivedMessageAbsoluteExpiryTime | The absolute time at which this message should be considered expired. |
ReceivedMessageContentEncoding | The content encoding of this message's data. |
ReceivedMessageContentType | The content type of this message's data. |
ReceivedMessageCorrelationId | The correlation Id of this message. |
ReceivedMessageCreationTime | The creation time of this message. |
ReceivedMessageDeliveryCount | How many previous attempts there have been to deliver this message. |
ReceivedMessageDurable | Whether this message is durable. |
ReceivedMessageFirstAcquirer | Whether this message may have been acquired by other links previously. |
ReceivedMessageGroupId | The Id of the group this message belongs to. |
ReceivedMessageGroupSequence | The position of this message within its group. |
ReceivedMessageLinkName | The name of the link this message is associated with. |
ReceivedMessageId | The unique Id of this message. |
ReceivedMessagePriority | The priority of this message. |
ReceivedMessageReplyTo | The address of the node to send replies to for this message. |
ReceivedMessageReplyToGroupId | The Id of the group to send replies to for this message. |
ReceivedMessageSettled | Whether this message is settled. |
ReceivedMessageSubject | The subject of this message. |
ReceivedMessageTo | The address of the node which this message is intended for. |
ReceivedMessageTTL | The time-to-live value for this message. |
ReceivedMessageUserId | The identity of the user responsible for producing this message. |
ReceivedMessageValue | This message's value. |
ReceivedMessageValueType | This message's value data type. |
ReceiveMode | Controls what mode new receiver links are created with. |
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. |
SessionCount | The number of records in the Session arrays. |
SessionIncomingWindow | The incoming window size of this session. |
SessionName | The name of this session. |
SessionOutgoingWindow | The outgoing window size of this session. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLEnabled | Whether TLS/SSL is enabled. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
Timeout | A timeout for the control. |
User | A username to use for SASL authentication. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
CloseLink | Closes a link. |
CloseSession | Closes a session. |
Config | Sets or retrieves a configuration setting. |
Connect | This method connects to a remote host. |
ConnectTo | This method connects to a remote host. |
CreateReceiverLink | Creates a new receiver link with the given name on the specified session. |
CreateSenderLink | Creates a new sender link with the given name on the specified session. |
CreateSession | Creates a new session with the given name. |
Disconnect | This method disconnects from the remote host. |
DoEvents | Processes events from the internal message queue. |
FetchMessage | Fetches a single message over the specified receiver link. |
Interrupt | This method interrupts the current action. |
Reset | Reset the control. |
ResetMessage | Resets the Message properties. |
SendMessage | Sends a message on the specified link. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
Connected | This event is fired immediately after a connection completes (or fails). |
ConnectionStatus | This event is fired to indicate changes in the connection state. |
Disconnected | This event is fired when a connection is closed. |
Error | Fired when information is available about errors during data delivery. |
LinkReadyToSend | Fires when a sender link is ready to send messages. |
Log | Fires once for each log message. |
MessageIn | Fires when the control receives a message. |
MessageOut | Fires when the control sends a message. |
MessageOutcome | Fires when a message's outcome is available. |
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 control with short descriptions. Click on the links for further details.
AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
BinaryMessageEncoding | Sets the expected message encoding to use for decoding binary messages. |
DecodeBinaryMessage | Decodes binary message payloads. |
DefaultCredit | The amount of credit to create new receiver links with. |
DefaultCreditThreshold | The credit threshold to create new receiver links with. |
DefaultIncomingWindow | The incoming window size to create new sessions with. |
DefaultOutgoingWindow | The outgoing window size to create new sessions with. |
DefaultReceiverSettleMode | The receiver settle mode to create new links with. |
DefaultSenderSettleMode | The sender settle mode to create new links with. |
GenerateMessageId | Whether a unique message Id should be automatically generated when sending a message. |
LogLevel | The level of detail that is logged. |
MaxFrameSize | The maximum frame size. |
MaxLinkCountPerSession | The maximum number of links to restrict new sessions to. |
MaxMessageSize | The maximum message size to restrict new links to. |
MaxSessionCount | The maximum number of sessions. |
ModifiedDeliveryFailed | Whether the sender should treat this transfer as an unsuccessful delivery attempt. |
ModifiedMessageAnnotations | The message annotations that the sender should merge into those already on the message. |
ModifiedUndeliverableHere | Whether the receiver has indicated that the sender should not attempt to redeliver the message. |
ProtocolVersion | The AMQP protocol version to conform to. |
RejectErrorCondition | The error condition included with a 'Rejected' delivery outcome. |
RejectErrorDescription | The error description included with a 'Rejected' delivery outcome. |
SenderSettleMode[LinkName] | Retrieves the negotiated sender settle mode for the specified link. |
SimplifiedJSONFormat | Whether to output simplified JSON where possible. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the control whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the control binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
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. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when 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. |
AuthScheme Property (AMQP Control)
The authentication scheme to use when connecting.
Syntax
amqpcontrol.AuthScheme[=integer]
Possible Values
smNone(0), smSASLAnonymous(1), smSASLPlain(2), smSASLExternal(3)
Default Value
2
Remarks
This property controls what authentication scheme the control 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.
Data Type
Integer
Connected Property (AMQP Control)
This property triggers a connection or disconnection.
Syntax
amqpcontrol.Connected[=boolean]
Default Value
False
Remarks
This property triggers a connection or disconnection. Setting this property to True makes the control attempt to connect to the host identified by the RemoteHost property. If successful, after the connection is achieved, the value of the property changes to True and the Connected event is fired.
Setting this property to False closes the connection. How and when the connection is closed is controlled by the Linger property.
Note: It is recommended to use the Connect or Disconnect method instead of setting this property.
This property is not available at design time.
Data Type
Boolean
ContainerId Property (AMQP Control)
The container Id the control should advertise when connecting.
Syntax
amqpcontrol.ContainerId[=string]
Default Value
""
Remarks
This property specifies the container Id that the control should advertise when it's connecting to the remote host.
In AMQP, the top-level organizational grouping is called a "container", and each container can contain zero or more "nodes", which are the actual entities which send and receive messages over links.
Since this control handles multiple layers of the AMQP transport protocol (the overall connection, the sessions in that connection, and the links attached to those sessions), it must be given a unique container Id.
Note: The container Id cannot be changed while connected.
This property is not available at design time.
Data Type
String
FetchTimeout Property (AMQP Control)
How long the control should wait for a message to be received after FetchMessage is called.
Syntax
amqpcontrol.FetchTimeout[=integer]
Default Value
60
Remarks
This property controls how long, in seconds, the control will wait for a message to be received after FetchMessage is called before timing out the request. If set to zero, the control will wait indefinitely.
Refer to FetchMessage for more information.
This property is not available at design time.
Data Type
Integer
FirewallAutoDetect Property (AMQP Control)
This property tells the control whether or not to automatically detect and use firewall system settings, if available.
Syntax
amqpcontrol.FirewallAutoDetect[=boolean]
Default Value
False
Remarks
This property tells the control whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (AMQP Control)
This property determines the type of firewall to connect through.
Syntax
amqpcontrol.FirewallType[=integer]
Possible Values
fwNone(0), fwTunnel(1), fwSOCKS4(2), fwSOCKS5(3), fwSOCKS4A(10)
Default Value
0
Remarks
This property determines 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. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (AMQP Control)
This property contains the name or IP address of firewall (optional).
Syntax
amqpcontrol.FirewallHost[=string]
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.
Data Type
String
FirewallPassword Property (AMQP Control)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
amqpcontrol.FirewallPassword[=string]
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.
Data Type
String
FirewallPort Property (AMQP Control)
This property contains the transmission control protocol (TCP) port for the firewall Host .
Syntax
amqpcontrol.FirewallPort[=integer]
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (AMQP Control)
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
amqpcontrol.FirewallUser[=string]
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.
Data Type
String
IdleTimeout Property (AMQP Control)
The maximum period of inactivity the control will allow before disconnecting.
Syntax
amqpcontrol.IdleTimeout[=integer]
Default Value
0
Remarks
This property controls how long, in seconds, the control will allow the connection to sit idle before it disconnects from the remote host.
This property may be set to 0 to prevent the control from ever closing the connection due to inactivity.
Note: The idle timeout cannot be changed while connected.
This property is not available at design time.
Data Type
Integer
IncomingMessageCount Property (AMQP Control)
The number of records in the IncomingMessage arrays.
Syntax
amqpcontrol.IncomingMessageCount
Default Value
0
Remarks
This property controls the size of the following arrays:
- IncomingMessageAbsoluteExpiryTime
- IncomingMessageContentEncoding
- IncomingMessageContentType
- IncomingMessageCorrelationId
- IncomingMessageCreationTime
- IncomingMessageDeliveryCount
- IncomingMessageDurable
- IncomingMessageFirstAcquirer
- IncomingMessageGroupId
- IncomingMessageGroupSequence
- IncomingMessageId
- IncomingMessageLinkName
- IncomingMessagePriority
- IncomingMessageReplyTo
- IncomingMessageReplyToGroupId
- IncomingMessageSettled
- IncomingMessageSubject
- IncomingMessageTo
- IncomingMessageTTL
- IncomingMessageUserId
- IncomingMessageValue
- IncomingMessageValueType
This property is read-only and not available at design time.
Data Type
Integer
IncomingMessageAbsoluteExpiryTime Property (AMQP Control)
The absolute time at which this message should be considered expired.
Syntax
amqpcontrol.IncomingMessageAbsoluteExpiryTime(IncomingMessageIndex)
Default Value
0
Remarks
The absolute time at which this message should be considered expired.
This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.
This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Long64
IncomingMessageContentEncoding Property (AMQP Control)
The content encoding of this message's data.
Syntax
amqpcontrol.IncomingMessageContentEncoding(IncomingMessageIndex)
Default Value
""
Remarks
The content encoding of this message's data.
This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.
When constructing a message for sending, this property is ignored if IncomingMessageValueType is not set to mvtBinary (16).
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessageContentType Property (AMQP Control)
The content type of this message's data.
Syntax
amqpcontrol.IncomingMessageContentType(IncomingMessageIndex)
Default Value
""
Remarks
The content type of this message's data.
This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.
When constructing a message for sending, this property is ignored if IncomingMessageValueType is not set to mvtBinary (16).
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessageCorrelationId Property (AMQP Control)
The correlation Id of this message.
Syntax
amqpcontrol.IncomingMessageCorrelationId(IncomingMessageIndex)
Default Value
""
Remarks
The correlation Id of this message.
This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessageCreationTime Property (AMQP Control)
The creation time of this message.
Syntax
amqpcontrol.IncomingMessageCreationTime(IncomingMessageIndex)
Default Value
0
Remarks
The creation time of this message.
This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.
This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Long64
IncomingMessageDeliveryCount Property (AMQP Control)
How many previous attempts there have been to deliver this message.
Syntax
amqpcontrol.IncomingMessageDeliveryCount(IncomingMessageIndex)
Default Value
0
Remarks
How many previous attempts there have been to deliver this message.
This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Long64
IncomingMessageDurable Property (AMQP Control)
Whether this message is durable.
Syntax
amqpcontrol.IncomingMessageDurable(IncomingMessageIndex)
Default Value
False
Remarks
Whether this message is durable.
This property specifies whether this message is durable or not.
If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Boolean
IncomingMessageFirstAcquirer Property (AMQP Control)
Whether this message may have been acquired by other links previously.
Syntax
amqpcontrol.IncomingMessageFirstAcquirer(IncomingMessageIndex)
Default Value
False
Remarks
Whether this message may have been acquired by other links previously.
This property specifies whether this message might have previously been acquired by other links.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Boolean
IncomingMessageGroupId Property (AMQP Control)
The Id of the group this message belongs to.
Syntax
amqpcontrol.IncomingMessageGroupId(IncomingMessageIndex)
Default Value
""
Remarks
The Id of the group this message belongs to.
This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessageGroupSequence Property (AMQP Control)
The position of this message within its group.
Syntax
amqpcontrol.IncomingMessageGroupSequence(IncomingMessageIndex)
Default Value
0
Remarks
The position of this message within its group.
This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Long64
IncomingMessageLinkName Property (AMQP Control)
The name of the link this message is associated with.
Syntax
amqpcontrol.IncomingMessageLinkName(IncomingMessageIndex)
Default Value
""
Remarks
The name of the link this message is associated with.
This property holds the name of the link which this message is being sent/was received on.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessageId Property (AMQP Control)
The unique Id of this message.
Syntax
amqpcontrol.IncomingMessageId(IncomingMessageIndex)
Default Value
""
Remarks
The unique Id of this message.
This property holds the unique Id of this message. It may be empty if this message does not have a unique Id.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessagePriority Property (AMQP Control)
The priority of this message.
Syntax
amqpcontrol.IncomingMessagePriority(IncomingMessageIndex)
Default Value
4
Remarks
The priority of this message.
This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Integer
IncomingMessageReplyTo Property (AMQP Control)
The address of the node to send replies to for this message.
Syntax
amqpcontrol.IncomingMessageReplyTo(IncomingMessageIndex)
Default Value
""
Remarks
The address of the node to send replies to for this message.
This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessageReplyToGroupId Property (AMQP Control)
The Id of the group to send replies to for this message.
Syntax
amqpcontrol.IncomingMessageReplyToGroupId(IncomingMessageIndex)
Default Value
""
Remarks
The Id of the group to send replies to for this message.
This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessageSettled Property (AMQP Control)
Whether this message is settled.
Syntax
amqpcontrol.IncomingMessageSettled(IncomingMessageIndex)
Default Value
True
Remarks
Whether this message is settled.
This property specifies whether this message is settled or not.
Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Boolean
IncomingMessageSubject Property (AMQP Control)
The subject of this message.
Syntax
amqpcontrol.IncomingMessageSubject(IncomingMessageIndex)
Default Value
""
Remarks
The subject of this message.
This property specifies the subject of this message. It may be empty if this message does not have a subject set.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessageTo Property (AMQP Control)
The address of the node which this message is intended for.
Syntax
amqpcontrol.IncomingMessageTo(IncomingMessageIndex)
Default Value
""
Remarks
The address of the node which this message is intended for.
This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessageTTL Property (AMQP Control)
The time-to-live value for this message.
Syntax
amqpcontrol.IncomingMessageTTL(IncomingMessageIndex)
Default Value
-1
Remarks
The time-to-live value for this message.
This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Long64
IncomingMessageUserId Property (AMQP Control)
The identity of the user responsible for producing this message.
Syntax
amqpcontrol.IncomingMessageUserId(IncomingMessageIndex)
Default Value
""
Remarks
The identity of the user responsible for producing this message.
This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message.
A message's user Id may be used for verification or authentication by intermediates and/or the final receiver.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessageValue Property (AMQP Control)
This message's value.
Syntax
amqpcontrol.IncomingMessageValue(IncomingMessageIndex)
Default Value
""
Remarks
This message's value.
This property specifies the value to send in this message. The IncomingMessageValueType property should be used to specify the data type of the value.
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
IncomingMessageValueType Property (AMQP Control)
This message's value data type.
Syntax
amqpcontrol.IncomingMessageValueType(IncomingMessageIndex)
Possible Values
mvtNull(0), mvtBoolean(1), mvtUbyte(2), mvtUshort(3), mvtUint(4), mvtUlong(5), mvtByte(6), mvtShort(7), mvtInt(8), mvtLong(9), mvtFloat(10), mvtDouble(11), mvtDecimal(12), mvtChar(13), mvtTimestamp(14), mvtUuid(15), mvtBinary(16), mvtString(17), mvtSymbol(18), mvtJson(19)
Default Value
0
Remarks
This message's value data type.
This property specifies the data type of this message's IncomingMessageValue.
The table below shows the possible value types, their descriptions, and how to format the data assigned to IncomingMessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).
Type | Description | Value Format |
mvtNull (0 - default) | Null | N/A (IncomingMessageValue is ignored) |
mvtBoolean (1) | Boolean | "True" or "False" |
mvtUbyte (2) | Unsigned byte | 0 to 255 |
mvtUshort (3) | Unsigned short | 0 to 65535 |
mvtUint (4) | Unsigned integer | 0 to 4294967295 |
mvtUlong (5) | Unsigned long | 0 to 18446744073709551615 |
mvtByte (6) | Byte | -128 to 127 |
mvtShort (7) | Short | -32768 to 32767 |
mvtInt (8) | Integer | -2147483648 to 2147483647 |
mvtLong (9) | Long | -9223372036854775808 to 9223372036854775807 |
mvtFloat (10) | Float | IEEE 754 32-bit floating point number |
mvtDouble (11) | Double | IEEE 754 64-bit floating point number |
mvtDecimal (12) | Decimal | Hex-encoded byte string |
mvtChar (13) | Char | Single character |
mvtTimestamp (14) | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). |
mvtUuid (15) | UUID | Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive) |
mvtBinary (16) | Binary data | Hex-encoded byte string |
mvtString (17) | String | String |
mvtSymbol (18) | Symbolic value | ASCII string |
mvtJson (19) | Composite data | Composite data JSON structured according to the schema shown in the SendMessage method's documentation |
The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Integer
LinkCount Property (AMQP Control)
The number of records in the Link arrays.
Syntax
amqpcontrol.LinkCount
Default Value
0
Remarks
This property controls the size of the following arrays:
- LinkAvailable
- LinkChannelName
- LinkCredit
- LinkDeliveryCount
- LinkName
- LinkReadyToSend
- LinkReceiveMode
- LinkRole
This property is read-only and not available at design time.
Data Type
Integer
LinkAvailable Property (AMQP Control)
The number of messages which this link's sender could send if it had credit for them.
Syntax
amqpcontrol.LinkAvailable(LinkIndex)
Default Value
0
Remarks
The number of messages which this link's sender could send if it had credit for them.
This property returns the number of messages which this link's sender has indicated that it could send if it had the credit to do so.
The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.
This property is read-only and not available at design time.
Data Type
Long64
LinkChannelName Property (AMQP Control)
The channel name this link is using.
Syntax
amqpcontrol.LinkChannelName(LinkIndex)
Default Value
""
Remarks
The channel name this link is using.
This property holds the channel name this link is using.
The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.
This property is read-only and not available at design time.
Data Type
String
LinkCredit Property (AMQP Control)
The amount of credit currently available to this link's sender.
Syntax
amqpcontrol.LinkCredit(LinkIndex)
Default Value
0
Remarks
The amount of credit currently available to this link's sender.
This property holds the amount of credit currently available to this link's sender. The sender on a link can only send messages if it has non-zero credit.
The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.
This property is read-only and not available at design time.
Data Type
Long64
LinkDeliveryCount Property (AMQP Control)
The current delivery count value for this link.
Syntax
amqpcontrol.LinkDeliveryCount(LinkIndex)
Default Value
0
Remarks
The current delivery count value for this link.
This property holds the current delivery count value for this link.
The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.
This property is read-only and not available at design time.
Data Type
Long64
LinkName Property (AMQP Control)
This link's name.
Syntax
amqpcontrol.LinkName(LinkIndex)
Default Value
""
Remarks
This link's name.
This property holds this link's name.
The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.
This property is read-only and not available at design time.
Data Type
String
LinkReadyToSend Property (AMQP Control)
Whether this link is ready to send a message.
Syntax
amqpcontrol.LinkReadyToSend(LinkIndex)
Default Value
False
Remarks
Whether this link is ready to send a message.
This property reflects whether this link is currently ready to send a message or not; it always returns False if LinkRole is lrReceiver (1).
The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.
This property is read-only and not available at design time.
Data Type
Boolean
LinkReceiveMode Property (AMQP Control)
The receive mode this link is operating in.
Syntax
amqpcontrol.LinkReceiveMode(LinkIndex)
Possible Values
lrmAutomatic(0), lrmFetch(1)
Default Value
0
Remarks
The receive mode this link is operating in.
This property reflects the receive mode which this link is operating in, if it is a receiver link. (For sender links, this property's value means nothing.) Values can be:
- lrmAutomatic - Messages will be received automatically
- lrmFetch - One message will be received after each call to the FetchMessage method.
Refer to ReceiveMode for more information.
The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.
This property is read-only and not available at design time.
Data Type
Integer
LinkRole Property (AMQP Control)
The control's role on this link.
Syntax
amqpcontrol.LinkRole(LinkIndex)
Possible Values
lrSender(0), lrReceiver(1)
Default Value
0
Remarks
The control's role on this link.
This property reflects which role the control is in for this link. Valid values are:
- lrSender (0)
- lrReceiver (1)
The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.
This property is read-only and not available at design time.
Data Type
Integer
LocalHost Property (AMQP Control)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
amqpcontrol.LocalHost[=string]
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.
If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
LocalPort Property (AMQP Control)
The TCP port in the local host where the control binds.
Syntax
amqpcontrol.LocalPort[=integer]
Default Value
0
Remarks
This property must be set before a connection is attempted. It instructs the control to bind to a specific port (or communication endpoint) in the local machine.
Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.
This property is useful when trying to connect to services that require a trusted port in the client side.
Data Type
Integer
MessageAbsoluteExpiryTime Property (AMQP Control)
The absolute time at which this message should be considered expired.
Syntax
amqpcontrol.MessageAbsoluteExpiryTime[=long64]
Default Value
0
Remarks
The absolute time at which this message should be considered expired.
This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.
This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).
This property is not available at design time.
Data Type
Long64
MessageContentEncoding Property (AMQP Control)
The content encoding of this message's data.
Syntax
amqpcontrol.MessageContentEncoding[=string]
Default Value
""
Remarks
The content encoding of this message's data.
This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.
When constructing a message for sending, this property is ignored if MessageValueType is not set to mvtBinary (16).
This property is not available at design time.
Data Type
String
MessageContentType Property (AMQP Control)
The content type of this message's data.
Syntax
amqpcontrol.MessageContentType[=string]
Default Value
""
Remarks
The content type of this message's data.
This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.
When constructing a message for sending, this property is ignored if MessageValueType is not set to mvtBinary (16).
This property is not available at design time.
Data Type
String
MessageCorrelationId Property (AMQP Control)
The correlation Id of this message.
Syntax
amqpcontrol.MessageCorrelationId[=string]
Default Value
""
Remarks
The correlation Id of this message.
This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.
This property is not available at design time.
Data Type
String
MessageCreationTime Property (AMQP Control)
The creation time of this message.
Syntax
amqpcontrol.MessageCreationTime[=long64]
Default Value
0
Remarks
The creation time of this message.
This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.
This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).
This property is not available at design time.
Data Type
Long64
MessageDeliveryCount Property (AMQP Control)
How many previous attempts there have been to deliver this message.
Syntax
amqpcontrol.MessageDeliveryCount[=long64]
Default Value
0
Remarks
How many previous attempts there have been to deliver this message.
This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.
This property is not available at design time.
Data Type
Long64
MessageDurable Property (AMQP Control)
Whether this message is durable.
Syntax
amqpcontrol.MessageDurable[=boolean]
Default Value
False
Remarks
Whether this message is durable.
This property specifies whether this message is durable or not.
If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.
This property is not available at design time.
Data Type
Boolean
MessageFirstAcquirer Property (AMQP Control)
Whether this message may have been acquired by other links previously.
Syntax
amqpcontrol.MessageFirstAcquirer[=boolean]
Default Value
False
Remarks
Whether this message may have been acquired by other links previously.
This property specifies whether this message might have previously been acquired by other links.
This property is not available at design time.
Data Type
Boolean
MessageGroupId Property (AMQP Control)
The Id of the group this message belongs to.
Syntax
amqpcontrol.MessageGroupId[=string]
Default Value
""
Remarks
The Id of the group this message belongs to.
This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.
This property is not available at design time.
Data Type
String
MessageGroupSequence Property (AMQP Control)
The position of this message within its group.
Syntax
amqpcontrol.MessageGroupSequence[=long64]
Default Value
0
Remarks
The position of this message within its group.
This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.
This property is not available at design time.
Data Type
Long64
MessageLinkName Property (AMQP Control)
The name of the link this message is associated with.
Syntax
amqpcontrol.MessageLinkName
Default Value
""
Remarks
The name of the link this message is associated with.
This property holds the name of the link which this message is being sent/was received on.
This property is read-only and not available at design time.
Data Type
String
MessageId Property (AMQP Control)
The unique Id of this message.
Syntax
amqpcontrol.MessageId[=string]
Default Value
""
Remarks
The unique Id of this message.
This property holds the unique Id of this message. It may be empty if this message does not have a unique Id.
This property is not available at design time.
Data Type
String
MessagePriority Property (AMQP Control)
The priority of this message.
Syntax
amqpcontrol.MessagePriority[=integer]
Default Value
4
Remarks
The priority of this message.
This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).
This property is not available at design time.
Data Type
Integer
MessageReplyTo Property (AMQP Control)
The address of the node to send replies to for this message.
Syntax
amqpcontrol.MessageReplyTo[=string]
Default Value
""
Remarks
The address of the node to send replies to for this message.
This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.
This property is not available at design time.
Data Type
String
MessageReplyToGroupId Property (AMQP Control)
The Id of the group to send replies to for this message.
Syntax
amqpcontrol.MessageReplyToGroupId[=string]
Default Value
""
Remarks
The Id of the group to send replies to for this message.
This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.
This property is not available at design time.
Data Type
String
MessageSettled Property (AMQP Control)
Whether this message is settled.
Syntax
amqpcontrol.MessageSettled[=boolean]
Default Value
True
Remarks
Whether this message is settled.
This property specifies whether this message is settled or not.
Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).
This property is not available at design time.
Data Type
Boolean
MessageSubject Property (AMQP Control)
The subject of this message.
Syntax
amqpcontrol.MessageSubject[=string]
Default Value
""
Remarks
The subject of this message.
This property specifies the subject of this message. It may be empty if this message does not have a subject set.
This property is not available at design time.
Data Type
String
MessageTo Property (AMQP Control)
The address of the node which this message is intended for.
Syntax
amqpcontrol.MessageTo[=string]
Default Value
""
Remarks
The address of the node which this message is intended for.
This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.
This property is not available at design time.
Data Type
String
MessageTTL Property (AMQP Control)
The time-to-live value for this message.
Syntax
amqpcontrol.MessageTTL[=long64]
Default Value
-1
Remarks
The time-to-live value for this message.
This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL.
This property is not available at design time.
Data Type
Long64
MessageUserId Property (AMQP Control)
The identity of the user responsible for producing this message.
Syntax
amqpcontrol.MessageUserId[=string]
Default Value
""
Remarks
The identity of the user responsible for producing this message.
This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message.
A message's user Id may be used for verification or authentication by intermediates and/or the final receiver.
This property is not available at design time.
Data Type
String
MessageValue Property (AMQP Control)
This message's value.
Syntax
amqpcontrol.MessageValue[=string]
Default Value
""
Remarks
This message's value.
This property specifies the value to send in this message. The MessageValueType property should be used to specify the data type of the value.
This property is not available at design time.
Data Type
String
MessageValueType Property (AMQP Control)
This message's value data type.
Syntax
amqpcontrol.MessageValueType[=integer]
Possible Values
mvtNull(0), mvtBoolean(1), mvtUbyte(2), mvtUshort(3), mvtUint(4), mvtUlong(5), mvtByte(6), mvtShort(7), mvtInt(8), mvtLong(9), mvtFloat(10), mvtDouble(11), mvtDecimal(12), mvtChar(13), mvtTimestamp(14), mvtUuid(15), mvtBinary(16), mvtString(17), mvtSymbol(18), mvtJson(19)
Default Value
0
Remarks
This message's value data type.
This property specifies the data type of this message's MessageValue.
The table below shows the possible value types, their descriptions, and how to format the data assigned to MessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).
Type | Description | Value Format |
mvtNull (0 - default) | Null | N/A (MessageValue is ignored) |
mvtBoolean (1) | Boolean | "True" or "False" |
mvtUbyte (2) | Unsigned byte | 0 to 255 |
mvtUshort (3) | Unsigned short | 0 to 65535 |
mvtUint (4) | Unsigned integer | 0 to 4294967295 |
mvtUlong (5) | Unsigned long | 0 to 18446744073709551615 |
mvtByte (6) | Byte | -128 to 127 |
mvtShort (7) | Short | -32768 to 32767 |
mvtInt (8) | Integer | -2147483648 to 2147483647 |
mvtLong (9) | Long | -9223372036854775808 to 9223372036854775807 |
mvtFloat (10) | Float | IEEE 754 32-bit floating point number |
mvtDouble (11) | Double | IEEE 754 64-bit floating point number |
mvtDecimal (12) | Decimal | Hex-encoded byte string |
mvtChar (13) | Char | Single character |
mvtTimestamp (14) | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). |
mvtUuid (15) | UUID | Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive) |
mvtBinary (16) | Binary data | Hex-encoded byte string |
mvtString (17) | String | String |
mvtSymbol (18) | Symbolic value | ASCII string |
mvtJson (19) | Composite data | Composite data JSON structured according to the schema shown in the SendMessage method's documentation |
This property is not available at design time.
Data Type
Integer
OutgoingMessageCount Property (AMQP Control)
The number of records in the OutgoingMessage arrays.
Syntax
amqpcontrol.OutgoingMessageCount
Default Value
0
Remarks
This property controls the size of the following arrays:
- OutgoingMessageAbsoluteExpiryTime
- OutgoingMessageContentEncoding
- OutgoingMessageContentType
- OutgoingMessageCorrelationId
- OutgoingMessageCreationTime
- OutgoingMessageDeliveryCount
- OutgoingMessageDurable
- OutgoingMessageFirstAcquirer
- OutgoingMessageGroupId
- OutgoingMessageGroupSequence
- OutgoingMessageId
- OutgoingMessageLinkName
- OutgoingMessagePriority
- OutgoingMessageReplyTo
- OutgoingMessageReplyToGroupId
- OutgoingMessageSettled
- OutgoingMessageSubject
- OutgoingMessageTo
- OutgoingMessageTTL
- OutgoingMessageUserId
- OutgoingMessageValue
- OutgoingMessageValueType
This property is read-only and not available at design time.
Data Type
Integer
OutgoingMessageAbsoluteExpiryTime Property (AMQP Control)
The absolute time at which this message should be considered expired.
Syntax
amqpcontrol.OutgoingMessageAbsoluteExpiryTime(OutgoingMessageIndex)
Default Value
0
Remarks
The absolute time at which this message should be considered expired.
This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.
This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
Long64
OutgoingMessageContentEncoding Property (AMQP Control)
The content encoding of this message's data.
Syntax
amqpcontrol.OutgoingMessageContentEncoding(OutgoingMessageIndex)
Default Value
""
Remarks
The content encoding of this message's data.
This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.
When constructing a message for sending, this property is ignored if OutgoingMessageValueType is not set to mvtBinary (16).
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessageContentType Property (AMQP Control)
The content type of this message's data.
Syntax
amqpcontrol.OutgoingMessageContentType(OutgoingMessageIndex)
Default Value
""
Remarks
The content type of this message's data.
This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.
When constructing a message for sending, this property is ignored if OutgoingMessageValueType is not set to mvtBinary (16).
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessageCorrelationId Property (AMQP Control)
The correlation Id of this message.
Syntax
amqpcontrol.OutgoingMessageCorrelationId(OutgoingMessageIndex)
Default Value
""
Remarks
The correlation Id of this message.
This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessageCreationTime Property (AMQP Control)
The creation time of this message.
Syntax
amqpcontrol.OutgoingMessageCreationTime(OutgoingMessageIndex)
Default Value
0
Remarks
The creation time of this message.
This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.
This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
Long64
OutgoingMessageDeliveryCount Property (AMQP Control)
How many previous attempts there have been to deliver this message.
Syntax
amqpcontrol.OutgoingMessageDeliveryCount(OutgoingMessageIndex)
Default Value
0
Remarks
How many previous attempts there have been to deliver this message.
This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
Long64
OutgoingMessageDurable Property (AMQP Control)
Whether this message is durable.
Syntax
amqpcontrol.OutgoingMessageDurable(OutgoingMessageIndex)
Default Value
False
Remarks
Whether this message is durable.
This property specifies whether this message is durable or not.
If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
Boolean
OutgoingMessageFirstAcquirer Property (AMQP Control)
Whether this message may have been acquired by other links previously.
Syntax
amqpcontrol.OutgoingMessageFirstAcquirer(OutgoingMessageIndex)
Default Value
False
Remarks
Whether this message may have been acquired by other links previously.
This property specifies whether this message might have previously been acquired by other links.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
Boolean
OutgoingMessageGroupId Property (AMQP Control)
The Id of the group this message belongs to.
Syntax
amqpcontrol.OutgoingMessageGroupId(OutgoingMessageIndex)
Default Value
""
Remarks
The Id of the group this message belongs to.
This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessageGroupSequence Property (AMQP Control)
The position of this message within its group.
Syntax
amqpcontrol.OutgoingMessageGroupSequence(OutgoingMessageIndex)
Default Value
0
Remarks
The position of this message within its group.
This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
Long64
OutgoingMessageLinkName Property (AMQP Control)
The name of the link this message is associated with.
Syntax
amqpcontrol.OutgoingMessageLinkName(OutgoingMessageIndex)
Default Value
""
Remarks
The name of the link this message is associated with.
This property holds the name of the link which this message is being sent/was received on.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessageId Property (AMQP Control)
The unique Id of this message.
Syntax
amqpcontrol.OutgoingMessageId(OutgoingMessageIndex)
Default Value
""
Remarks
The unique Id of this message.
This property holds the unique Id of this message. It may be empty if this message does not have a unique Id.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessagePriority Property (AMQP Control)
The priority of this message.
Syntax
amqpcontrol.OutgoingMessagePriority(OutgoingMessageIndex)
Default Value
4
Remarks
The priority of this message.
This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
Integer
OutgoingMessageReplyTo Property (AMQP Control)
The address of the node to send replies to for this message.
Syntax
amqpcontrol.OutgoingMessageReplyTo(OutgoingMessageIndex)
Default Value
""
Remarks
The address of the node to send replies to for this message.
This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessageReplyToGroupId Property (AMQP Control)
The Id of the group to send replies to for this message.
Syntax
amqpcontrol.OutgoingMessageReplyToGroupId(OutgoingMessageIndex)
Default Value
""
Remarks
The Id of the group to send replies to for this message.
This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessageSettled Property (AMQP Control)
Whether this message is settled.
Syntax
amqpcontrol.OutgoingMessageSettled(OutgoingMessageIndex)
Default Value
True
Remarks
Whether this message is settled.
This property specifies whether this message is settled or not.
Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
Boolean
OutgoingMessageSubject Property (AMQP Control)
The subject of this message.
Syntax
amqpcontrol.OutgoingMessageSubject(OutgoingMessageIndex)
Default Value
""
Remarks
The subject of this message.
This property specifies the subject of this message. It may be empty if this message does not have a subject set.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessageTo Property (AMQP Control)
The address of the node which this message is intended for.
Syntax
amqpcontrol.OutgoingMessageTo(OutgoingMessageIndex)
Default Value
""
Remarks
The address of the node which this message is intended for.
This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessageTTL Property (AMQP Control)
The time-to-live value for this message.
Syntax
amqpcontrol.OutgoingMessageTTL(OutgoingMessageIndex)
Default Value
-1
Remarks
The time-to-live value for this message.
This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
Long64
OutgoingMessageUserId Property (AMQP Control)
The identity of the user responsible for producing this message.
Syntax
amqpcontrol.OutgoingMessageUserId(OutgoingMessageIndex)
Default Value
""
Remarks
The identity of the user responsible for producing this message.
This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message.
A message's user Id may be used for verification or authentication by intermediates and/or the final receiver.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessageValue Property (AMQP Control)
This message's value.
Syntax
amqpcontrol.OutgoingMessageValue(OutgoingMessageIndex)
Default Value
""
Remarks
This message's value.
This property specifies the value to send in this message. The OutgoingMessageValueType property should be used to specify the data type of the value.
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
String
OutgoingMessageValueType Property (AMQP Control)
This message's value data type.
Syntax
amqpcontrol.OutgoingMessageValueType(OutgoingMessageIndex)
Possible Values
mvtNull(0), mvtBoolean(1), mvtUbyte(2), mvtUshort(3), mvtUint(4), mvtUlong(5), mvtByte(6), mvtShort(7), mvtInt(8), mvtLong(9), mvtFloat(10), mvtDouble(11), mvtDecimal(12), mvtChar(13), mvtTimestamp(14), mvtUuid(15), mvtBinary(16), mvtString(17), mvtSymbol(18), mvtJson(19)
Default Value
0
Remarks
This message's value data type.
This property specifies the data type of this message's OutgoingMessageValue.
The table below shows the possible value types, their descriptions, and how to format the data assigned to OutgoingMessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).
Type | Description | Value Format |
mvtNull (0 - default) | Null | N/A (OutgoingMessageValue is ignored) |
mvtBoolean (1) | Boolean | "True" or "False" |
mvtUbyte (2) | Unsigned byte | 0 to 255 |
mvtUshort (3) | Unsigned short | 0 to 65535 |
mvtUint (4) | Unsigned integer | 0 to 4294967295 |
mvtUlong (5) | Unsigned long | 0 to 18446744073709551615 |
mvtByte (6) | Byte | -128 to 127 |
mvtShort (7) | Short | -32768 to 32767 |
mvtInt (8) | Integer | -2147483648 to 2147483647 |
mvtLong (9) | Long | -9223372036854775808 to 9223372036854775807 |
mvtFloat (10) | Float | IEEE 754 32-bit floating point number |
mvtDouble (11) | Double | IEEE 754 64-bit floating point number |
mvtDecimal (12) | Decimal | Hex-encoded byte string |
mvtChar (13) | Char | Single character |
mvtTimestamp (14) | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). |
mvtUuid (15) | UUID | Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive) |
mvtBinary (16) | Binary data | Hex-encoded byte string |
mvtString (17) | String | String |
mvtSymbol (18) | Symbolic value | ASCII string |
mvtJson (19) | Composite data | Composite data JSON structured according to the schema shown in the SendMessage method's documentation |
The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
Integer
Password Property (AMQP Control)
A password to use for SASL authentication.
Syntax
amqpcontrol.Password[=string]
Default Value
""
Remarks
This property contains a password to use for SASL authentication.
This property is not available at design time.
Data Type
String
ReadyToSend Property (AMQP Control)
Indicates whether the control is ready to send data.
Syntax
amqpcontrol.ReadyToSend
Default Value
False
Remarks
This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is True after connecting to the remote host, and will become False if a call to SendMessage fails due to a WOULDBLOCK condition.
Once data can be sent again, the ReadyToSend event will fire and this property will be True.
If a WOULDBLOCK error occurs while sending a message the control will automatically complete the transmission when sending is possible. No action needs to be taken to re-send the message. ReadyToSend will fire after the control completes any partially sent messages.
This property is read-only and not available at design time.
Data Type
Boolean
ReceivedMessageAbsoluteExpiryTime Property (AMQP Control)
The absolute time at which this message should be considered expired.
Syntax
amqpcontrol.ReceivedMessageAbsoluteExpiryTime
Default Value
0
Remarks
The absolute time at which this message should be considered expired.
This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.
This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).
This property is read-only and not available at design time.
Data Type
Long64
ReceivedMessageContentEncoding Property (AMQP Control)
The content encoding of this message's data.
Syntax
amqpcontrol.ReceivedMessageContentEncoding
Default Value
""
Remarks
The content encoding of this message's data.
This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.
When constructing a message for sending, this property is ignored if ReceivedMessageValueType is not set to mvtBinary (16).
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageContentType Property (AMQP Control)
The content type of this message's data.
Syntax
amqpcontrol.ReceivedMessageContentType
Default Value
""
Remarks
The content type of this message's data.
This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.
When constructing a message for sending, this property is ignored if ReceivedMessageValueType is not set to mvtBinary (16).
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageCorrelationId Property (AMQP Control)
The correlation Id of this message.
Syntax
amqpcontrol.ReceivedMessageCorrelationId
Default Value
""
Remarks
The correlation Id of this message.
This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageCreationTime Property (AMQP Control)
The creation time of this message.
Syntax
amqpcontrol.ReceivedMessageCreationTime
Default Value
0
Remarks
The creation time of this message.
This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.
This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).
This property is read-only and not available at design time.
Data Type
Long64
ReceivedMessageDeliveryCount Property (AMQP Control)
How many previous attempts there have been to deliver this message.
Syntax
amqpcontrol.ReceivedMessageDeliveryCount
Default Value
0
Remarks
How many previous attempts there have been to deliver this message.
This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.
This property is read-only and not available at design time.
Data Type
Long64
ReceivedMessageDurable Property (AMQP Control)
Whether this message is durable.
Syntax
amqpcontrol.ReceivedMessageDurable
Default Value
False
Remarks
Whether this message is durable.
This property specifies whether this message is durable or not.
If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.
This property is read-only and not available at design time.
Data Type
Boolean
ReceivedMessageFirstAcquirer Property (AMQP Control)
Whether this message may have been acquired by other links previously.
Syntax
amqpcontrol.ReceivedMessageFirstAcquirer
Default Value
False
Remarks
Whether this message may have been acquired by other links previously.
This property specifies whether this message might have previously been acquired by other links.
This property is read-only and not available at design time.
Data Type
Boolean
ReceivedMessageGroupId Property (AMQP Control)
The Id of the group this message belongs to.
Syntax
amqpcontrol.ReceivedMessageGroupId
Default Value
""
Remarks
The Id of the group this message belongs to.
This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageGroupSequence Property (AMQP Control)
The position of this message within its group.
Syntax
amqpcontrol.ReceivedMessageGroupSequence
Default Value
0
Remarks
The position of this message within its group.
This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.
This property is read-only and not available at design time.
Data Type
Long64
ReceivedMessageLinkName Property (AMQP Control)
The name of the link this message is associated with.
Syntax
amqpcontrol.ReceivedMessageLinkName
Default Value
""
Remarks
The name of the link this message is associated with.
This property holds the name of the link which this message is being sent/was received on.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageId Property (AMQP Control)
The unique Id of this message.
Syntax
amqpcontrol.ReceivedMessageId
Default Value
""
Remarks
The unique Id of this message.
This property holds the unique Id of this message. It may be empty if this message does not have a unique Id.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessagePriority Property (AMQP Control)
The priority of this message.
Syntax
amqpcontrol.ReceivedMessagePriority
Default Value
4
Remarks
The priority of this message.
This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).
This property is read-only and not available at design time.
Data Type
Integer
ReceivedMessageReplyTo Property (AMQP Control)
The address of the node to send replies to for this message.
Syntax
amqpcontrol.ReceivedMessageReplyTo
Default Value
""
Remarks
The address of the node to send replies to for this message.
This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageReplyToGroupId Property (AMQP Control)
The Id of the group to send replies to for this message.
Syntax
amqpcontrol.ReceivedMessageReplyToGroupId
Default Value
""
Remarks
The Id of the group to send replies to for this message.
This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageSettled Property (AMQP Control)
Whether this message is settled.
Syntax
amqpcontrol.ReceivedMessageSettled
Default Value
True
Remarks
Whether this message is settled.
This property specifies whether this message is settled or not.
Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).
This property is read-only and not available at design time.
Data Type
Boolean
ReceivedMessageSubject Property (AMQP Control)
The subject of this message.
Syntax
amqpcontrol.ReceivedMessageSubject
Default Value
""
Remarks
The subject of this message.
This property specifies the subject of this message. It may be empty if this message does not have a subject set.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageTo Property (AMQP Control)
The address of the node which this message is intended for.
Syntax
amqpcontrol.ReceivedMessageTo
Default Value
""
Remarks
The address of the node which this message is intended for.
This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageTTL Property (AMQP Control)
The time-to-live value for this message.
Syntax
amqpcontrol.ReceivedMessageTTL
Default Value
-1
Remarks
The time-to-live value for this message.
This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL.
This property is read-only and not available at design time.
Data Type
Long64
ReceivedMessageUserId Property (AMQP Control)
The identity of the user responsible for producing this message.
Syntax
amqpcontrol.ReceivedMessageUserId
Default Value
""
Remarks
The identity of the user responsible for producing this message.
This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message.
A message's user Id may be used for verification or authentication by intermediates and/or the final receiver.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageValue Property (AMQP Control)
This message's value.
Syntax
amqpcontrol.ReceivedMessageValue
Default Value
""
Remarks
This message's value.
This property specifies the value to send in this message. The ReceivedMessageValueType property should be used to specify the data type of the value.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageValueType Property (AMQP Control)
This message's value data type.
Syntax
amqpcontrol.ReceivedMessageValueType
Possible Values
mvtNull(0), mvtBoolean(1), mvtUbyte(2), mvtUshort(3), mvtUint(4), mvtUlong(5), mvtByte(6), mvtShort(7), mvtInt(8), mvtLong(9), mvtFloat(10), mvtDouble(11), mvtDecimal(12), mvtChar(13), mvtTimestamp(14), mvtUuid(15), mvtBinary(16), mvtString(17), mvtSymbol(18), mvtJson(19)
Default Value
0
Remarks
This message's value data type.
This property specifies the data type of this message's ReceivedMessageValue.
The table below shows the possible value types, their descriptions, and how to format the data assigned to ReceivedMessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).
Type | Description | Value Format |
mvtNull (0 - default) | Null | N/A (ReceivedMessageValue is ignored) |
mvtBoolean (1) | Boolean | "True" or "False" |
mvtUbyte (2) | Unsigned byte | 0 to 255 |
mvtUshort (3) | Unsigned short | 0 to 65535 |
mvtUint (4) | Unsigned integer | 0 to 4294967295 |
mvtUlong (5) | Unsigned long | 0 to 18446744073709551615 |
mvtByte (6) | Byte | -128 to 127 |
mvtShort (7) | Short | -32768 to 32767 |
mvtInt (8) | Integer | -2147483648 to 2147483647 |
mvtLong (9) | Long | -9223372036854775808 to 9223372036854775807 |
mvtFloat (10) | Float | IEEE 754 32-bit floating point number |
mvtDouble (11) | Double | IEEE 754 64-bit floating point number |
mvtDecimal (12) | Decimal | Hex-encoded byte string |
mvtChar (13) | Char | Single character |
mvtTimestamp (14) | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). |
mvtUuid (15) | UUID | Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive) |
mvtBinary (16) | Binary data | Hex-encoded byte string |
mvtString (17) | String | String |
mvtSymbol (18) | Symbolic value | ASCII string |
mvtJson (19) | Composite data | Composite data JSON structured according to the schema shown in the SendMessage method's documentation |
This property is read-only and not available at design time.
Data Type
Integer
ReceiveMode Property (AMQP Control)
Controls what mode new receiver links are created with.
Syntax
amqpcontrol.ReceiveMode[=integer]
Possible Values
rmAutomatic(0), rmFetch(1)
Default Value
0
Remarks
This property controls which receive mode newly created receiver links should use to receive messages from the sender. Valid values are:
- rmAutomatic (0 - default)
- rmFetch (1)
Receiving Messages Automatically
A receiver link operating in rmAutomatic (0) mode strives to ensure that the sender always has sufficient credit so that messages are received as soon as they are available, thus simulating a "subscription-based"/"push-based" messaging model.In this mode, receiver links will be created with the amount of credit, and the credit threshold, specified by the DefaultCredit and DefaultCreditThreshold configuration settings. Anytime the link's credit reaches the credit threshold, the control will automatically set it back to its initial value.
Fetching Messages On-Demand
A receiver link operating in rmFetch (1) mode requires the FetchMessage method to be called in order for a message to be received, thus simulating a "polling"/"pull-based" messaging model.In this mode, receiver links will be created with no credit (regardless of what DefaultCredit is set to). When FetchMessage is called, the control will supply the sender with a single credit and then block until a message is received (if the FetchTimeout property is set to zero).
If FetchTimeout is non-zero, the control will only block for the specified number of seconds; once that time expires, it will instruct the sender to consume the credit. If the sender chooses to consume the credit by incrementing the value of the LinkDeliveryCount property rather than by sending a message, then the control will throw an error indicating a timeout.
Refer to FetchMessage and FetchTimeout for more information.
amqp.ReceiveMode = AmqpReceiveModes.rmFetch;
amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");
This property is not available at design time.
Data Type
Integer
RemoteHost Property (AMQP Control)
This property includes the address of the remote host. Domain names are resolved to IP addresses.
Syntax
amqpcontrol.RemoteHost[=string]
Default Value
""
Remarks
This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.
If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.
If the control 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
Data Type
String
RemotePort Property (AMQP Control)
The port of the AQMP server (default is 5672). The default port for SSL is 5671.
Syntax
amqpcontrol.RemotePort[=integer]
Default Value
5672
Remarks
This property specifies a service port on the remote host to connect to.
A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
This property is not available at design time.
Data Type
Integer
SessionCount Property (AMQP Control)
The number of records in the Session arrays.
Syntax
amqpcontrol.SessionCount
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SessionCount - 1.This property is read-only and not available at design time.
Data Type
Integer
SessionIncomingWindow Property (AMQP Control)
The incoming window size of this session.
Syntax
amqpcontrol.SessionIncomingWindow(SessionIndex)
Default Value
0
Remarks
The incoming window size of this session.
This property holds the incoming window size (in frames) of this session.
The SessionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.
This property is read-only and not available at design time.
Data Type
Long64
SessionName Property (AMQP Control)
The name of this session.
Syntax
amqpcontrol.SessionName(SessionIndex)
Default Value
""
Remarks
The name of this session.
This property holds the name of this session.
The SessionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.
This property is read-only and not available at design time.
Data Type
String
SessionOutgoingWindow Property (AMQP Control)
The outgoing window size of this session.
Syntax
amqpcontrol.SessionOutgoingWindow(SessionIndex)
Default Value
0
Remarks
The outgoing window size of this session.
This property holds the outgoing window size (in frames) of this session.
The SessionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.
This property is read-only and not available at design time.
Data Type
Long64
SSLAcceptServerCertEncoded Property (AMQP Control)
This is the certificate (PEM/Base64 encoded).
Syntax
amqpcontrol.SSLAcceptServerCertEncoded[=string]
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (AMQP Control)
This is the certificate (PEM/Base64 encoded).
Syntax
amqpcontrol.SSLCertEncoded[=string]
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (AMQP Control)
This is the name of the certificate store for the client certificate.
Syntax
amqpcontrol.SSLCertStore[=string]
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property 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. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.
Data Type
Binary String
SSLCertStorePassword Property (AMQP Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
amqpcontrol.SSLCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (AMQP Control)
This is the type of certificate store for this certificate.
Syntax
amqpcontrol.SSLCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property 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 control. 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 SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
Data Type
Integer
SSLCertSubject Property (AMQP Control)
This is the subject of the certificate used for client authentication.
Syntax
amqpcontrol.SSLCertSubject[=string]
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
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.
Data Type
String
SSLEnabled Property (AMQP Control)
Whether TLS/SSL is enabled.
Syntax
amqpcontrol.SSLEnabled[=boolean]
Default Value
False
Remarks
This setting specifies whether TLS/SSL is enabled in the control. When False (default) the control 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.
Data Type
Boolean
SSLProvider Property (AMQP Control)
This specifies the SSL/TLS implementation to use.
Syntax
amqpcontrol.SSLProvider[=integer]
Possible Values
sslpAutomatic(0), sslpPlatform(1), sslpInternal(2)
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the control 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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The control 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.
Data Type
Integer
SSLServerCertEncoded Property (AMQP Control)
This is the certificate (PEM/Base64 encoded).
Syntax
amqpcontrol.SSLServerCertEncoded
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.
This property is read-only and not available at design time.
Data Type
Binary String
Timeout Property (AMQP Control)
A timeout for the control.
Syntax
amqpcontrol.Timeout[=integer]
Default Value
60
Remarks
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 control will wait for the operation to complete before returning control. The control will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.
The control 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 control fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
User Property (AMQP Control)
A username to use for SASL authentication.
Syntax
amqpcontrol.User[=string]
Default Value
""
Remarks
This property contains a username to use for SASL authentication.
This property is not available at design time.
Data Type
String
CloseLink Method (AMQP Control)
Closes a link.
Syntax
amqpcontrol.CloseLink Name
Remarks
This method closes the link named Name and removes it from the Link* properties. If no link with the given Name exists, an error will be thrown.
CloseSession Method (AMQP Control)
Closes a session.
Syntax
amqpcontrol.CloseSession Name
Remarks
This method closes the session named Name and removes it from the Session* properties. If no session with the given Name exists, an error will be thrown.
Any links open on the specified session when this method is called will be automatically closed and removed from the Link* properties.
Config Method (AMQP Control)
Sets or retrieves a configuration setting.
Syntax
amqpcontrol.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Connect Method (AMQP Control)
This method connects to a remote host.
Syntax
amqpcontrol.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 (AMQP Control)
This method connects to a remote host.
Syntax
amqpcontrol.ConnectTo Host, Port
Remarks
This method connects to the remote host specified by the Host and Port parameters. For instance:
component.ConnectTo("MyHostNameOrIP", 777)
CreateReceiverLink Method (AMQP Control)
Creates a new receiver link with the given name on the specified session.
Syntax
amqpcontrol.CreateReceiverLink SessionName, Name, Source
Remarks
This method creates a new receiver link with the given Name on the session specified by SessionName and adds it to the Link* properties. If a link (sender or receiver) with the given Name already exists, or if no session with the given SessionName exists, an error will be thrown.
Source may be set to specify the address of the node at the remote host which should act as the sender. This may not be necessary in all environments, in which case an empty string will suffice.
Receiver links can operate in one of two receive modes: automatic, where the control will work to ensure that messages are received as soon as they are available; and fetch-based, where the control will only "fetch" a new message when explicitly instructed to.
The ReceiveMode property controls which receive mode newly-created receiver links will use; refer to its documentation for more information.
AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions.
amqp.ReceiveMode = AmqpReceiveModes.rmFetch;
amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");
CreateSenderLink Method (AMQP Control)
Creates a new sender link with the given name on the specified session.
Syntax
amqpcontrol.CreateSenderLink SessionName, Name, Target
Remarks
This method creates a new sender link with the given Name on the session specified by SessionName and adds it to the Link* properties. If a link (sender or receiver) with the given Name already exists, or if no session with the given SessionName exists, an error will be thrown.
Target may be set to specify the address of the node at the remote host which should act as the receiver. This may not be necessary in all environments, in which case an empty string will suffice.
The LinkReadyToSend event will fire when a newly-created sender link is ready to send.
Sender links are created using the Mixed settle mode by default, letting the value of the MessageSettled property control whether each message is settled (the default) or unsettled when it is sent. The DefaultSenderSettleMode configuration setting can be used to control the settle mode that new sender links are created with. Refer to SendMessage for more information on message settlement in general.
AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions.
CreateSession Method (AMQP Control)
Creates a new session with the given name.
Syntax
amqpcontrol.CreateSession Name
Remarks
This method creates a new session with the given Name and adds it to the Session* properties. If a session with the given Name already exists, an error will be thrown.
AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions.
Disconnect Method (AMQP Control)
This method disconnects from the remote host.
Syntax
amqpcontrol.Disconnect
Remarks
This method disconnects from the remote host. Calling this method is equivalent to setting the Connected property to False.
DoEvents Method (AMQP Control)
Processes events from the internal message queue.
Syntax
amqpcontrol.DoEvents
Remarks
When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.
FetchMessage Method (AMQP Control)
Fetches a single message over the specified receiver link.
Syntax
amqpcontrol.FetchMessage LinkName
Remarks
When FetchMessage is called, the control will supply the sender with a single credit and then block until a message is received (if the FetchTimeout property is set to zero).
If FetchTimeout is non-zero, the control will only block for the specified number of seconds; once that time expires, it will instruct the sender to consume the credit. If the sender chooses to consume the credit by incrementing the value of the LinkDeliveryCount property rather than by sending a message, then the control will throw an error indicating a timeout.
LinkName specifies the receiver link which should fetch a message; if there is no such link, if the specified link is not a receiver link, or if the specified receiver link is not operating in rmSyncGet (1) mode, an error is thrown.
Refer to ReceiveMode and FetchTimeout for more information.
Interrupt Method (AMQP Control)
This method interrupts the current action.
Syntax
amqpcontrol.Interrupt
Remarks
This method interrupts the current action. If you use SendFile to upload a file, the control will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.
Reset Method (AMQP Control)
Reset the control.
Syntax
amqpcontrol.Reset
Remarks
This method will reset the control's properties to their default values.
ResetMessage Method (AMQP Control)
Resets the Message properties.
Syntax
amqpcontrol.ResetMessage
Remarks
This method resets the Message* properties.
SendMessage Method (AMQP Control)
Sends a message on the specified link.
Syntax
amqpcontrol.SendMessage LinkName
Remarks
This method sends a message on the link specified by LinkName.
The Message* properties are used to construct the message to send. At minimum, specify a MessageValue and a MessageValueType; all other properties are optional. The ResetMessage method can be used to reset the Message* properties.
amqp.Message.ValueType = AMQPValueTypes.mvtString;
amqp.Message.Value = "Hello World!";
amqp.SendMessage("SenderLinkName");
Message Settlement
AMQP provides the ability to negotiate delivery guarantees through the system of "message settlement". When a link is created, both the sender and the receiver negotiate a settle mode (one for each role) to use. Senders will operate in one of these modes:- Settled - All messages will be sent in a settled state.
- Unsettled - All messages will be sent in an unsettled state.
- Mixed - Messages may be sent either settled or unsettled.
- First - Incoming messages will be settled immediately (and the sender will be notified that the message has been received, if the message was not already settled when sent).
- Second - Incoming messages will be settled after the sender has settled them (and the sender will be notified when a message has been received, if the message was not already settled when sent).
Together, the sender's and receiver's settle modes can form the following delivery guarantees:
Sender's Settle Mode | Receiver's Settle Mode | Effective Delivery Guarantee |
Settled | (Any) | At most once |
Unsettled | First | At least once |
Unsettled | Second | Exactly once |
It is important to note that the message settlement system has a big caveat: Whichever party opens the link can only request that the other end use a specific settle mode. For example, if the control opens a sender link, it has control over the sender settle mode it will use, but it can only request that the remote host use a specific receiver settle mode; so if the control requests that the receiver use Second, the receiver can instead choose to use First (if, e.g., it doesn't support Second).
The control currently only ever requests (and itself only supports) the First receiver settle mode since no other AMQP implementations appear to support the Second receiver settle mode at this time.
The control requests (and uses) the Mixed sender settle mode by default, but supports all of the sender settle modes (the default can be changed using the DefaultSenderSettleMode configuration setting). Sender links created with the Mixed sender use the value of the MessageSettled property to determine whether to send messages as settled or unsettled.
Sending Composite Data
The AMQP 1.0 protocol's data model includes the concept of "composite data". Composite data is comprised of one or more type-value pairs (including data structure types), plus a descriptor that describes what the overall data represents.Composite Data JSON Schema
The control uses JSON with a well-defined schema to represent composite data. The composite data JSON schema consists almost entirely of "type-value" objects, which hold an AMQP typename and a value. The syntax for a type-value object is:
{ "type": "typename", "value": value }
The following table provides a complete list of valid typenames, and describes how the associated values should be represented:
Typename | Description | Value Format |
null | Null | null |
boolean | Boolean | true or false |
ubyte | Unsigned byte | 0 to 255 |
ushort | Unsigned short | 0 to 65535 |
uint | Unsigned integer | 0 to 4294967295 |
ulong | Unsigned long | 0 to 18446744073709551615 |
byte | Byte | -128 to 127 |
short | Short | -32768 to 32767 |
int | Integer | -2147483648 to 2147483647 |
long | Long | -9223372036854775808 to 9223372036854775807 |
float | Float | [IEEE 754 32-bit floating point number] |
double | Double | [IEEE 754 64-bit floating point number] |
decimal | Decimal | Hex-encoded byte string like "0A1B2C3D" |
char | Char | "c" |
timestamp | Timestamp | [Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC)] |
uuid | UUID | Hex-encoded UUID string like "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" (hyphens optional, case-insensitive) |
binary | Binary data | Hex-encoded byte string like "0A1B2C3D" |
string | String | "UTF-8 string (correctly escaped for JSON)" |
symbol | Symbolic value | "ASCII string" |
array | AMQP array | JSON array with zero or more type-value objects of the same type |
list | AMQP list | JSON array with zero or more type-value objects |
map | AMQP map | JSON array with even number of type-value objects representing keys and values; no duplicate keys allowed |
Arrays, Lists, and Maps
The AMQP data model defines three data structure types: array, list, and map. In the composite data JSON schema, their value is always a JSON array that contains zero or more type-value objects. Data structure types may be nested arbitrarily to any depth.
Note that the array and map data structures each have restrictions on their content:
- The elements in an array must all be of the same type (e.g., their typenames must match).
- The elements in a map represent keys (odd-numbered elements) and values (even-numbered elements). There must be an even number of elements (or none), and the values of the "key" elements must be unique.
{ "type": "map", "value": [ { "type": "symbol", "value": "key1" }, { "type": "string", "value": "value1" }, { "type": "symbol", "value": "key2" }, { "type": "int", "value": 100 } ] }
Described Types
As noted above, AMQP's data model includes the idea of "described types", which is simply a normal AMQP type annotated by a descriptor. The descriptor defines what the data it is associated with represents as a whole.
In the composite data JSON schema, a described type object is just a normal type-value object with an extra "descriptor" property on it (and the "descriptor" property's value is itself a normal type-value object). The syntax for a described type object is:
{ "descriptor": { "type": "typename", "value": value }, "type": "typename", "value": value }
Described type objects can be used anywhere that normal type-value objects can be, except as the value of the "descriptor" property for another described type object, which must be a normal type-value object.
Note that, according to the AMQP specification, the type of the descriptor itself ulong or symbol, but the control does not enforce this.
Abbreviated Value Syntax
For brevity, it is possible to abbreviate both normal type-value objects and described type objects when their value type is null, boolean, or string.
For normal type-value objects, instead of using the standard syntax (e.g., { "type": "string", "value": "Hello, world!" }), just use the raw value itself (e.g., "Hello, world!"). Keep in mind that the abbreviated value must still be valid JSON; notably, strings must still be surrounded by quotes (e.g., "value", not value).
The abbreviated syntax for a described type object is a bit different; the "descriptor" property still needs to be associated with the value using a JSON object. To abbreviate a described type object, just exclude the "type" property, like so:
{ "descriptor": { "type": "typename", "value": value }, "value": value }
The abbreviated value syntax can be used anywhere that an unabbreviated type-value object or described type object would normally be used.
The control defaults to using the abbreviated syntax when returning composite data JSON. This can be configured using the SimplifiedJSONFormat configuration setting.
Composite Data JSON Example
{ "descriptor": { "type": "symbol", "value": "nsoftware:compositeDataExample" }, "type": "list", "value": [ "Shorthand string value", null, true, { "type": "uuid", "value": "12345678-0000-1000-8000-00805F9B34FB" }, { "type": "array", "value": [ { "type": "uint", "value": 23 }, { "type": "uint", "value": 52 }, { "type": "uint", "value": 153325 } ] }, { "type": "map", "value": [ { "type": "symbol", "value": "name" }, "Freezer temperature", { "type": "symbol", "value": "unit" }, "Fahrenheit", { "type": "symbol", "value": "value" }, { "type": "int", "value": -2 } ] }, { "descriptor": { "type": "symbol", "value": "nsoftware:utf8Bytes" }, "type": "binary", "value": "48656C6C6F2C20776F726C6421" } ] }
Connected Event (AMQP Control)
This event is fired immediately after a connection completes (or fails).
Syntax
Sub amqpcontrol_Connected(StatusCode As Integer, Description As String)
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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.
Please refer to the Error Codes section for more information.
ConnectionStatus Event (AMQP Control)
This event is fired to indicate changes in the connection state.
Syntax
Sub amqpcontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)
Remarks
The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
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. |
Disconnected Event (AMQP Control)
This event is fired when a connection is closed.
Syntax
Sub amqpcontrol_Disconnected(StatusCode As Integer, Description As String)
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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.
Please refer to the Error Codes section for more information.
Error Event (AMQP Control)
Fired when information is available about errors during data delivery.
Syntax
Sub amqpcontrol_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
LinkReadyToSend Event (AMQP Control)
Fires when a sender link is ready to send messages.
Syntax
Sub amqpcontrol_LinkReadyToSend(LinkName As String, LinkIndex As Integer)
Remarks
This event fires when a sender link is ready to send messages.
LinkName is the name of the sender link.
LinkIndex is the index of the sender link in the Link* properties.
Log Event (AMQP Control)
Fires once for each log message.
Syntax
Sub amqpcontrol_Log(LogLevel As Integer, Message As String, LogType As String)
Remarks
This event fires once for each log message generated by the control. 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 control.
- Session: Session status messages.
- Frame: Frame status messages.
MessageIn Event (AMQP Control)
Fires when the control receives a message.
Syntax
Sub amqpcontrol_MessageIn(SessionName As String, SessionIndex As Integer, LinkName As String, LinkIndex As Integer, MessageId As String, State As Integer)
Remarks
This event fires whenever the control receives a message. The message itself is automatically stored in the ReceivedMessage* properties.
Specifying a Delivery Outcome
The State parameter can be set to one of the following values to specify what delivery outcome the control should report to the sender (the default is Accepted (0)):- 0: Accepted - The message has been processed successfully.
- 1: Rejected - The message failed to process successfully. Includes an error describing why.
- 2: Released - The message has not been (and will not be) processed.
- 3: Modified - Same as "Released", but with additional metadata for the sender.
When State is set to Rejected (1), the control will include error metadata when it informs the sender of the outcome. Set the RejectErrorCondition and RejectErrorDescription configuration settings before the event handler finishes to specify this error information.
When State is set to Modified (3), the control can include additional metadata when it informs the sender of the outcome. Set zero or more of the ModifiedDeliveryFailed, ModifiedMessageAnnotations, and ModifiedUndeliverableHere configuration settings before the event handler finishes to specify this additional metadata.
Other Parameters
SessionName is the name of the session the message was transmitted on.SessionIndex is the index of the session in the Session* properties.
LinkName is the name of the link the message was transmitted on.
LinkIndex is the index of the link in the Link* properties.
MessageId is the Id of the message; it may be empty if a message Id was not set.
MessageOut Event (AMQP Control)
Fires when the control sends a message.
Syntax
Sub amqpcontrol_MessageOut(SessionName As String, SessionIndex As Integer, LinkName As String, LinkIndex As Integer, MessageId As String)
Remarks
This event fires whenever the control sends a message.
SessionName is the name of the session the message was transmitted on.
SessionIndex is the index of the session in the Session* properties.
LinkName is the name of the link the message was transmitted on.
LinkIndex is the index of the link in the Link* properties.
MessageId is the Id of the message; it may be empty if a message Id was not set.
MessageOutcome Event (AMQP Control)
Fires when a message's outcome is available.
Syntax
Sub amqpcontrol_MessageOutcome(SessionName As String, SessionIndex As Integer, LinkName As String, LinkIndex As Integer, MessageId As String, Direction As Integer, State As Integer)
Remarks
This event fires whenever the outcome for a message (incoming or outgoing) is available.
SessionName is the name of the session the message was transmitted on.
SessionIndex is the index of the session in the Session* properties.
LinkName is the name of the link the message was transmitted on.
LinkIndex is the index of the link in the Link* properties.
MessageId is the Id of the message; it may be empty if a message Id was not set.
Direction indicates whether this outcome was sent (0) or received (1).
State indicates the actual message outcome. Possible values are:
- 0: Accepted - The message has been processed successfully.
- 1: Rejected - The message failed to process successfully. Includes an error describing why.
- 2: Released - The message has not been (and will not be) processed.
- 3: Modified - Same as "Released", but with additional metadata for the sender.
When State is Rejected (1), the RejectErrorCondition and RejectErrorDescription configuration settings can be queried before the event handler finishes to retrieve the error information.
When State is Modified (3), the ModifiedDeliveryFailed, ModifiedMessageAnnotations, and ModifiedUndeliverableHere configuration settings can be queried before the event handler finishes to retrieve the additional metadata.
SSLServerAuthentication Event (AMQP Control)
Fired after the server presents its certificate to the client.
Syntax
Sub amqpcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (AMQP Control)
Fired when secure connection progress messages are available.
Syntax
Sub amqpcontrol_SSLStatus(Message As String)
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Config Settings (AMQP Control)
The control 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 control, access to these internal properties is provided through the Config method.AMQP Config Settings
Supports "utf8" (default) or "8bit".
If an unsupported charset is detected (currently supports utf8 and 8bit) an error is thrown and the message payload is left as hex-encoded byte string. If content-type is not present, then the BinaryMessageEncoding value is used to decode.
Default is .
The default is 1024.
The default is 256.
The default is 2014.
The default is 2014.
- 0 (First - default): The receiver will settle all incoming messages.
- 1 (Second): The receiver will only settle messages after returning the message disposition and receiving the disposition from the sender indicating it has been settled.
Note: This setting can be used with Azure Service Bus to indicate the settlement mode. For example, "Peek-Lock" can be enabled by setting DefaultSenderSettleMode to 0 and DefaultReceiverSettleMode to 1.
- 0 (Unsettled): The sender will send messages to the receiver in an unsettled state.
- 1 (Settled): The sender will send messages to the receiver in a settled state.
- 2 (Mixed - default): The sender may send messages to the receiver in either a settled or an unsettled state.
The default is False.
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. |
The default is 4294967295 (0xFFFFFFFF), which is the maximum value allowed.
The default is 4294967295 (0xFFFFFFFF), which is the maximum value allowed.
The default value is 1073741824 (0x40000000).
The default is 65535 (0xFFFF).
This setting is only valid while inside one of the MessageIn or MessageOutcome event handlers, and can only be set while inside the MessageIn event handler.
If not empty, this setting's value must be specified as valid composite data JSON containing a single AMQP map. The JSON must be structured according to the composite data JSON schema detailed in the SendMessage method's documentation. For example:
{ "type": "map", "value": [ { "type": "symbol", "value": "key1" }, { "type": "string", "value": "test" }, { "type": "symbol", "value": "key2" }, { "type": "int", "value": 100 } ] }
This setting is only valid while inside one of the MessageIn or MessageOutcome event handlers, and can only be set while inside the MessageIn event handler.
This setting is only valid while inside one of the MessageIn or MessageOutcome event handlers, and can only be set while inside the MessageIn event handler.
Note: Currently this setting will always return "1.0", and cannot be changed. The AMQPClassic control may be used instead of this one if AMQP 0.9.1 support is needed.
amqp:internal-error | An internal error occurred. |
amqp:not-found | A peer attempted to work with a remote entity that does not exists. |
amqp:unauthorized-access | A peer attempted to work with a remote entity it does not have access to. |
amqp:decode-error | Data could not be decoded. |
amqp:resource-limited-exceeded | A peer exceeded its resource allocation. |
amqp:not-allowed | A peer tried to use a frame in a manner inconsistent with the AMQP specification. |
amqp:invalid-field | An invalid field was supplied in a frame body. |
amqp:not-implemented | A peer tried to use functionality that its partner does not implement. |
amqp:resource-locked | A peer tried to access a resource which is currently in use. |
amqp:precondition-failed | A peer made a request that was denied because a precondition failed. |
amqp:resource-deleted | A peer tried to work with a deleted resource. |
amqp:illegal-state | A peer sent a frame that is not permitted given the current state. |
amqp:frame-size-too-small | A peer attempted to send a frame larger than the negotiated maximum frame size. |
This setting is only valid while inside one of the MessageIn or MessageOutcome event handlers, and can only be set while inside the MessageIn event handler.
This setting is only valid while inside one of the MessageIn or MessageOutcome event handlers, and can only be set while inside the MessageIn event handler.
The default is true.
TCPClient Config Settings
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 controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by controls that do not directly expose Firewall properties.
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 controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
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 control 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.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.
If the control 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 multi-homed hosts (machines with more than one IP interface).
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; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
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 setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the control 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 control is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default) the CRL check will not be performed by the control. When set to 1, it will attempt to perform the CRL check, but 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 only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the control will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but 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 only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
Please note that this 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 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 config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the control 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.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- 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_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- 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.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the control will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which 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 only supported 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 only available 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 the above 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 control 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.
This setting is only applicable when SSLProvider is set to Internal.
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.
When set, the control 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 traffice for debugging purposes. When writing to this file the control will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the control will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the control fails with an error.
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 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.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
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)
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 setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified 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"
- "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 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
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Trappable Errors (AMQP Control)
AMQP Errors
20601 AMQP protocol error. Refer to the error message for more information. | |
20602 Malformed frame. | |
20603 SASL authentication failed. | |
20604 Cannot open another session or link. | |
20605 Invalid data format. | |
20606 Cannot modify message data. | |
20607 Cannot modify configuration setting. |
TCPClient Errors
20101 You cannot change the RemotePort at this time. A connection is in progress. | |
20102 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
20103 The RemoteHost address is invalid (0.0.0.0). | |
20105 Already connected. If you want to reconnect, close the current connection first. | |
20107 You cannot change the LocalPort at this time. A connection is in progress. | |
20108 You cannot change the LocalHost at this time. A connection is in progress. | |
20113 You cannot change MaxLineLength at this time. A connection is in progress. | |
20117 RemotePort cannot be zero. Please specify a valid service port number. | |
20118 You cannot change the UseConnection option while the control is active. | |
20136 Operation would block. | |
20202 Timeout. | |
20212 Action impossible in control's present state. | |
20213 Action impossible while not connected. | |
20214 Action impossible while listening. | |
20302 Timeout. | |
20303 Could not open file. | |
20435 Unable to convert string to selected CodePage. | |
21106 Already connecting. If you want to reconnect, close the current connection first. | |
21118 You need to connect first. | |
21120 You cannot change the LocalHost at this time. A connection is in progress. | |
21121 Connection dropped by remote host. |
SSL Errors
20271 Cannot load specified security library. | |
20272 Cannot open certificate store. | |
20273 Cannot find specified certificate. | |
20274 Cannot acquire security credentials. | |
20275 Cannot find certificate chain. | |
20276 Cannot verify certificate chain. | |
20277 Error during handshake. | |
20281 Error verifying certificate. | |
20282 Could not find client certificate. | |
20283 Could not find server certificate. | |
20284 Error encrypting data. | |
20285 Error decrypting data. |
TCP/IP Errors
25005 [10004] Interrupted system call. | |
25010 [10009] Bad file number. | |
25014 [10013] Access denied. | |
25015 [10014] Bad address. | |
25023 [10022] Invalid argument. | |
25025 [10024] Too many open files. | |
25036 [10035] Operation would block. | |
25037 [10036] Operation now in progress. | |
25038 [10037] Operation already in progress. | |
25039 [10038] Socket operation on non-socket. | |
25040 [10039] Destination address required. | |
25041 [10040] Message too long. | |
25042 [10041] Protocol wrong type for socket. | |
25043 [10042] Bad protocol option. | |
25044 [10043] Protocol not supported. | |
25045 [10044] Socket type not supported. | |
25046 [10045] Operation not supported on socket. | |
25047 [10046] Protocol family not supported. | |
25048 [10047] Address family not supported by protocol family. | |
25049 [10048] Address already in use. | |
25050 [10049] Can't assign requested address. | |
25051 [10050] Network is down. | |
25052 [10051] Network is unreachable. | |
25053 [10052] Net dropped connection or reset. | |
25054 [10053] Software caused connection abort. | |
25055 [10054] Connection reset by peer. | |
25056 [10055] No buffer space available. | |
25057 [10056] Socket is already connected. | |
25058 [10057] Socket is not connected. | |
25059 [10058] Can't send after socket shutdown. | |
25060 [10059] Too many references, can't splice. | |
25061 [10060] Connection timed out. | |
25062 [10061] Connection refused. | |
25063 [10062] Too many levels of symbolic links. | |
25064 [10063] File name too long. | |
25065 [10064] Host is down. | |
25066 [10065] No route to host. | |
25067 [10066] Directory not empty | |
25068 [10067] Too many processes. | |
25069 [10068] Too many users. | |
25070 [10069] Disc Quota Exceeded. | |
25071 [10070] Stale NFS file handle. | |
25072 [10071] Too many levels of remote in path. | |
25092 [10091] Network subsystem is unavailable. | |
25093 [10092] WINSOCK DLL Version out of range. | |
25094 [10093] Winsock not loaded yet. | |
26002 [11001] Host not found. | |
26003 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
26004 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
26005 [11004] Valid name, no data record (check DNS setup). |