AMQPClassic Class
Properties Methods Events Config Settings Errors
An easy-to-use AMQP 0.9.1 client implementation, with support for RabbitMQ extensions.
Class Name
IPWorksIoT_AMQPClassic
Procedural Interface
ipworksiot_amqpclassic_open(); ipworksiot_amqpclassic_close($res); ipworksiot_amqpclassic_register_callback($res, $id, $function); ipworksiot_amqpclassic_get_last_error($res); ipworksiot_amqpclassic_get_last_error_code($res); ipworksiot_amqpclassic_set($res, $id, $index, $value); ipworksiot_amqpclassic_get($res, $id, $index); ipworksiot_amqpclassic_do_bindqueue($res, $channelname, $queuename, $exchangename, $routingkey, $nowait); ipworksiot_amqpclassic_do_cancelconsume($res, $channelname, $consumertag, $nowait); ipworksiot_amqpclassic_do_closechannel($res, $channelname); ipworksiot_amqpclassic_do_committransaction($res, $channelname); ipworksiot_amqpclassic_do_config($res, $configurationstring); ipworksiot_amqpclassic_do_connect($res); ipworksiot_amqpclassic_do_connectto($res, $host, $port); ipworksiot_amqpclassic_do_consume($res, $channelname, $queuename, $consumertag, $nolocal, $noack, $exclusive, $nowait); ipworksiot_amqpclassic_do_createchannel($res, $channelname); ipworksiot_amqpclassic_do_declareexchange($res, $channelname, $exchangename, $exchangetype, $passive, $durable, $autodelete, $nowait); ipworksiot_amqpclassic_do_declarequeue($res, $channelname, $queuename, $passive, $durable, $exclusive, $autodelete, $nowait); ipworksiot_amqpclassic_do_deleteexchange($res, $channelname, $exchangename, $ifunused, $nowait); ipworksiot_amqpclassic_do_deletequeue($res, $channelname, $queuename, $ifunused, $ifempty, $nowait); ipworksiot_amqpclassic_do_disconnect($res); ipworksiot_amqpclassic_do_doevents($res); ipworksiot_amqpclassic_do_enablepublishconfirms($res, $channelname, $nowait); ipworksiot_amqpclassic_do_enabletransactionmode($res, $channelname); ipworksiot_amqpclassic_do_interrupt($res); ipworksiot_amqpclassic_do_publishmessage($res, $channelname, $exchangename, $routingkey, $mandatory, $immediate); ipworksiot_amqpclassic_do_purgequeue($res, $channelname, $queuename, $nowait); ipworksiot_amqpclassic_do_recover($res, $channelname, $requeue); ipworksiot_amqpclassic_do_reset($res); ipworksiot_amqpclassic_do_resetmessage($res); ipworksiot_amqpclassic_do_retrievemessage($res, $channelname, $queuename, $noack); ipworksiot_amqpclassic_do_rollbacktransaction($res, $channelname); ipworksiot_amqpclassic_do_setchannelaccept($res, $channelname, $accept); ipworksiot_amqpclassic_do_setqos($res, $channelname, $prefetchsize, $prefetchcount, $global); ipworksiot_amqpclassic_do_unbindqueue($res, $channelname, $queuename, $exchangename, $routingkey);
Remarks
The AMQPClassic class provides an easy-to-use AMQP 0.9.1 client implementation, and it also supports certain RabbitMQ extensions to the AMQP 0.9.1 specification. The class supports both plaintext and TLS-enabled connections over TCP.
Connecting
The AMQP 0.9.1 transport protocol has two layers: an overall connection between the client and server, and one or more channels running over that connection.
The class implements both layers, so the first step is to initiate the overall connection. Set the AuthScheme, User, Password, SSLEnabled, and VirtualHost properties if necessary, then call the ConnectTo method, passing it the server's hostname and port number. (If the server in question is not running RabbitMQ, disabling the RabbitMQCompatible configuration setting before connecting is also recommended.)
The next step is to create at least one channel, which can be accomplished by using the CreateChannel method. The class allows creating any number of channels, up to the limit specified by the MaxChannelCount configuration setting.
Connecting and Creating a Channel
// The examples in this documentation use a RabbitMQ server, which requires SASL Plain auth.
amqpc1.AuthScheme = AmqpclassicAuthSchemes.smSASLPlain;
amqpc1.User = "guest";
amqpc1.Password = "guest";
amqpc1.SSLEnabled = true;
amqpc1.ConnectTo("amqpclassic.test-server.com", 5671);
amqpc1.CreateChannel("channel");
Once the class has connected to the server, and one or more channels have been opened, the class can begin manipulating exchanges and queues, publishing messages, and creating consumers.
Note that most AMQP 0.9.1 operations can themselves vary in their complexity. The examples below are intentionally simple for the sake of clarity and brevity, but links are provided for many other parts of the class's API where more detail can be found.
Declaring Exchanges
The DeclareExchange method is used to declare (i.e., create, or verify the existence of) exchanges on the server. While all AMQP servers provide a default, direct-type exchange that all queues are bound to automatically (using their name as the routing key), more complex use-cases will often require creating additional exchanges of varying types.
Declaring an Exchange
// Declare a direct-type exchange.
amqpc1.DeclareExchange("channel", "MyExchange", "direct", false, false, false, false);
Exchanges can also be deleted using the DeleteExchange method.
Declaring Queues
The DeclareQueue method is used to declare (i.e., create, or verify the existence of) queues on the server. Unlike with exchanges, the server does not provide any queues by default, so declaring a queue is always necessary (unless one has already been created by another client, or configured ahead-of-time on the server itself).
Declaring a Queue
// Declare a queue.
amqpc1.DeclareQueue("channel", "MyQueue", false, false, false, false, false);
Queues may also be deleted or purged using the DeleteQueue and PurgeQueue methods.
Binding Queues to Exchanges
The BindQueue method is used to bind a queue to an exchange. Exchanges use the information held by their queue bindings to determine which messages to forward to which queues.
Note that all AMQP 0.9.1 servers automatically bind all queues to their default exchange (which is always a direct exchange with no name) using each queue's name as the binding's routing key. This makes it easy to send a message to a specific queue without having to declare bindings; just call PublishMessage, pass empty string for ExchangeName, and the name of the desired queue for RoutingKey.
Binding a Queue to an Exchange
// Bind a queue to an exchange. Messages will only be delivered to the queue if their routing key is "MyRoutingKey".
amqpc1.BindQueue("channel", "MyQueue", "MyExchange", "MyRoutingKey", false);
Queues can also be unbound from exchanges using the UnbindQueue method.
Publishing Messages
To publish a message, populate the Message property's properties, and then call the PublishMessage method.
Publishing a Message
amqpc1.Message.Body = "Hello, world!";
// Publish a message to the server's default (no-name) exchange, using the name of a specific queue as the routing key.
amqpc1.PublishMessage("channel", "", "MyQueue", false, false);
// Publish a message to the "MyExchange" exchange, using the routing key "MyRoutingKey".
amqpc1.PublishMessage("channel", "MyExchange", "MyRoutingKey", false, false);
Note that outgoing messages may be handled differently by the server if the channel they are sent over is in transaction or (for RabbitMQ only) "publish confirmations" mode. Refer to the EnableTransactionMode and EnablePublishConfirms methods for more information.
Receiving Messages
There are two possible ways for the class to receive a message:
- Messages can be asynchronously pushed to the class from the server. At any point in time, the server may push a message to the class from a queue that the Consume method has been used to attach a consumer to.
- Messages can be synchronously pulled from the server by the class. The RetrieveMessage method is used to attempt to pull (or "retrieve") messages from a specific queue.
Regardless of how they are received, all incoming messages cause the ReceivedMessage property's properties to be populated and the MessageIn event to fire.
Receiving a Message
// MessageIn event handler.
amqpc1.OnMessageIn += (s, e) => {
if (e.MessageCount == -1) {
// The server pushed a message to us asynchronously due to a consumer we created.
Console.WriteLine("The server pushed this message to us via consumer '" + e.ConsumerTag + "':");
Console.WriteLine(amqpc1.ReceivedMessage.Body);
} else if (e.DeliveryTag > 0) {
// We pulled a message from a queue with the RetrieveMessage() method.
Console.WriteLine("Message successfully pulled:");
Console.WriteLine(amqpc1.ReceivedMessage.Body);
Console.WriteLine(e.MessageCount + " messages are still available to pull.");
} else {
// We tried to pull a message, but there were none available to pull.
Console.WriteLine("No messages available to pull.");
}
};
// Attach a consumer to "MyQueue".
amqpc1.Consume("channel", "MyQueue", "consumerTag", false, true, false, false);
// Or, try to retrieve a message from "MyQueue".
amqpc1.RetrieveMessage("channel", "MyQueue", true);
Note that the MessageIn event always fires if RetrieveMessage is called successfully, even if there were no messages available to retrieve; refer to MessageIn for more information.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
ArgumentCount | The number of records in the Argument arrays. |
ArgumentName | The table property's name. |
ArgumentValue | The table property's value. |
ArgumentValueType | The table property's value type. |
AuthScheme | The authentication scheme to use when connecting. |
ChannelCount | The number of records in the Channel arrays. |
ChannelAccept | Whether the channel is currently accepting new messages from the server. |
ChannelMode | What mode the channel is operating in. |
ChannelName | The name of the channel. |
ChannelReadyToSend | Whether the channel is ready to send a message. |
ClientPropertyCount | The number of records in the ClientProperty arrays. |
ClientPropertyName | The table property's name. |
ClientPropertyValue | The table property's value. |
ClientPropertyValueType | The table property's value type. |
Connected | This property indicates whether the class is connected. |
FirewallAutoDetect | This property tells the class 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 the 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 username if authentication is to be used when connecting through a firewall. |
Heartbeat | The heartbeat timeout value. |
IncomingMessageCount | The number of records in the IncomingMessage arrays. |
IncomingMessageAppId | The Id of the application that created the message. |
IncomingMessageBody | The message body. |
IncomingMessageChannelName | The name of the channel the message is associated with. |
IncomingMessageContentEncoding | The content encoding of the message's body. |
IncomingMessageContentType | The content type (MIME type) of the message's body. |
IncomingMessageCorrelationId | The correlation Id of the message. |
IncomingMessageDeliveryMode | The delivery mode of the message. |
IncomingMessageExpiration | The time-to-live value for this message. |
IncomingMessageHeaders | Headers associated with the message. |
IncomingMessageId | The unique Id of the message. |
IncomingMessagePriority | The priority of the message. |
IncomingMessageReplyTo | The address to send replies to for the message. |
IncomingMessageTimestamp | The message's timestamp. |
IncomingMessageType | The message's type. |
IncomingMessageUserId | The identity of the user responsible for producing the message. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the class binds. |
MessageAppId | The Id of the application that created the message. |
MessageBody | The message body. |
MessageChannelName | The name of the channel the message is associated with. |
MessageContentEncoding | The content encoding of the message's body. |
MessageContentType | The content type (MIME type) of the message's body. |
MessageCorrelationId | The correlation Id of the message. |
MessageDeliveryMode | The delivery mode of the message. |
MessageExpiration | The time-to-live value for this message. |
MessageHeaders | Headers associated with the message. |
MessageId | The unique Id of the message. |
MessagePriority | The priority of the message. |
MessageReplyTo | The address to send replies to for the message. |
MessageTimestamp | The message's timestamp. |
MessageType | The message's type. |
MessageUserId | The identity of the user responsible for producing the message. |
OutgoingMessageCount | The number of records in the OutgoingMessage arrays. |
OutgoingMessageAppId | The Id of the application that created the message. |
OutgoingMessageBody | The message body. |
OutgoingMessageChannelName | The name of the channel the message is associated with. |
OutgoingMessageContentEncoding | The content encoding of the message's body. |
OutgoingMessageContentType | The content type (MIME type) of the message's body. |
OutgoingMessageCorrelationId | The correlation Id of the message. |
OutgoingMessageDeliveryMode | The delivery mode of the message. |
OutgoingMessageExpiration | The time-to-live value for this message. |
OutgoingMessageHeaders | Headers associated with the message. |
OutgoingMessageId | The unique Id of the message. |
OutgoingMessagePriority | The priority of the message. |
OutgoingMessageReplyTo | The address to send replies to for the message. |
OutgoingMessageTimestamp | The message's timestamp. |
OutgoingMessageType | The message's type. |
OutgoingMessageUserId | The identity of the user responsible for producing the message. |
Password | A password to use for SASL authentication. |
QueueMessageCount | The message count returned by various queue operations. |
ReceivedMessageAppId | The Id of the application that created the message. |
ReceivedMessageBody | The message body. |
ReceivedMessageChannelName | The name of the channel the message is associated with. |
ReceivedMessageContentEncoding | The content encoding of the message's body. |
ReceivedMessageContentType | The content type (MIME type) of the message's body. |
ReceivedMessageCorrelationId | The correlation Id of the message. |
ReceivedMessageDeliveryMode | The delivery mode of the message. |
ReceivedMessageExpiration | The time-to-live value for this message. |
ReceivedMessageHeaders | Headers associated with the message. |
ReceivedMessageId | The unique Id of the message. |
ReceivedMessagePriority | The priority of the message. |
ReceivedMessageReplyTo | The address to send replies to for the message. |
ReceivedMessageTimestamp | The message's timestamp. |
ReceivedMessageType | The message's type. |
ReceivedMessageUserId | The identity of the user responsible for producing the message. |
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. |
ServerPropertyCount | The number of records in the ServerProperty arrays. |
ServerPropertyName | The table property's name. |
ServerPropertyValue | The table property's value. |
ServerPropertyValueType | The table property's value type. |
SSLAcceptServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | This is the date the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | This is the issuer of the certificate. |
SSLAcceptServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | This is the public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | This is the name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | This is the type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | This property contains the text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | This property contains the certificate's version number. |
SSLAcceptServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLCertExpirationDate | This is the date the certificate expires. |
SSLCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | This is the issuer of the certificate. |
SSLCertPrivateKey | This is the private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | This is the public key of the certificate. |
SSLCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
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. |
SSLCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLCertUsage | This property contains the text description of UsageFlags . |
SSLCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLCertVersion | This property contains the certificate's version number. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLEnabled | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLServerCertExpirationDate | This is the date the certificate expires. |
SSLServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | This is the issuer of the certificate. |
SSLServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | This is the public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLServerCertStore | This is the name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | This is the type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLServerCertUsage | This property contains the text description of UsageFlags . |
SSLServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLServerCertVersion | This property contains the certificate's version number. |
SSLServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
Timeout | This property includes the timeout for the class. |
User | A username to use for SASL authentication. |
VirtualHost | The virtual host to connect to. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
BindQueue | Binds a queue to an exchange. |
CancelConsume | Cancels an existing consumer. |
CloseChannel | Closes a channel. |
CommitTransaction | Commits the current transaction for a channel. |
Config | Sets or retrieves a configuration setting. |
Connect | This method connects to a remote host. |
ConnectTo | This method connects to a remote host. |
Consume | Starts a new consumer for a given queue. |
CreateChannel | Creates a new channel. |
DeclareExchange | Verifies that an exchange exists, potentially creating it if necessary. |
DeclareQueue | Verifies that a queue exists, potentially creating it if necessary. |
DeleteExchange | Deletes an exchange. |
DeleteQueue | Deletes a queue. |
Disconnect | This method disconnects from the remote host. |
DoEvents | This method processes events from the internal message queue. |
EnablePublishConfirms | Enables publish confirmations mode for a channel. |
EnableTransactionMode | Enables transaction mode for a channel. |
Interrupt | Interrupt the current action and disconnects from the remote host. |
PublishMessage | Publishes a message. |
PurgeQueue | Purges all messages from a queue. |
Recover | Request that the server redeliver all messages on a given channel that have not been acknowledged. |
Reset | This method will reset the class. |
ResetMessage | Resets the Message properties. |
RetrieveMessage | Attempts to retrieve a message from a given queue. |
RollbackTransaction | Rolls back the current transaction for a channel. |
SetChannelAccept | Disables or enables message acceptance for a given channel. |
SetQoS | Requests a specific quality of service (QoS). |
UnbindQueue | Removes a previously-created queue binding. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
ChannelReadyToSend | Fires when a channel is ready to send messages. |
Connected | 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. |
Log | Fires once for each log message. |
MessageIn | Fires when a message is received; as well as when an attempt is made to fetch a message from a currently empty queue. |
MessageOut | Fires when a message is published. |
MessageReturned | Fires if a previously published message is returned by the server due to it being undeliverable. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
ConsumerTag | The consumer tag associated with the most recently created consumer. |
Locale | The desired message locale to use. |
Locales | The message locales supported by the server. |
LogLevel | The level of detail that is logged. |
MaxChannelCount | The maximum number of channels. |
MaxFrameSize | The maximum frame size. |
Mechanisms | The authentication mechanisms supported by the server. |
NackMultiple | Whether negative acknowledgments should be cumulative or not. |
ProtocolVersion | The AMQP protocol version to conform to. |
QueueConsumerCount | The consumer count associated with the most recently created (or verified) queue. |
QueueName | The queue name associated with the most recently created (or verified) queue. |
RabbitMQCompatible | Whether to operate in a mode compatible with RabbitMQ. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
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. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
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 certificates 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. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
ArgumentCount Property (IPWorksIoT_AMQPClassic Class)
The number of records in the Argument arrays.
Object Oriented Interface
public function getArgumentCount(); public function setArgumentCount($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 1 ); ipworksiot_amqpclassic_set($res, 1, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ArgumentCount - 1.This property is not available at design time.
Data Type
Integer
ArgumentName Property (IPWorksIoT_AMQPClassic Class)
The table property's name.
Object Oriented Interface
public function getArgumentName($argumentindex); public function setArgumentName($argumentindex, $value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 2 , $argumentindex); ipworksiot_amqpclassic_set($res, 2, $value , $argumentindex);
Default Value
''
Remarks
The table field's name.
This property specifies the table field's name. The name must be an ASCII string that:
- Starts with an ASCII letter, $, or $ character.
- Only contains ASCII letters, digits, underscores, $, and $ characters.
- Is unique among all sibling table field ArgumentNames.
- Is no longer than 128 characters.
The $argumentindex parameter specifies the index of the item in the array. The size of the array is controlled by the ArgumentCount property.
This property is not available at design time.
Data Type
String
ArgumentValue Property (IPWorksIoT_AMQPClassic Class)
The table property's value.
Object Oriented Interface
public function getArgumentValue($argumentindex); public function setArgumentValue($argumentindex, $value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 3 , $argumentindex); ipworksiot_amqpclassic_set($res, 3, $value , $argumentindex);
Default Value
''
Remarks
The table field's value.
This property specifies the table field's value.
The $argumentindex parameter specifies the index of the item in the array. The size of the array is controlled by the ArgumentCount property.
This property is not available at design time.
Data Type
String
ArgumentValueType Property (IPWorksIoT_AMQPClassic Class)
The table property's value type.
Object Oriented Interface
public function getArgumentValueType($argumentindex); public function setArgumentValueType($argumentindex, $value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 4 , $argumentindex); ipworksiot_amqpclassic_set($res, 4, $value , $argumentindex);
Default Value
17
Remarks
The table field's value type.
This property specifies the table field's value type (and thus, the format of the data in the ArgumentValue property). Acceptable value types are:
Value Type | JSON Value Type | Description | Value Format |
fvtBoolean (0) | boolean | Boolean | "True" or "False" |
fvtByte (1) | byte | Byte | -128 to 127 |
fvtUbyte (2) | ubyte | Unsigned byte | 0 to 255 |
fvtShort (3) | short | Short | -32768 to 32767 |
fvtUshort (4) | ushort | Unsigned short | 0 to 65535 |
fvtInt (5) | int | Integer | -2147483648 to 2147483647 |
fvtUint (6) | uint | Unsigned integer | 0 to 4294967295 |
fvtLong (7) | long | Long | -9223372036854775808 to 9223372036854775807 |
fvtUlong (8) | ulong | Unsigned long | 0 to 18446744073709551615 |
fvtFloat (9) | float | Float | IEEE 754 32-bit floating point number |
fvtDouble (10) | double | Double | IEEE 754 64-bit floating point number |
fvtDecimal (11) | decimal | Decimal | Hex-encoded byte string |
fvtSstring (12) | sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) |
fvtString (13) | string | String | String data |
fvtArray (14) | array | Array | JSON array of type-value pairs |
fvtTimestamp (15) | timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) |
fvtTable (16) | table | Table | JSON object containing name-type-value tuples |
fvtNull (17 - default) | null | Null | N/A (ArgumentValue is ignored) |
Note: The fvtUlong (8) and fvtSstring (12) value types are not supported when the RabbitMQCompatible configuration setting is enabled.
For the fvtArray (14) value type, the ArgumentValue should be specified as a JSON array of type-value pairs; for example:
[ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]
For the fvtTable (16) value type, the ArgumentValue should be specified as a JSON object containing name-type-value tuples; for example:
{ { "name": "Test1", "type": "long", "value": 12345678901234 }, { "name": "Test2", "type": "boolean", "value": "false" }, { "name": "Test3", "type": "string", "value": "This is a test." } }
Notes regarding fvtArray (14) and fvtTable (16) type ArgumentValues:
- All "type" fields in the JSON content must be set to one of the value types in the table above.
- For fvtTable (16) type ArgumentValues, all "name" fields must adhere to the rules described by the ArgumentKey documentation.
- Nesting and mixing multiple levels of arrays and tables in the JSON is allowed.
The $argumentindex parameter specifies the index of the item in the array. The size of the array is controlled by the ArgumentCount property.
This property is not available at design time.
Data Type
Integer
AuthScheme Property (IPWorksIoT_AMQPClassic Class)
The authentication scheme to use when connecting.
Object Oriented Interface
public function getAuthScheme(); public function setAuthScheme($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 5 ); ipworksiot_amqpclassic_set($res, 5, $value );
Default Value
2
Remarks
This property controls what authentication scheme the class should use when connecting to the remote host.
Valid values are:
- smNone (0)
- smSASLAnonymous (1)
- smSASLPlain (2) - Default
- smSASLExternal (3)
This property is not available at design time.
Data Type
Integer
ChannelCount Property (IPWorksIoT_AMQPClassic Class)
The number of records in the Channel arrays.
Object Oriented Interface
public function getChannelCount();
Procedural Interface
ipworksiot_amqpclassic_get($res, 6 );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ChannelCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ChannelAccept Property (IPWorksIoT_AMQPClassic Class)
Whether the channel is currently accepting new messages from the server.
Object Oriented Interface
public function getChannelAccept($channelindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 7 , $channelindex);
Default Value
true
Remarks
Whether the channel is currently accepting new messages from the server.
This property reflects whether the channel is currently accepting new messages from the server. When the channel is created, this property is True by default.
The SetChannelAccept method can be used to disable and re-enable message acceptance at any time; refer to that method for more information.
The $channelindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChannelCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ChannelMode Property (IPWorksIoT_AMQPClassic Class)
What mode the channel is operating in.
Object Oriented Interface
public function getChannelMode($channelindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 8 , $channelindex);
Default Value
0
Remarks
What mode the channel is operating in.
This property reflects what mode the channel is operating in. Possible values are:
- cmtNormal (0 - default): Normal mode.
- cmtTransactional (1): Transaction mode.
- cmtPublishConfirms (2): Publish confirmations mode.
All channels are in normal mode when they are created; there's nothing special about a channel in normal mode.
Channels can be put in transaction mode using the EnableTransactionMode method. While a channel is in transaction mode, all messages published and acknowledgements sent over it will be part of a transaction, and the server will wait to process them until the transaction is either committed or rolled back.
Channels can be put in publish confirmations mode using the EnablePublishConfirms method. While a channel is in publish confirmations mode, the server will acknowledge each message published by the class. The class will wait to fire the MessageOut event until it receives this acknowledgment. (Note that this mode is only available when the RabbitMQCompatible configuration setting is enabled.)
Note: Switching a channel to transaction or publish confirmations mode is a permanent action; the channel will then remain in that mode for the remainder of its lifetime.
The $channelindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChannelCount property.
This property is read-only and not available at design time.
Data Type
Integer
ChannelName Property (IPWorksIoT_AMQPClassic Class)
The name of the channel.
Object Oriented Interface
public function getChannelName($channelindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 9 , $channelindex);
Default Value
''
Remarks
The name of the channel.
This property reflects the name of the channel.
The $channelindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChannelCount property.
This property is read-only and not available at design time.
Data Type
String
ChannelReadyToSend Property (IPWorksIoT_AMQPClassic Class)
Whether the channel is ready to send a message.
Object Oriented Interface
public function getChannelReadyToSend($channelindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 10 , $channelindex);
Default Value
true
Remarks
Whether the channel is ready to send a message.
This property reflects whether the channel is currently ready to send a message or not.
The $channelindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChannelCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ClientPropertyCount Property (IPWorksIoT_AMQPClassic Class)
The number of records in the ClientProperty arrays.
Object Oriented Interface
public function getClientPropertyCount(); public function setClientPropertyCount($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 11 ); ipworksiot_amqpclassic_set($res, 11, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ClientPropertyCount - 1.This property is not available at design time.
Data Type
Integer
ClientPropertyName Property (IPWorksIoT_AMQPClassic Class)
The table property's name.
Object Oriented Interface
public function getClientPropertyName($clientpropertyindex); public function setClientPropertyName($clientpropertyindex, $value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 12 , $clientpropertyindex); ipworksiot_amqpclassic_set($res, 12, $value , $clientpropertyindex);
Default Value
''
Remarks
The table field's name.
This property specifies the table field's name. The name must be an ASCII string that:
- Starts with an ASCII letter, $, or $ character.
- Only contains ASCII letters, digits, underscores, $, and $ characters.
- Is unique among all sibling table field ClientPropertyNames.
- Is no longer than 128 characters.
The $clientpropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientPropertyCount property.
This property is not available at design time.
Data Type
String
ClientPropertyValue Property (IPWorksIoT_AMQPClassic Class)
The table property's value.
Object Oriented Interface
public function getClientPropertyValue($clientpropertyindex); public function setClientPropertyValue($clientpropertyindex, $value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 13 , $clientpropertyindex); ipworksiot_amqpclassic_set($res, 13, $value , $clientpropertyindex);
Default Value
''
Remarks
The table field's value.
This property specifies the table field's value.
The $clientpropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientPropertyCount property.
This property is not available at design time.
Data Type
String
ClientPropertyValueType Property (IPWorksIoT_AMQPClassic Class)
The table property's value type.
Object Oriented Interface
public function getClientPropertyValueType($clientpropertyindex); public function setClientPropertyValueType($clientpropertyindex, $value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 14 , $clientpropertyindex); ipworksiot_amqpclassic_set($res, 14, $value , $clientpropertyindex);
Default Value
17
Remarks
The table field's value type.
This property specifies the table field's value type (and thus, the format of the data in the ClientPropertyValue property). Acceptable value types are:
Value Type | JSON Value Type | Description | Value Format |
fvtBoolean (0) | boolean | Boolean | "True" or "False" |
fvtByte (1) | byte | Byte | -128 to 127 |
fvtUbyte (2) | ubyte | Unsigned byte | 0 to 255 |
fvtShort (3) | short | Short | -32768 to 32767 |
fvtUshort (4) | ushort | Unsigned short | 0 to 65535 |
fvtInt (5) | int | Integer | -2147483648 to 2147483647 |
fvtUint (6) | uint | Unsigned integer | 0 to 4294967295 |
fvtLong (7) | long | Long | -9223372036854775808 to 9223372036854775807 |
fvtUlong (8) | ulong | Unsigned long | 0 to 18446744073709551615 |
fvtFloat (9) | float | Float | IEEE 754 32-bit floating point number |
fvtDouble (10) | double | Double | IEEE 754 64-bit floating point number |
fvtDecimal (11) | decimal | Decimal | Hex-encoded byte string |
fvtSstring (12) | sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) |
fvtString (13) | string | String | String data |
fvtArray (14) | array | Array | JSON array of type-value pairs |
fvtTimestamp (15) | timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) |
fvtTable (16) | table | Table | JSON object containing name-type-value tuples |
fvtNull (17 - default) | null | Null | N/A (ClientPropertyValue is ignored) |
Note: The fvtUlong (8) and fvtSstring (12) value types are not supported when the RabbitMQCompatible configuration setting is enabled.
For the fvtArray (14) value type, the ClientPropertyValue should be specified as a JSON array of type-value pairs; for example:
[ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]
For the fvtTable (16) value type, the ClientPropertyValue should be specified as a JSON object containing name-type-value tuples; for example:
{ { "name": "Test1", "type": "long", "value": 12345678901234 }, { "name": "Test2", "type": "boolean", "value": "false" }, { "name": "Test3", "type": "string", "value": "This is a test." } }
Notes regarding fvtArray (14) and fvtTable (16) type ClientPropertyValues:
- All "type" fields in the JSON content must be set to one of the value types in the table above.
- For fvtTable (16) type ClientPropertyValues, all "name" fields must adhere to the rules described by the ClientPropertyKey documentation.
- Nesting and mixing multiple levels of arrays and tables in the JSON is allowed.
The $clientpropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientPropertyCount property.
This property is not available at design time.
Data Type
Integer
Connected Property (IPWorksIoT_AMQPClassic Class)
This property indicates whether the class is connected.
Object Oriented Interface
public function getConnected();
Procedural Interface
ipworksiot_amqpclassic_get($res, 15 );
Default Value
false
Remarks
This property indicates whether the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.
This property is read-only and not available at design time.
Data Type
Boolean
FirewallAutoDetect Property (IPWorksIoT_AMQPClassic Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Object Oriented Interface
public function getFirewallAutoDetect(); public function setFirewallAutoDetect($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 16 ); ipworksiot_amqpclassic_set($res, 16, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (IPWorksIoT_AMQPClassic Class)
This property determines the type of firewall to connect through.
Object Oriented Interface
public function getFirewallType(); public function setFirewallType($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 17 ); ipworksiot_amqpclassic_set($res, 17, $value );
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 (IPWorksIoT_AMQPClassic Class)
This property contains the name or IP address of the firewall (optional).
Object Oriented Interface
public function getFirewallHost(); public function setFirewallHost($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 18 ); ipworksiot_amqpclassic_set($res, 18, $value );
Default Value
''
Remarks
This property contains the name or IP address of the 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 class fails with an error.
Data Type
String
FirewallPassword Property (IPWorksIoT_AMQPClassic Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Object Oriented Interface
public function getFirewallPassword(); public function setFirewallPassword($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 19 ); ipworksiot_amqpclassic_set($res, 19, $value );
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 class fails with an error.
Data Type
String
FirewallPort Property (IPWorksIoT_AMQPClassic Class)
This property contains the Transmission Control Protocol (TCP) port for the firewall Host .
Object Oriented Interface
public function getFirewallPort(); public function setFirewallPort($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 20 ); ipworksiot_amqpclassic_set($res, 20, $value );
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 (IPWorksIoT_AMQPClassic Class)
This property contains a username if authentication is to be used when connecting through a firewall.
Object Oriented Interface
public function getFirewallUser(); public function setFirewallUser($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 21 ); ipworksiot_amqpclassic_set($res, 21, $value );
Default Value
''
Remarks
This property contains a username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
Heartbeat Property (IPWorksIoT_AMQPClassic Class)
The heartbeat timeout value.
Object Oriented Interface
public function getHeartbeat(); public function setHeartbeat($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 22 ); ipworksiot_amqpclassic_set($res, 22, $value );
Default Value
0
Remarks
This property specifies the heartbeat timeout value, in seconds. Heartbeats are disabled if set to 0 (default).
Before connecting, this property can be set to indicate the desired heartbeat timeout value. During the connection process, the class and the server will compare their desired heartbeat values and choose the lower one.
Once connected, this property will reflect the agreed-upon heartbeat value. While the connection is idle, heartbeats are sent by both the class and the server approximately once every (Heartbeat / 2) seconds. If either side has not received a heartbeat (or other transmission) for ~Heartbeat seconds, it will consider the other side unreachable and close the connection.
This setting cannot be changed while connected.
This property is not available at design time.
Data Type
Integer
IncomingMessageCount Property (IPWorksIoT_AMQPClassic Class)
The number of records in the IncomingMessage arrays.
Object Oriented Interface
public function getIncomingMessageCount();
Procedural Interface
ipworksiot_amqpclassic_get($res, 23 );
Default Value
0
Remarks
This property controls the size of the following arrays:
- IncomingMessageAppId
- IncomingMessageBody
- IncomingMessageChannelName
- IncomingMessageContentEncoding
- IncomingMessageContentType
- IncomingMessageCorrelationId
- IncomingMessageDeliveryMode
- IncomingMessageExpiration
- IncomingMessageHeaders
- IncomingMessageId
- IncomingMessagePriority
- IncomingMessageReplyTo
- IncomingMessageTimestamp
- IncomingMessageType
- IncomingMessageUserId
This property is read-only and not available at design time.
Data Type
Integer
IncomingMessageAppId Property (IPWorksIoT_AMQPClassic Class)
The Id of the application that created the message.
Object Oriented Interface
public function getIncomingMessageAppId($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 24 , $incomingmessageindex);
Default Value
''
Remarks
The Id of the application that created the message.
This property holds the Id of the application that created the message. It may be empty if the message does not have an application Id set.
This value must be specified as a string no longer than 255 characters.
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
IncomingMessageBody Property (IPWorksIoT_AMQPClassic Class)
The message body.
Object Oriented Interface
public function getIncomingMessageBody($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 25 , $incomingmessageindex);
Default Value
''
Remarks
The message body.
This property holds the body of the message. It may be empty.
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
Binary String
IncomingMessageChannelName Property (IPWorksIoT_AMQPClassic Class)
The name of the channel the message is associated with.
Object Oriented Interface
public function getIncomingMessageChannelName($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 26 , $incomingmessageindex);
Default Value
''
Remarks
The name of the channel the message is associated with.
This property reflects the name of the channel which the message is associated with; it is populated automatically by the class.
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
IncomingMessageContentEncoding Property (IPWorksIoT_AMQPClassic Class)
The content encoding of the message's body.
Object Oriented Interface
public function getIncomingMessageContentEncoding($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 27 , $incomingmessageindex);
Default Value
''
Remarks
The content encoding of the message's body.
This property holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set.
This value must be specified as a string no longer than 255 characters.
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 (IPWorksIoT_AMQPClassic Class)
The content type (MIME type) of the message's body.
Object Oriented Interface
public function getIncomingMessageContentType($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 28 , $incomingmessageindex);
Default Value
''
Remarks
The content type (MIME type) of the message's body.
This property holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set.
This value must be specified as a string no longer than 255 characters.
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 (IPWorksIoT_AMQPClassic Class)
The correlation Id of the message.
Object Oriented Interface
public function getIncomingMessageCorrelationId($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 29 , $incomingmessageindex);
Default Value
''
Remarks
The correlation Id of the message.
This property holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set.
This value must be specified as a string no longer than 255 characters.
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
IncomingMessageDeliveryMode Property (IPWorksIoT_AMQPClassic Class)
The delivery mode of the message.
Object Oriented Interface
public function getIncomingMessageDeliveryMode($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 30 , $incomingmessageindex);
Default Value
0
Remarks
The delivery mode of the message.
This property holds the delivery mode of the message; possible values are:
- 0: Unspecified.
- 1: Non-persistent; the message may be lost if the server encounters an error.
- 2: Persistent; the message will not be lost, even in case of server errors.
The default is 0, which indicates that the message does not have an explicit delivery mode set.
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
IncomingMessageExpiration Property (IPWorksIoT_AMQPClassic Class)
The time-to-live value for this message.
Object Oriented Interface
public function getIncomingMessageExpiration($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 31 , $incomingmessageindex);
Default Value
''
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
String
IncomingMessageHeaders Property (IPWorksIoT_AMQPClassic Class)
Headers associated with the message.
Object Oriented Interface
public function getIncomingMessageHeaders($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 32 , $incomingmessageindex);
Default Value
''
Remarks
Headers associated with the message.
This property holds additional Headers associated with the message. It may be empty if the message does not have any headers set.
This property must be specified as a JSON object containing name-type-value tuples; for example:
[ { "name": "Header1", "type": "long", "value": 12345678901234 }, { "name": "Header2", "type": "boolean", "value": "false" }, { "name": "Header3", "type": "string", "value": "This is a test." } ]
All "name" values must be ASCII strings that:
- Start with an ASCII letter, $, or $ character.
- Only contain ASCII letters, digits, underscores, $, and $ characters.
- Are unique among their siblings.
- Are no longer than 128 characters.
The following table describes all valid "type" values, and how to format the "value" field for each:
JSON Value Type | Description | Value Format |
boolean | Boolean | "True" or "False" |
byte | Byte | -128 to 127 |
ubyte | Unsigned byte | 0 to 255 |
short | Short | -32768 to 32767 |
ushort | Unsigned short | 0 to 65535 |
int | Integer | -2147483648 to 2147483647 |
uint | Unsigned integer | 0 to 4294967295 |
long | Long | -9223372036854775808 to 9223372036854775807 |
ulong | Unsigned long | 0 to 18446744073709551615 |
float | Float | IEEE 754 32-bit floating point number |
double | Double | IEEE 754 64-bit floating point number |
decimal | Decimal | Hex-encoded byte string |
sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) |
string | String | String data |
array | Array | JSON array of type-value pairs |
timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) |
table | Table | JSON object containing name-type-value tuples |
null | Null | N/A (IncomingMessageValue is ignored) |
Note: The ulong and sstring value types are not supported when the RabbitMQCompatible configuration setting is enabled.
Headers of the table type should be specified in the same manner as shown above, while headers of the array type should be specified as a JSON array of type-value pairs; for example:
[ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]
Nesting and mixing multiple levels of arrays and tables is allowed.
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 (IPWorksIoT_AMQPClassic Class)
The unique Id of the message.
Object Oriented Interface
public function getIncomingMessageId($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 33 , $incomingmessageindex);
Default Value
''
Remarks
The unique Id of the message.
This property holds the unique Id of the message. It may be empty if the message does not have a unique Id.
This value must be specified as a string no longer than 255 characters.
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 (IPWorksIoT_AMQPClassic Class)
The priority of the message.
Object Oriented Interface
public function getIncomingMessagePriority($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 34 , $incomingmessageindex);
Default Value
0
Remarks
The priority of the message.
This property holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent.
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 (IPWorksIoT_AMQPClassic Class)
The address to send replies to for the message.
Object Oriented Interface
public function getIncomingMessageReplyTo($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 35 , $incomingmessageindex);
Default Value
''
Remarks
The address to send replies to for the message.
This property specifies the address to send replies to for the message. It may be empty if the message does not have a specific reply-to address set.
This value must be specified as a string no longer than 255 characters.
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
IncomingMessageTimestamp Property (IPWorksIoT_AMQPClassic Class)
The message's timestamp.
Object Oriented Interface
public function getIncomingMessageTimestamp($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 36 , $incomingmessageindex);
Default Value
0
Remarks
The message's timestamp.
This property holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set.
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
IncomingMessageType Property (IPWorksIoT_AMQPClassic Class)
The message's type.
Object Oriented Interface
public function getIncomingMessageType($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 37 , $incomingmessageindex);
Default Value
''
Remarks
The message's type.
This property holds the type of the message. It may be empty if the message does not have a type set.
This value must be specified as a string no longer than 255 characters.
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
IncomingMessageUserId Property (IPWorksIoT_AMQPClassic Class)
The identity of the user responsible for producing the message.
Object Oriented Interface
public function getIncomingMessageUserId($incomingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 38 , $incomingmessageindex);
Default Value
''
Remarks
The identity of the user responsible for producing the message.
This property specifies the identity of the user responsible for producing the message. It may be empty if no specific user was responsible for creating the message.
A message's user Id may be used for verification or authentication by the server and/or the final consumer.
This value must be specified as a string no longer than 255 characters.
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
LocalHost Property (IPWorksIoT_AMQPClassic Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Object Oriented Interface
public function getLocalHost(); public function setLocalHost($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 39 ); ipworksiot_amqpclassic_set($res, 39, $value );
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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
LocalPort Property (IPWorksIoT_AMQPClassic Class)
The TCP port in the local host where the class binds.
Object Oriented Interface
public function getLocalPort(); public function setLocalPort($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 40 ); ipworksiot_amqpclassic_set($res, 40, $value );
Default Value
0
Remarks
This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.
Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.
This property is useful when trying to connect to services that require a trusted port on the client side.
Data Type
Integer
MessageAppId Property (IPWorksIoT_AMQPClassic Class)
The Id of the application that created the message.
Object Oriented Interface
public function getMessageAppId(); public function setMessageAppId($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 41 ); ipworksiot_amqpclassic_set($res, 41, $value );
Default Value
''
Remarks
The Id of the application that created the message.
This property holds the Id of the application that created the message. It may be empty if the message does not have an application Id set.
This value must be specified as a string no longer than 255 characters.
This property is not available at design time.
Data Type
String
MessageBody Property (IPWorksIoT_AMQPClassic Class)
The message body.
Object Oriented Interface
public function getMessageBody(); public function setMessageBody($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 42 ); ipworksiot_amqpclassic_set($res, 42, $value );
Default Value
''
Remarks
The message body.
This property holds the body of the message. It may be empty.
This property is not available at design time.
Data Type
Binary String
MessageChannelName Property (IPWorksIoT_AMQPClassic Class)
The name of the channel the message is associated with.
Object Oriented Interface
public function getMessageChannelName();
Procedural Interface
ipworksiot_amqpclassic_get($res, 43 );
Default Value
''
Remarks
The name of the channel the message is associated with.
This property reflects the name of the channel which the message is associated with; it is populated automatically by the class.
This property is read-only and not available at design time.
Data Type
String
MessageContentEncoding Property (IPWorksIoT_AMQPClassic Class)
The content encoding of the message's body.
Object Oriented Interface
public function getMessageContentEncoding(); public function setMessageContentEncoding($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 44 ); ipworksiot_amqpclassic_set($res, 44, $value );
Default Value
''
Remarks
The content encoding of the message's body.
This property holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set.
This value must be specified as a string no longer than 255 characters.
This property is not available at design time.
Data Type
String
MessageContentType Property (IPWorksIoT_AMQPClassic Class)
The content type (MIME type) of the message's body.
Object Oriented Interface
public function getMessageContentType(); public function setMessageContentType($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 45 ); ipworksiot_amqpclassic_set($res, 45, $value );
Default Value
''
Remarks
The content type (MIME type) of the message's body.
This property holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set.
This value must be specified as a string no longer than 255 characters.
This property is not available at design time.
Data Type
String
MessageCorrelationId Property (IPWorksIoT_AMQPClassic Class)
The correlation Id of the message.
Object Oriented Interface
public function getMessageCorrelationId(); public function setMessageCorrelationId($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 46 ); ipworksiot_amqpclassic_set($res, 46, $value );
Default Value
''
Remarks
The correlation Id of the message.
This property holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set.
This value must be specified as a string no longer than 255 characters.
This property is not available at design time.
Data Type
String
MessageDeliveryMode Property (IPWorksIoT_AMQPClassic Class)
The delivery mode of the message.
Object Oriented Interface
public function getMessageDeliveryMode(); public function setMessageDeliveryMode($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 47 ); ipworksiot_amqpclassic_set($res, 47, $value );
Default Value
0
Remarks
The delivery mode of the message.
This property holds the delivery mode of the message; possible values are:
- 0: Unspecified.
- 1: Non-persistent; the message may be lost if the server encounters an error.
- 2: Persistent; the message will not be lost, even in case of server errors.
The default is 0, which indicates that the message does not have an explicit delivery mode set.
This property is not available at design time.
Data Type
Integer
MessageExpiration Property (IPWorksIoT_AMQPClassic Class)
The time-to-live value for this message.
Object Oriented Interface
public function getMessageExpiration(); public function setMessageExpiration($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 48 ); ipworksiot_amqpclassic_set($res, 48, $value );
Default Value
''
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
String
MessageHeaders Property (IPWorksIoT_AMQPClassic Class)
Headers associated with the message.
Object Oriented Interface
public function getMessageHeaders(); public function setMessageHeaders($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 49 ); ipworksiot_amqpclassic_set($res, 49, $value );
Default Value
''
Remarks
Headers associated with the message.
This property holds additional Headers associated with the message. It may be empty if the message does not have any headers set.
This property must be specified as a JSON object containing name-type-value tuples; for example:
[ { "name": "Header1", "type": "long", "value": 12345678901234 }, { "name": "Header2", "type": "boolean", "value": "false" }, { "name": "Header3", "type": "string", "value": "This is a test." } ]
All "name" values must be ASCII strings that:
- Start with an ASCII letter, $, or $ character.
- Only contain ASCII letters, digits, underscores, $, and $ characters.
- Are unique among their siblings.
- Are no longer than 128 characters.
The following table describes all valid "type" values, and how to format the "value" field for each:
JSON Value Type | Description | Value Format |
boolean | Boolean | "True" or "False" |
byte | Byte | -128 to 127 |
ubyte | Unsigned byte | 0 to 255 |
short | Short | -32768 to 32767 |
ushort | Unsigned short | 0 to 65535 |
int | Integer | -2147483648 to 2147483647 |
uint | Unsigned integer | 0 to 4294967295 |
long | Long | -9223372036854775808 to 9223372036854775807 |
ulong | Unsigned long | 0 to 18446744073709551615 |
float | Float | IEEE 754 32-bit floating point number |
double | Double | IEEE 754 64-bit floating point number |
decimal | Decimal | Hex-encoded byte string |
sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) |
string | String | String data |
array | Array | JSON array of type-value pairs |
timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) |
table | Table | JSON object containing name-type-value tuples |
null | Null | N/A (MessageValue is ignored) |
Note: The ulong and sstring value types are not supported when the RabbitMQCompatible configuration setting is enabled.
Headers of the table type should be specified in the same manner as shown above, while headers of the array type should be specified as a JSON array of type-value pairs; for example:
[ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]
Nesting and mixing multiple levels of arrays and tables is allowed.
This property is not available at design time.
Data Type
String
MessageId Property (IPWorksIoT_AMQPClassic Class)
The unique Id of the message.
Object Oriented Interface
public function getMessageId(); public function setMessageId($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 50 ); ipworksiot_amqpclassic_set($res, 50, $value );
Default Value
''
Remarks
The unique Id of the message.
This property holds the unique Id of the message. It may be empty if the message does not have a unique Id.
This value must be specified as a string no longer than 255 characters.
This property is not available at design time.
Data Type
String
MessagePriority Property (IPWorksIoT_AMQPClassic Class)
The priority of the message.
Object Oriented Interface
public function getMessagePriority(); public function setMessagePriority($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 51 ); ipworksiot_amqpclassic_set($res, 51, $value );
Default Value
0
Remarks
The priority of the message.
This property holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent.
This property is not available at design time.
Data Type
Integer
MessageReplyTo Property (IPWorksIoT_AMQPClassic Class)
The address to send replies to for the message.
Object Oriented Interface
public function getMessageReplyTo(); public function setMessageReplyTo($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 52 ); ipworksiot_amqpclassic_set($res, 52, $value );
Default Value
''
Remarks
The address to send replies to for the message.
This property specifies the address to send replies to for the message. It may be empty if the message does not have a specific reply-to address set.
This value must be specified as a string no longer than 255 characters.
This property is not available at design time.
Data Type
String
MessageTimestamp Property (IPWorksIoT_AMQPClassic Class)
The message's timestamp.
Object Oriented Interface
public function getMessageTimestamp(); public function setMessageTimestamp($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 53 ); ipworksiot_amqpclassic_set($res, 53, $value );
Default Value
0
Remarks
The message's timestamp.
This property holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set.
This property is not available at design time.
Data Type
Long64
MessageType Property (IPWorksIoT_AMQPClassic Class)
The message's type.
Object Oriented Interface
public function getMessageType(); public function setMessageType($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 54 ); ipworksiot_amqpclassic_set($res, 54, $value );
Default Value
''
Remarks
The message's type.
This property holds the type of the message. It may be empty if the message does not have a type set.
This value must be specified as a string no longer than 255 characters.
This property is not available at design time.
Data Type
String
MessageUserId Property (IPWorksIoT_AMQPClassic Class)
The identity of the user responsible for producing the message.
Object Oriented Interface
public function getMessageUserId(); public function setMessageUserId($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 55 ); ipworksiot_amqpclassic_set($res, 55, $value );
Default Value
''
Remarks
The identity of the user responsible for producing the message.
This property specifies the identity of the user responsible for producing the message. It may be empty if no specific user was responsible for creating the message.
A message's user Id may be used for verification or authentication by the server and/or the final consumer.
This value must be specified as a string no longer than 255 characters.
This property is not available at design time.
Data Type
String
OutgoingMessageCount Property (IPWorksIoT_AMQPClassic Class)
The number of records in the OutgoingMessage arrays.
Object Oriented Interface
public function getOutgoingMessageCount();
Procedural Interface
ipworksiot_amqpclassic_get($res, 56 );
Default Value
0
Remarks
This property controls the size of the following arrays:
- OutgoingMessageAppId
- OutgoingMessageBody
- OutgoingMessageChannelName
- OutgoingMessageContentEncoding
- OutgoingMessageContentType
- OutgoingMessageCorrelationId
- OutgoingMessageDeliveryMode
- OutgoingMessageExpiration
- OutgoingMessageHeaders
- OutgoingMessageId
- OutgoingMessagePriority
- OutgoingMessageReplyTo
- OutgoingMessageTimestamp
- OutgoingMessageType
- OutgoingMessageUserId
This property is read-only and not available at design time.
Data Type
Integer
OutgoingMessageAppId Property (IPWorksIoT_AMQPClassic Class)
The Id of the application that created the message.
Object Oriented Interface
public function getOutgoingMessageAppId($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 57 , $outgoingmessageindex);
Default Value
''
Remarks
The Id of the application that created the message.
This property holds the Id of the application that created the message. It may be empty if the message does not have an application Id set.
This value must be specified as a string no longer than 255 characters.
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
OutgoingMessageBody Property (IPWorksIoT_AMQPClassic Class)
The message body.
Object Oriented Interface
public function getOutgoingMessageBody($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 58 , $outgoingmessageindex);
Default Value
''
Remarks
The message body.
This property holds the body of the message. It may be empty.
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
Binary String
OutgoingMessageChannelName Property (IPWorksIoT_AMQPClassic Class)
The name of the channel the message is associated with.
Object Oriented Interface
public function getOutgoingMessageChannelName($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 59 , $outgoingmessageindex);
Default Value
''
Remarks
The name of the channel the message is associated with.
This property reflects the name of the channel which the message is associated with; it is populated automatically by the class.
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
OutgoingMessageContentEncoding Property (IPWorksIoT_AMQPClassic Class)
The content encoding of the message's body.
Object Oriented Interface
public function getOutgoingMessageContentEncoding($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 60 , $outgoingmessageindex);
Default Value
''
Remarks
The content encoding of the message's body.
This property holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set.
This value must be specified as a string no longer than 255 characters.
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 (IPWorksIoT_AMQPClassic Class)
The content type (MIME type) of the message's body.
Object Oriented Interface
public function getOutgoingMessageContentType($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 61 , $outgoingmessageindex);
Default Value
''
Remarks
The content type (MIME type) of the message's body.
This property holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set.
This value must be specified as a string no longer than 255 characters.
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 (IPWorksIoT_AMQPClassic Class)
The correlation Id of the message.
Object Oriented Interface
public function getOutgoingMessageCorrelationId($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 62 , $outgoingmessageindex);
Default Value
''
Remarks
The correlation Id of the message.
This property holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set.
This value must be specified as a string no longer than 255 characters.
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
OutgoingMessageDeliveryMode Property (IPWorksIoT_AMQPClassic Class)
The delivery mode of the message.
Object Oriented Interface
public function getOutgoingMessageDeliveryMode($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 63 , $outgoingmessageindex);
Default Value
0
Remarks
The delivery mode of the message.
This property holds the delivery mode of the message; possible values are:
- 0: Unspecified.
- 1: Non-persistent; the message may be lost if the server encounters an error.
- 2: Persistent; the message will not be lost, even in case of server errors.
The default is 0, which indicates that the message does not have an explicit delivery mode set.
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
OutgoingMessageExpiration Property (IPWorksIoT_AMQPClassic Class)
The time-to-live value for this message.
Object Oriented Interface
public function getOutgoingMessageExpiration($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 64 , $outgoingmessageindex);
Default Value
''
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
String
OutgoingMessageHeaders Property (IPWorksIoT_AMQPClassic Class)
Headers associated with the message.
Object Oriented Interface
public function getOutgoingMessageHeaders($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 65 , $outgoingmessageindex);
Default Value
''
Remarks
Headers associated with the message.
This property holds additional Headers associated with the message. It may be empty if the message does not have any headers set.
This property must be specified as a JSON object containing name-type-value tuples; for example:
[ { "name": "Header1", "type": "long", "value": 12345678901234 }, { "name": "Header2", "type": "boolean", "value": "false" }, { "name": "Header3", "type": "string", "value": "This is a test." } ]
All "name" values must be ASCII strings that:
- Start with an ASCII letter, $, or $ character.
- Only contain ASCII letters, digits, underscores, $, and $ characters.
- Are unique among their siblings.
- Are no longer than 128 characters.
The following table describes all valid "type" values, and how to format the "value" field for each:
JSON Value Type | Description | Value Format |
boolean | Boolean | "True" or "False" |
byte | Byte | -128 to 127 |
ubyte | Unsigned byte | 0 to 255 |
short | Short | -32768 to 32767 |
ushort | Unsigned short | 0 to 65535 |
int | Integer | -2147483648 to 2147483647 |
uint | Unsigned integer | 0 to 4294967295 |
long | Long | -9223372036854775808 to 9223372036854775807 |
ulong | Unsigned long | 0 to 18446744073709551615 |
float | Float | IEEE 754 32-bit floating point number |
double | Double | IEEE 754 64-bit floating point number |
decimal | Decimal | Hex-encoded byte string |
sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) |
string | String | String data |
array | Array | JSON array of type-value pairs |
timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) |
table | Table | JSON object containing name-type-value tuples |
null | Null | N/A (OutgoingMessageValue is ignored) |
Note: The ulong and sstring value types are not supported when the RabbitMQCompatible configuration setting is enabled.
Headers of the table type should be specified in the same manner as shown above, while headers of the array type should be specified as a JSON array of type-value pairs; for example:
[ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]
Nesting and mixing multiple levels of arrays and tables is allowed.
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 (IPWorksIoT_AMQPClassic Class)
The unique Id of the message.
Object Oriented Interface
public function getOutgoingMessageId($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 66 , $outgoingmessageindex);
Default Value
''
Remarks
The unique Id of the message.
This property holds the unique Id of the message. It may be empty if the message does not have a unique Id.
This value must be specified as a string no longer than 255 characters.
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 (IPWorksIoT_AMQPClassic Class)
The priority of the message.
Object Oriented Interface
public function getOutgoingMessagePriority($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 67 , $outgoingmessageindex);
Default Value
0
Remarks
The priority of the message.
This property holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent.
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 (IPWorksIoT_AMQPClassic Class)
The address to send replies to for the message.
Object Oriented Interface
public function getOutgoingMessageReplyTo($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 68 , $outgoingmessageindex);
Default Value
''
Remarks
The address to send replies to for the message.
This property specifies the address to send replies to for the message. It may be empty if the message does not have a specific reply-to address set.
This value must be specified as a string no longer than 255 characters.
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
OutgoingMessageTimestamp Property (IPWorksIoT_AMQPClassic Class)
The message's timestamp.
Object Oriented Interface
public function getOutgoingMessageTimestamp($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 69 , $outgoingmessageindex);
Default Value
0
Remarks
The message's timestamp.
This property holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set.
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
OutgoingMessageType Property (IPWorksIoT_AMQPClassic Class)
The message's type.
Object Oriented Interface
public function getOutgoingMessageType($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 70 , $outgoingmessageindex);
Default Value
''
Remarks
The message's type.
This property holds the type of the message. It may be empty if the message does not have a type set.
This value must be specified as a string no longer than 255 characters.
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
OutgoingMessageUserId Property (IPWorksIoT_AMQPClassic Class)
The identity of the user responsible for producing the message.
Object Oriented Interface
public function getOutgoingMessageUserId($outgoingmessageindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 71 , $outgoingmessageindex);
Default Value
''
Remarks
The identity of the user responsible for producing the message.
This property specifies the identity of the user responsible for producing the message. It may be empty if no specific user was responsible for creating the message.
A message's user Id may be used for verification or authentication by the server and/or the final consumer.
This value must be specified as a string no longer than 255 characters.
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
Password Property (IPWorksIoT_AMQPClassic Class)
A password to use for SASL authentication.
Object Oriented Interface
public function getPassword(); public function setPassword($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 72 ); ipworksiot_amqpclassic_set($res, 72, $value );
Default Value
''
Remarks
This property contains a password to use for SASL authentication.
This property is not available at design time.
Data Type
String
QueueMessageCount Property (IPWorksIoT_AMQPClassic Class)
The message count returned by various queue operations.
Object Oriented Interface
public function getQueueMessageCount();
Procedural Interface
ipworksiot_amqpclassic_get($res, 73 );
Default Value
0
Remarks
This property is populated with a message count after calling certain queue-related methods.
After calling... | This property will reflect... |
DeclareQueue | The number of messages currently in the queue. |
PurgeQueue | The number of messages purged from the queue. |
DeleteQueue | THe number of messages deleted along with the queue. |
This property is read-only and not available at design time.
Data Type
Integer
ReceivedMessageAppId Property (IPWorksIoT_AMQPClassic Class)
The Id of the application that created the message.
Object Oriented Interface
public function getReceivedMessageAppId();
Procedural Interface
ipworksiot_amqpclassic_get($res, 74 );
Default Value
''
Remarks
The Id of the application that created the message.
This property holds the Id of the application that created the message. It may be empty if the message does not have an application Id set.
This value must be specified as a string no longer than 255 characters.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageBody Property (IPWorksIoT_AMQPClassic Class)
The message body.
Object Oriented Interface
public function getReceivedMessageBody();
Procedural Interface
ipworksiot_amqpclassic_get($res, 75 );
Default Value
''
Remarks
The message body.
This property holds the body of the message. It may be empty.
This property is read-only and not available at design time.
Data Type
Binary String
ReceivedMessageChannelName Property (IPWorksIoT_AMQPClassic Class)
The name of the channel the message is associated with.
Object Oriented Interface
public function getReceivedMessageChannelName();
Procedural Interface
ipworksiot_amqpclassic_get($res, 76 );
Default Value
''
Remarks
The name of the channel the message is associated with.
This property reflects the name of the channel which the message is associated with; it is populated automatically by the class.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageContentEncoding Property (IPWorksIoT_AMQPClassic Class)
The content encoding of the message's body.
Object Oriented Interface
public function getReceivedMessageContentEncoding();
Procedural Interface
ipworksiot_amqpclassic_get($res, 77 );
Default Value
''
Remarks
The content encoding of the message's body.
This property holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set.
This value must be specified as a string no longer than 255 characters.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageContentType Property (IPWorksIoT_AMQPClassic Class)
The content type (MIME type) of the message's body.
Object Oriented Interface
public function getReceivedMessageContentType();
Procedural Interface
ipworksiot_amqpclassic_get($res, 78 );
Default Value
''
Remarks
The content type (MIME type) of the message's body.
This property holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set.
This value must be specified as a string no longer than 255 characters.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageCorrelationId Property (IPWorksIoT_AMQPClassic Class)
The correlation Id of the message.
Object Oriented Interface
public function getReceivedMessageCorrelationId();
Procedural Interface
ipworksiot_amqpclassic_get($res, 79 );
Default Value
''
Remarks
The correlation Id of the message.
This property holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set.
This value must be specified as a string no longer than 255 characters.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageDeliveryMode Property (IPWorksIoT_AMQPClassic Class)
The delivery mode of the message.
Object Oriented Interface
public function getReceivedMessageDeliveryMode();
Procedural Interface
ipworksiot_amqpclassic_get($res, 80 );
Default Value
0
Remarks
The delivery mode of the message.
This property holds the delivery mode of the message; possible values are:
- 0: Unspecified.
- 1: Non-persistent; the message may be lost if the server encounters an error.
- 2: Persistent; the message will not be lost, even in case of server errors.
The default is 0, which indicates that the message does not have an explicit delivery mode set.
This property is read-only and not available at design time.
Data Type
Integer
ReceivedMessageExpiration Property (IPWorksIoT_AMQPClassic Class)
The time-to-live value for this message.
Object Oriented Interface
public function getReceivedMessageExpiration();
Procedural Interface
ipworksiot_amqpclassic_get($res, 81 );
Default Value
''
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
String
ReceivedMessageHeaders Property (IPWorksIoT_AMQPClassic Class)
Headers associated with the message.
Object Oriented Interface
public function getReceivedMessageHeaders();
Procedural Interface
ipworksiot_amqpclassic_get($res, 82 );
Default Value
''
Remarks
Headers associated with the message.
This property holds additional Headers associated with the message. It may be empty if the message does not have any headers set.
This property must be specified as a JSON object containing name-type-value tuples; for example:
[ { "name": "Header1", "type": "long", "value": 12345678901234 }, { "name": "Header2", "type": "boolean", "value": "false" }, { "name": "Header3", "type": "string", "value": "This is a test." } ]
All "name" values must be ASCII strings that:
- Start with an ASCII letter, $, or $ character.
- Only contain ASCII letters, digits, underscores, $, and $ characters.
- Are unique among their siblings.
- Are no longer than 128 characters.
The following table describes all valid "type" values, and how to format the "value" field for each:
JSON Value Type | Description | Value Format |
boolean | Boolean | "True" or "False" |
byte | Byte | -128 to 127 |
ubyte | Unsigned byte | 0 to 255 |
short | Short | -32768 to 32767 |
ushort | Unsigned short | 0 to 65535 |
int | Integer | -2147483648 to 2147483647 |
uint | Unsigned integer | 0 to 4294967295 |
long | Long | -9223372036854775808 to 9223372036854775807 |
ulong | Unsigned long | 0 to 18446744073709551615 |
float | Float | IEEE 754 32-bit floating point number |
double | Double | IEEE 754 64-bit floating point number |
decimal | Decimal | Hex-encoded byte string |
sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) |
string | String | String data |
array | Array | JSON array of type-value pairs |
timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) |
table | Table | JSON object containing name-type-value tuples |
null | Null | N/A (ReceivedMessageValue is ignored) |
Note: The ulong and sstring value types are not supported when the RabbitMQCompatible configuration setting is enabled.
Headers of the table type should be specified in the same manner as shown above, while headers of the array type should be specified as a JSON array of type-value pairs; for example:
[ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]
Nesting and mixing multiple levels of arrays and tables is allowed.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageId Property (IPWorksIoT_AMQPClassic Class)
The unique Id of the message.
Object Oriented Interface
public function getReceivedMessageId();
Procedural Interface
ipworksiot_amqpclassic_get($res, 83 );
Default Value
''
Remarks
The unique Id of the message.
This property holds the unique Id of the message. It may be empty if the message does not have a unique Id.
This value must be specified as a string no longer than 255 characters.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessagePriority Property (IPWorksIoT_AMQPClassic Class)
The priority of the message.
Object Oriented Interface
public function getReceivedMessagePriority();
Procedural Interface
ipworksiot_amqpclassic_get($res, 84 );
Default Value
0
Remarks
The priority of the message.
This property holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent.
This property is read-only and not available at design time.
Data Type
Integer
ReceivedMessageReplyTo Property (IPWorksIoT_AMQPClassic Class)
The address to send replies to for the message.
Object Oriented Interface
public function getReceivedMessageReplyTo();
Procedural Interface
ipworksiot_amqpclassic_get($res, 85 );
Default Value
''
Remarks
The address to send replies to for the message.
This property specifies the address to send replies to for the message. It may be empty if the message does not have a specific reply-to address set.
This value must be specified as a string no longer than 255 characters.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageTimestamp Property (IPWorksIoT_AMQPClassic Class)
The message's timestamp.
Object Oriented Interface
public function getReceivedMessageTimestamp();
Procedural Interface
ipworksiot_amqpclassic_get($res, 86 );
Default Value
0
Remarks
The message's timestamp.
This property holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set.
This property is read-only and not available at design time.
Data Type
Long64
ReceivedMessageType Property (IPWorksIoT_AMQPClassic Class)
The message's type.
Object Oriented Interface
public function getReceivedMessageType();
Procedural Interface
ipworksiot_amqpclassic_get($res, 87 );
Default Value
''
Remarks
The message's type.
This property holds the type of the message. It may be empty if the message does not have a type set.
This value must be specified as a string no longer than 255 characters.
This property is read-only and not available at design time.
Data Type
String
ReceivedMessageUserId Property (IPWorksIoT_AMQPClassic Class)
The identity of the user responsible for producing the message.
Object Oriented Interface
public function getReceivedMessageUserId();
Procedural Interface
ipworksiot_amqpclassic_get($res, 88 );
Default Value
''
Remarks
The identity of the user responsible for producing the message.
This property specifies the identity of the user responsible for producing the message. It may be empty if no specific user was responsible for creating the message.
A message's user Id may be used for verification or authentication by the server and/or the final consumer.
This value must be specified as a string no longer than 255 characters.
This property is read-only and not available at design time.
Data Type
String
RemoteHost Property (IPWorksIoT_AMQPClassic Class)
This property includes the address of the remote host. Domain names are resolved to IP addresses.
Object Oriented Interface
public function getRemoteHost(); public function setRemoteHost($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 89 ); ipworksiot_amqpclassic_set($res, 89, $value );
Default Value
''
Remarks
This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.
If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.
If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.
Example. Connecting:
TCPClientControl.RemoteHost = "MyHostNameOrIP"
TCPClientControl.RemotePort = 777
TCPClientControl.Connected = true
Data Type
String
RemotePort Property (IPWorksIoT_AMQPClassic Class)
The port of the AQMP server (default is 5672). The default port for SSL is 5671.
Object Oriented Interface
public function getRemotePort(); public function setRemotePort($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 90 ); ipworksiot_amqpclassic_set($res, 90, $value );
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
ServerPropertyCount Property (IPWorksIoT_AMQPClassic Class)
The number of records in the ServerProperty arrays.
Object Oriented Interface
public function getServerPropertyCount();
Procedural Interface
ipworksiot_amqpclassic_get($res, 91 );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ServerPropertyCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ServerPropertyName Property (IPWorksIoT_AMQPClassic Class)
The table property's name.
Object Oriented Interface
public function getServerPropertyName($serverpropertyindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 92 , $serverpropertyindex);
Default Value
''
Remarks
The table field's name.
This property specifies the table field's name. The name must be an ASCII string that:
- Starts with an ASCII letter, $, or $ character.
- Only contains ASCII letters, digits, underscores, $, and $ characters.
- Is unique among all sibling table field ServerPropertyNames.
- Is no longer than 128 characters.
The $serverpropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerPropertyCount property.
This property is read-only and not available at design time.
Data Type
String
ServerPropertyValue Property (IPWorksIoT_AMQPClassic Class)
The table property's value.
Object Oriented Interface
public function getServerPropertyValue($serverpropertyindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 93 , $serverpropertyindex);
Default Value
''
Remarks
The table field's value.
This property specifies the table field's value.
The $serverpropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerPropertyCount property.
This property is read-only and not available at design time.
Data Type
String
ServerPropertyValueType Property (IPWorksIoT_AMQPClassic Class)
The table property's value type.
Object Oriented Interface
public function getServerPropertyValueType($serverpropertyindex);
Procedural Interface
ipworksiot_amqpclassic_get($res, 94 , $serverpropertyindex);
Default Value
17
Remarks
The table field's value type.
This property specifies the table field's value type (and thus, the format of the data in the ServerPropertyValue property). Acceptable value types are:
Value Type | JSON Value Type | Description | Value Format |
fvtBoolean (0) | boolean | Boolean | "True" or "False" |
fvtByte (1) | byte | Byte | -128 to 127 |
fvtUbyte (2) | ubyte | Unsigned byte | 0 to 255 |
fvtShort (3) | short | Short | -32768 to 32767 |
fvtUshort (4) | ushort | Unsigned short | 0 to 65535 |
fvtInt (5) | int | Integer | -2147483648 to 2147483647 |
fvtUint (6) | uint | Unsigned integer | 0 to 4294967295 |
fvtLong (7) | long | Long | -9223372036854775808 to 9223372036854775807 |
fvtUlong (8) | ulong | Unsigned long | 0 to 18446744073709551615 |
fvtFloat (9) | float | Float | IEEE 754 32-bit floating point number |
fvtDouble (10) | double | Double | IEEE 754 64-bit floating point number |
fvtDecimal (11) | decimal | Decimal | Hex-encoded byte string |
fvtSstring (12) | sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) |
fvtString (13) | string | String | String data |
fvtArray (14) | array | Array | JSON array of type-value pairs |
fvtTimestamp (15) | timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) |
fvtTable (16) | table | Table | JSON object containing name-type-value tuples |
fvtNull (17 - default) | null | Null | N/A (ServerPropertyValue is ignored) |
Note: The fvtUlong (8) and fvtSstring (12) value types are not supported when the RabbitMQCompatible configuration setting is enabled.
For the fvtArray (14) value type, the ServerPropertyValue should be specified as a JSON array of type-value pairs; for example:
[ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]
For the fvtTable (16) value type, the ServerPropertyValue should be specified as a JSON object containing name-type-value tuples; for example:
{ { "name": "Test1", "type": "long", "value": 12345678901234 }, { "name": "Test2", "type": "boolean", "value": "false" }, { "name": "Test3", "type": "string", "value": "This is a test." } }
Notes regarding fvtArray (14) and fvtTable (16) type ServerPropertyValues:
- All "type" fields in the JSON content must be set to one of the value types in the table above.
- For fvtTable (16) type ServerPropertyValues, all "name" fields must adhere to the rules described by the ServerPropertyKey documentation.
- Nesting and mixing multiple levels of arrays and tables in the JSON is allowed.
The $serverpropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerPropertyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SSLAcceptServerCertEffectiveDate Property (IPWorksIoT_AMQPClassic Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLAcceptServerCertEffectiveDate();
Procedural Interface
ipworksiot_amqpclassic_get($res, 95 );
Default Value
''
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExpirationDate Property (IPWorksIoT_AMQPClassic Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLAcceptServerCertExpirationDate();
Procedural Interface
ipworksiot_amqpclassic_get($res, 96 );
Default Value
''
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExtendedKeyUsage Property (IPWorksIoT_AMQPClassic Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLAcceptServerCertExtendedKeyUsage();
Procedural Interface
ipworksiot_amqpclassic_get($res, 97 );
Default Value
''
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprint Property (IPWorksIoT_AMQPClassic Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprint();
Procedural Interface
ipworksiot_amqpclassic_get($res, 98 );
Default Value
''
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA1 Property (IPWorksIoT_AMQPClassic Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA1();
Procedural Interface
ipworksiot_amqpclassic_get($res, 99 );
Default Value
''
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA256 Property (IPWorksIoT_AMQPClassic Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA256();
Procedural Interface
ipworksiot_amqpclassic_get($res, 100 );
Default Value
''
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLAcceptServerCertIssuer Property (IPWorksIoT_AMQPClassic Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertIssuer();
Procedural Interface
ipworksiot_amqpclassic_get($res, 101 );
Default Value
''
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKey Property (IPWorksIoT_AMQPClassic Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKey();
Procedural Interface
ipworksiot_amqpclassic_get($res, 102 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksIoT_AMQPClassic Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyAvailable();
Procedural Interface
ipworksiot_amqpclassic_get($res, 103 );
Default Value
false
Remarks
This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (IPWorksIoT_AMQPClassic Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyContainer();
Procedural Interface
ipworksiot_amqpclassic_get($res, 104 );
Default Value
''
Remarks
This is the name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (IPWorksIoT_AMQPClassic Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKey();
Procedural Interface
ipworksiot_amqpclassic_get($res, 105 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksIoT_AMQPClassic Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyAlgorithm();
Procedural Interface
ipworksiot_amqpclassic_get($res, 106 );
Default Value
''
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyLength Property (IPWorksIoT_AMQPClassic Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyLength();
Procedural Interface
ipworksiot_amqpclassic_get($res, 107 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (IPWorksIoT_AMQPClassic Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLAcceptServerCertSerialNumber();
Procedural Interface
ipworksiot_amqpclassic_get($res, 108 );
Default Value
''
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLAcceptServerCertSignatureAlgorithm Property (IPWorksIoT_AMQPClassic Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertSignatureAlgorithm();
Procedural Interface
ipworksiot_amqpclassic_get($res, 109 );
Default Value
''
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertStore Property (IPWorksIoT_AMQPClassic Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStore(); public function setSSLAcceptServerCertStore($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 110 ); ipworksiot_amqpclassic_set($res, 110, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLAcceptServerCertStorePassword Property (IPWorksIoT_AMQPClassic Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLAcceptServerCertStorePassword(); public function setSSLAcceptServerCertStorePassword($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 111 ); ipworksiot_amqpclassic_set($res, 111, $value );
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
SSLAcceptServerCertStoreType Property (IPWorksIoT_AMQPClassic Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStoreType(); public function setSSLAcceptServerCertStoreType($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 112 ); ipworksiot_amqpclassic_set($res, 112, $value );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This 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 class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword 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
SSLAcceptServerCertSubjectAltNames Property (IPWorksIoT_AMQPClassic Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertSubjectAltNames();
Procedural Interface
ipworksiot_amqpclassic_get($res, 113 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (IPWorksIoT_AMQPClassic Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintMD5();
Procedural Interface
ipworksiot_amqpclassic_get($res, 114 );
Default Value
''
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA1 Property (IPWorksIoT_AMQPClassic Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA1();
Procedural Interface
ipworksiot_amqpclassic_get($res, 115 );
Default Value
''
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA256 Property (IPWorksIoT_AMQPClassic Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA256();
Procedural Interface
ipworksiot_amqpclassic_get($res, 116 );
Default Value
''
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsage Property (IPWorksIoT_AMQPClassic Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLAcceptServerCertUsage();
Procedural Interface
ipworksiot_amqpclassic_get($res, 117 );
Default Value
''
Remarks
This property contains the text description of SSLAcceptServerCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsageFlags Property (IPWorksIoT_AMQPClassic Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertUsageFlags();
Procedural Interface
ipworksiot_amqpclassic_get($res, 118 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (IPWorksIoT_AMQPClassic Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLAcceptServerCertVersion();
Procedural Interface
ipworksiot_amqpclassic_get($res, 119 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLAcceptServerCertSubject Property (IPWorksIoT_AMQPClassic Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLAcceptServerCertSubject(); public function setSSLAcceptServerCertSubject($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 120 ); ipworksiot_amqpclassic_set($res, 120, $value );
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
SSLAcceptServerCertEncoded Property (IPWorksIoT_AMQPClassic Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLAcceptServerCertEncoded(); public function setSSLAcceptServerCertEncoded($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 121 ); ipworksiot_amqpclassic_set($res, 121, $value );
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.
This property is not available at design time.
Data Type
Binary String
SSLCertEffectiveDate Property (IPWorksIoT_AMQPClassic Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLCertEffectiveDate();
Procedural Interface
ipworksiot_amqpclassic_get($res, 122 );
Default Value
''
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (IPWorksIoT_AMQPClassic Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLCertExpirationDate();
Procedural Interface
ipworksiot_amqpclassic_get($res, 123 );
Default Value
''
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (IPWorksIoT_AMQPClassic Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLCertExtendedKeyUsage();
Procedural Interface
ipworksiot_amqpclassic_get($res, 124 );
Default Value
''
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (IPWorksIoT_AMQPClassic Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprint();
Procedural Interface
ipworksiot_amqpclassic_get($res, 125 );
Default Value
''
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (IPWorksIoT_AMQPClassic Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA1();
Procedural Interface
ipworksiot_amqpclassic_get($res, 126 );
Default Value
''
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (IPWorksIoT_AMQPClassic Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA256();
Procedural Interface
ipworksiot_amqpclassic_get($res, 127 );
Default Value
''
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLCertIssuer Property (IPWorksIoT_AMQPClassic Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLCertIssuer();
Procedural Interface
ipworksiot_amqpclassic_get($res, 128 );
Default Value
''
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (IPWorksIoT_AMQPClassic Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKey();
Procedural Interface
ipworksiot_amqpclassic_get($res, 129 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (IPWorksIoT_AMQPClassic Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLCertPrivateKeyAvailable();
Procedural Interface
ipworksiot_amqpclassic_get($res, 130 );
Default Value
false
Remarks
This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (IPWorksIoT_AMQPClassic Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKeyContainer();
Procedural Interface
ipworksiot_amqpclassic_get($res, 131 );
Default Value
''
Remarks
This is the name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (IPWorksIoT_AMQPClassic Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLCertPublicKey();
Procedural Interface
ipworksiot_amqpclassic_get($res, 132 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (IPWorksIoT_AMQPClassic Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLCertPublicKeyAlgorithm();
Procedural Interface
ipworksiot_amqpclassic_get($res, 133 );
Default Value
''
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (IPWorksIoT_AMQPClassic Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLCertPublicKeyLength();
Procedural Interface
ipworksiot_amqpclassic_get($res, 134 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (IPWorksIoT_AMQPClassic Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLCertSerialNumber();
Procedural Interface
ipworksiot_amqpclassic_get($res, 135 );
Default Value
''
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (IPWorksIoT_AMQPClassic Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLCertSignatureAlgorithm();
Procedural Interface
ipworksiot_amqpclassic_get($res, 136 );
Default Value
''
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertStore Property (IPWorksIoT_AMQPClassic Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLCertStore(); public function setSSLCertStore($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 137 ); ipworksiot_amqpclassic_set($res, 137, $value );
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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (IPWorksIoT_AMQPClassic Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLCertStorePassword(); public function setSSLCertStorePassword($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 138 ); ipworksiot_amqpclassic_set($res, 138, $value );
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 (IPWorksIoT_AMQPClassic Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLCertStoreType(); public function setSSLCertStoreType($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 139 ); ipworksiot_amqpclassic_set($res, 139, $value );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This 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 class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the 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
SSLCertSubjectAltNames Property (IPWorksIoT_AMQPClassic Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLCertSubjectAltNames();
Procedural Interface
ipworksiot_amqpclassic_get($res, 140 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (IPWorksIoT_AMQPClassic Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintMD5();
Procedural Interface
ipworksiot_amqpclassic_get($res, 141 );
Default Value
''
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (IPWorksIoT_AMQPClassic Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA1();
Procedural Interface
ipworksiot_amqpclassic_get($res, 142 );
Default Value
''
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (IPWorksIoT_AMQPClassic Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA256();
Procedural Interface
ipworksiot_amqpclassic_get($res, 143 );
Default Value
''
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertUsage Property (IPWorksIoT_AMQPClassic Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLCertUsage();
Procedural Interface
ipworksiot_amqpclassic_get($res, 144 );
Default Value
''
Remarks
This property contains the text description of SSLCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (IPWorksIoT_AMQPClassic Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLCertUsageFlags();
Procedural Interface
ipworksiot_amqpclassic_get($res, 145 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (IPWorksIoT_AMQPClassic Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLCertVersion();
Procedural Interface
ipworksiot_amqpclassic_get($res, 146 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (IPWorksIoT_AMQPClassic Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLCertSubject(); public function setSSLCertSubject($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 147 ); ipworksiot_amqpclassic_set($res, 147, $value );
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
SSLCertEncoded Property (IPWorksIoT_AMQPClassic Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLCertEncoded(); public function setSSLCertEncoded($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 148 ); ipworksiot_amqpclassic_set($res, 148, $value );
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.
This property is not available at design time.
Data Type
Binary String
SSLEnabled Property (IPWorksIoT_AMQPClassic Class)
This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
Object Oriented Interface
public function getSSLEnabled(); public function setSSLEnabled($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 149 ); ipworksiot_amqpclassic_set($res, 149, $value );
Default Value
false
Remarks
This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.
TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.
If the default port (5672) is selected when SSLEnabled is set to true, the port will automatically be changed to the default port for AMQP with SSL (5671). Likewise, if port 5671 is selected when SSLEnabled is set to false, the port will automatically be changed to the default port. If the port has been set to any value other than the default values, it will remain the same when the value of SSLEnabled changes.
This property is not available at design time.
Data Type
Boolean
SSLProvider Property (IPWorksIoT_AMQPClassic Class)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Object Oriented Interface
public function getSSLProvider(); public function setSSLProvider($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 150 ); ipworksiot_amqpclassic_set($res, 150, $value );
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 class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
Data Type
Integer
SSLServerCertEffectiveDate Property (IPWorksIoT_AMQPClassic Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLServerCertEffectiveDate();
Procedural Interface
ipworksiot_amqpclassic_get($res, 151 );
Default Value
''
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExpirationDate Property (IPWorksIoT_AMQPClassic Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLServerCertExpirationDate();
Procedural Interface
ipworksiot_amqpclassic_get($res, 152 );
Default Value
''
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExtendedKeyUsage Property (IPWorksIoT_AMQPClassic Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLServerCertExtendedKeyUsage();
Procedural Interface
ipworksiot_amqpclassic_get($res, 153 );
Default Value
''
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLServerCertFingerprint Property (IPWorksIoT_AMQPClassic Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprint();
Procedural Interface
ipworksiot_amqpclassic_get($res, 154 );
Default Value
''
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA1 Property (IPWorksIoT_AMQPClassic Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA1();
Procedural Interface
ipworksiot_amqpclassic_get($res, 155 );
Default Value
''
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA256 Property (IPWorksIoT_AMQPClassic Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA256();
Procedural Interface
ipworksiot_amqpclassic_get($res, 156 );
Default Value
''
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLServerCertIssuer Property (IPWorksIoT_AMQPClassic Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLServerCertIssuer();
Procedural Interface
ipworksiot_amqpclassic_get($res, 157 );
Default Value
''
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLServerCertPrivateKey Property (IPWorksIoT_AMQPClassic Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKey();
Procedural Interface
ipworksiot_amqpclassic_get($res, 158 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (IPWorksIoT_AMQPClassic Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLServerCertPrivateKeyAvailable();
Procedural Interface
ipworksiot_amqpclassic_get($res, 159 );
Default Value
false
Remarks
This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (IPWorksIoT_AMQPClassic Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKeyContainer();
Procedural Interface
ipworksiot_amqpclassic_get($res, 160 );
Default Value
''
Remarks
This is the name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (IPWorksIoT_AMQPClassic Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLServerCertPublicKey();
Procedural Interface
ipworksiot_amqpclassic_get($res, 161 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyAlgorithm Property (IPWorksIoT_AMQPClassic Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLServerCertPublicKeyAlgorithm();
Procedural Interface
ipworksiot_amqpclassic_get($res, 162 );
Default Value
''
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyLength Property (IPWorksIoT_AMQPClassic Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLServerCertPublicKeyLength();
Procedural Interface
ipworksiot_amqpclassic_get($res, 163 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLServerCertSerialNumber Property (IPWorksIoT_AMQPClassic Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLServerCertSerialNumber();
Procedural Interface
ipworksiot_amqpclassic_get($res, 164 );
Default Value
''
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLServerCertSignatureAlgorithm Property (IPWorksIoT_AMQPClassic Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLServerCertSignatureAlgorithm();
Procedural Interface
ipworksiot_amqpclassic_get($res, 165 );
Default Value
''
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertStore Property (IPWorksIoT_AMQPClassic Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLServerCertStore();
Procedural Interface
ipworksiot_amqpclassic_get($res, 166 );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
This property is read-only.
Data Type
Binary String
SSLServerCertStorePassword Property (IPWorksIoT_AMQPClassic Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLServerCertStorePassword();
Procedural Interface
ipworksiot_amqpclassic_get($res, 167 );
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.
This property is read-only.
Data Type
String
SSLServerCertStoreType Property (IPWorksIoT_AMQPClassic Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLServerCertStoreType();
Procedural Interface
ipworksiot_amqpclassic_get($res, 168 );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This 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 class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword 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. |
This property is read-only.
Data Type
Integer
SSLServerCertSubjectAltNames Property (IPWorksIoT_AMQPClassic Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLServerCertSubjectAltNames();
Procedural Interface
ipworksiot_amqpclassic_get($res, 169 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (IPWorksIoT_AMQPClassic Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintMD5();
Procedural Interface
ipworksiot_amqpclassic_get($res, 170 );
Default Value
''
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA1 Property (IPWorksIoT_AMQPClassic Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA1();
Procedural Interface
ipworksiot_amqpclassic_get($res, 171 );
Default Value
''
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA256 Property (IPWorksIoT_AMQPClassic Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA256();
Procedural Interface
ipworksiot_amqpclassic_get($res, 172 );
Default Value
''
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertUsage Property (IPWorksIoT_AMQPClassic Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLServerCertUsage();
Procedural Interface
ipworksiot_amqpclassic_get($res, 173 );
Default Value
''
Remarks
This property contains the text description of SSLServerCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLServerCertUsageFlags Property (IPWorksIoT_AMQPClassic Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLServerCertUsageFlags();
Procedural Interface
ipworksiot_amqpclassic_get($res, 174 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (IPWorksIoT_AMQPClassic Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLServerCertVersion();
Procedural Interface
ipworksiot_amqpclassic_get($res, 175 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLServerCertSubject Property (IPWorksIoT_AMQPClassic Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLServerCertSubject();
Procedural Interface
ipworksiot_amqpclassic_get($res, 176 );
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.
This property is read-only.
Data Type
String
SSLServerCertEncoded Property (IPWorksIoT_AMQPClassic Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLServerCertEncoded();
Procedural Interface
ipworksiot_amqpclassic_get($res, 177 );
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.
This property is read-only and not available at design time.
Data Type
Binary String
Timeout Property (IPWorksIoT_AMQPClassic Class)
This property includes the timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 178 ); ipworksiot_amqpclassic_set($res, 178, $value );
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 class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
User Property (IPWorksIoT_AMQPClassic Class)
A username to use for SASL authentication.
Object Oriented Interface
public function getUser(); public function setUser($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 179 ); ipworksiot_amqpclassic_set($res, 179, $value );
Default Value
''
Remarks
This property contains a username to use for SASL authentication.
This property is not available at design time.
Data Type
String
VirtualHost Property (IPWorksIoT_AMQPClassic Class)
The virtual host to connect to.
Object Oriented Interface
public function getVirtualHost(); public function setVirtualHost($value);
Procedural Interface
ipworksiot_amqpclassic_get($res, 180 ); ipworksiot_amqpclassic_set($res, 180, $value );
Default Value
'/'
Remarks
This property specifies the virtual host to connect to on the server, and is set to / by default.
Note that the configuration of the server defines what virtual hosts are available.
This setting cannot be changed while connected.
This property is not available at design time.
Data Type
String
BindQueue Method (IPWorksIoT_AMQPClassic Class)
Binds a queue to an exchange.
Object Oriented Interface
public function doBindQueue($channelname, $queuename, $exchangename, $routingkey, $nowait);
Procedural Interface
ipworksiot_amqpclassic_do_bindqueue($res, $channelname, $queuename, $exchangename, $routingkey, $nowait);
Remarks
This method is used to bind the queue named QueueName to the exchange named ExchangeName. Exchanges use bindings to determine which queues to route messages to.
Multiple bindings between the same queue and exchange with different RoutingKeys and/or arguments are allowed; requests that would create a duplicate binding are ignored. No queue will ever receive duplicate copies of any message, regardless of what bindings are present on the server.
Note that all AMQP 0.9.1 servers automatically bind all queues to their default exchange (which is always a direct exchange with no name) using each queue's name as the binding's routing key. This makes it easy to send a message to a specific queue without having to declare bindings; just call PublishMessage, pass empty string for ExchangeName, and the name of the desired queue for RoutingKey.
ChannelName controls what channel the class will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.
QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.
The server's default exchange may be specified by passing empty string for ExchangeName. Otherwise, ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.
The RoutingKey parameter specifies the binding's routing key. Exchanges that use routing-key-based logic make some sort of comparison between the routing keys of incoming messages and this value to decide which messages should be forwarded to the specified queue. Examples of exchange types which use routing keys include:
- direct exchanges, which compare (for equality) the routing keys of incoming messages to the routing keys of each queue bound to them.
- topic exchanges, which match the routing keys of incoming messages against the routing pattern of each queue bound to them.
Not all exchange types make use of routing keys, in which case empty string can be passed for the RoutingKey parameter. Examples of exchange types which don't use routing keys include:
- fanout exchanges simply forward incoming messages to all queues bound to them, unconditionally.
- header exchanges only forward messages that include certain headers. When binding a queue to a header exchange, add items to the Arguments collection to describe the headers that eligible messages must have, and whether they must have any or all of those headers.
Note that the format of the RoutingKey parameter and/or the content of the Arguments collection may differ slightly between server implementations. Refer to your server's documentation to determine what it expects to receive for each exchange type that it supports.
The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.
An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:
- No queue with the given QueueName exists.
- No exchange with the given ExchangeName exists.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
Binding a Queue to an Exchange
// Bind a queue to an exchange. Messages will only be delivered to the queue if their routing key is "MyRoutingKey".
amqpc1.BindQueue("channel", "MyQueue", "MyExchange", "MyRoutingKey", false);
CancelConsume Method (IPWorksIoT_AMQPClassic Class)
Cancels an existing consumer.
Object Oriented Interface
public function doCancelConsume($channelname, $consumertag, $nowait);
Procedural Interface
ipworksiot_amqpclassic_do_cancelconsume($res, $channelname, $consumertag, $nowait);
Remarks
This method requests that the server cancel the consumer identified by the given ConsumerTag on the channel specified by ChannelName.
The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.
An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because no consumer with the given ConsumerTag exists.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
CloseChannel Method (IPWorksIoT_AMQPClassic Class)
Closes a channel.
Object Oriented Interface
public function doCloseChannel($channelname);
Procedural Interface
ipworksiot_amqpclassic_do_closechannel($res, $channelname);
Remarks
This method closes the channel named ChannelName and removes it from the Channels properties.
If no channel with the given ChannelName exists, an exception will be thrown.
CommitTransaction Method (IPWorksIoT_AMQPClassic Class)
Commits the current transaction for a channel.
Object Oriented Interface
public function doCommitTransaction($channelname);
Procedural Interface
ipworksiot_amqpclassic_do_committransaction($res, $channelname);
Remarks
This method commits the current transaction for the channel with the given ChannelName. A new transaction is started immediately after the current one is committed.
Refer to EnableTransactionMode for more information about transactions.
An exception is thrown if a channel with the given ChannelName doesn't exist, or if the server returns an error because the channel does not have transaction mode enabled.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
Config Method (IPWorksIoT_AMQPClassic Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworksiot_amqpclassic_do_config($res, $configurationstring);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Connect Method (IPWorksIoT_AMQPClassic Class)
This method connects to a remote host.
Object Oriented Interface
public function doConnect();
Procedural Interface
ipworksiot_amqpclassic_do_connect($res);
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 (IPWorksIoT_AMQPClassic Class)
This method connects to a remote host.
Object Oriented Interface
public function doConnectTo($host, $port);
Procedural Interface
ipworksiot_amqpclassic_do_connectto($res, $host, $port);
Remarks
This method connects to the remote host specified by the Host and Port parameters. For instance:
component.ConnectTo("MyHostNameOrIP", 777)
Consume Method (IPWorksIoT_AMQPClassic Class)
Starts a new consumer for a given queue.
Object Oriented Interface
public function doConsume($channelname, $queuename, $consumertag, $nolocal, $noack, $exclusive, $nowait);
Procedural Interface
ipworksiot_amqpclassic_do_consume($res, $channelname, $queuename, $consumertag, $nolocal, $noack, $exclusive, $nowait);
Remarks
This method instructs the server to start a new consumer on the queue named QueueName; once the consumer is created, it will cause messages enqueued to the specified queue to be delivered to the class over the channel specified by ChannelName.
Consumers last as long as the channel they were created on, or until they are cancelled using the CancelConsume method. Each time a message is delivered to the class, it is immediately added to the IncomingMessages collection, the ReceivedMessage property is populated, and the MessageIn event fires.
ConsumerTag is a string which uniquely identifies the new consumer on the specified channel. If empty string is passed for ConsumerTag, the server will generate a consumer tag automatically when it creates the . this auto-generated consumer tag can then be retrieved by querying the ConsumerTag configuration setting after this method returns.
The NoLocal parameter, if True, ensures that the consumer never consumes messages published on the same channel. (Note that this functionality is not available on RabbitMQ servers, which ignore the NoLocal parameter).
The NoAck parameter controls whether the server will expect the class to acknowledge the each message delivered. Refer to MessageIn for more information about acknowledging messages.
The Exclusive parameter, if True, will cause the class to request that the server create an exclusive consumer. Attaching an exclusive consumer to a queue prevents any other consumers from consuming messages from that queue.
The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.
Additional arguments may be sent with this request by adding them to the Arguments collection. Arguments are server-dependent; refer to your server's documentation to determine if any additional arguments apply for this request.
An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:
- No queue with the given QueueName exists.
- The given ConsumerTag is already in use on the specified channel.
- An exclusive consumer was requested for a queue which already has consumers attached to it.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
Receiving a Message
// MessageIn event handler.
amqpc1.OnMessageIn += (s, e) => {
if (e.MessageCount == -1) {
// The server pushed a message to us asynchronously due to a consumer we created.
Console.WriteLine("The server pushed this message to us via consumer '" + e.ConsumerTag + "':");
Console.WriteLine(amqpc1.ReceivedMessage.Body);
} else if (e.DeliveryTag > 0) {
// We pulled a message from a queue with the RetrieveMessage() method.
Console.WriteLine("Message successfully pulled:");
Console.WriteLine(amqpc1.ReceivedMessage.Body);
Console.WriteLine(e.MessageCount + " messages are still available to pull.");
} else {
// We tried to pull a message, but there were none available to pull.
Console.WriteLine("No messages available to pull.");
}
};
// Attach a consumer to "MyQueue".
amqpc1.Consume("channel", "MyQueue", "consumerTag", false, true, false, false);
// Or, try to retrieve a message from "MyQueue".
amqpc1.RetrieveMessage("channel", "MyQueue", true);
CreateChannel Method (IPWorksIoT_AMQPClassic Class)
Creates a new channel.
Object Oriented Interface
public function doCreateChannel($channelname);
Procedural Interface
ipworksiot_amqpclassic_do_createchannel($res, $channelname);
Remarks
This method creates a new channel with the name ChannelName and adds it to the Channels properties. If a channel with the given ChannelName already exists, an error will be thrown.
Connecting and Creating a Channel
// The examples in this documentation use a RabbitMQ server, which requires SASL Plain auth.
amqpc1.AuthScheme = AmqpclassicAuthSchemes.smSASLPlain;
amqpc1.User = "guest";
amqpc1.Password = "guest";
amqpc1.SSLEnabled = true;
amqpc1.ConnectTo("amqpclassic.test-server.com", 5671);
amqpc1.CreateChannel("channel");
DeclareExchange Method (IPWorksIoT_AMQPClassic Class)
Verifies that an exchange exists, potentially creating it if necessary.
Object Oriented Interface
public function doDeclareExchange($channelname, $exchangename, $exchangetype, $passive, $durable, $autodelete, $nowait);
Procedural Interface
ipworksiot_amqpclassic_do_declareexchange($res, $channelname, $exchangename, $exchangetype, $passive, $durable, $autodelete, $nowait);
Remarks
This method is used to verify that an exchange named ExchangeName exists; and potentially creates it if no such exchange exists.
ChannelName controls what channel the class will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.
ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq. unless the Passive parameter is True.
ExchangeType specifies the exchange type. All servers support the direct and fanout exchange types, and most should also support the topic and header exchange types. Some servers may support additional, custom exchange types as well. Refer to your server's documentation for more information about each exchange type, and to determine what exchange types it supports other than direct and fanout.
If Passive is True, the server will only verify that an exchange with the given ExchangeName actually exists (regardless of how it is configured).
If Passive is False, and no exchange named ExchangeName currently exists, the server will create one.
If Passive is False, and there is a preexisting exchange named ExchangeName, the server will verify that its current configuration matches the given parameters and arguments.
Durable specifies what happens to the exchange in the event of a server restart. Durable exchanges will be recreated, while non-durable (transient) exchanges will not.
AutoDelete specifies whether the server should automatically delete the exchange when all queues have been unbound from it. Note that this parameter is only sent if the RabbitMQCompatible configuration setting is enabled; it is ignored otherwise.
The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.
Additional arguments may be sent with this request by adding them to the Arguments collection. Arguments are server-dependent; refer to your server's documentation to determine if any additional arguments apply for this request.
An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:
- One of the parameter constraints described above was violated.
- One of the verification cases described above fails.
- The value passed for ExchangeType did not correspond to an exchange type supported by the server.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
Declaring an Exchange
// Declare a direct-type exchange.
amqpc1.DeclareExchange("channel", "MyExchange", "direct", false, false, false, false);
DeclareQueue Method (IPWorksIoT_AMQPClassic Class)
Verifies that a queue exists, potentially creating it if necessary.
Object Oriented Interface
public function doDeclareQueue($channelname, $queuename, $passive, $durable, $exclusive, $autodelete, $nowait);
Procedural Interface
ipworksiot_amqpclassic_do_declarequeue($res, $channelname, $queuename, $passive, $durable, $exclusive, $autodelete, $nowait);
Remarks
This method is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.
After each successful call to this method, the class populates the QueueMessageCount property, as well as the QueueConsumerCount and QueueName configuration settings. Refer to each one for more information.
ChannelName controls what channel the class will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.
If creating a new queue, empty string can be passed for QueueName to have the server automatically generate a name for the new queue (which can then be retrieved using the QueueName configuration setting). In all other cases, QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq. unless the Passive parameter is True.
If Passive is True, the server will only verify that a queue with the given QueueName actually exists (regardless of how it is configured).
If Passive is False, and no queue named QueueName currently exists, the server will create one.
If Passive is False, and there is a preexisting queue named QueueName, the server will verify that its current configuration matches the given parameters and arguments.
Durable specifies what happens to the queue in the event of a server restart. Durable queue will be recreated, while non-durable (transient) queue will not. (Note that the messages in durable queues will still be lost unless they are marked as persistent.)
Exclusive, if True, indicates that the queue may only be accessed by the current connection. Exclusive queues are deleted when the current connection closes.
AutoDelete specifies whether the server should automatically delete the queue when all consumers have finished using it. (Note that auto-delete queues aren't eligible for deletion until after a consumer attaches to them for the first time.)
The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.
Additional arguments may be sent with this request by adding them to the Arguments collection. Arguments are server-dependent; refer to your server's documentation to determine if any additional arguments apply for this request.
An exception is thrown if no channel with the given ChannelName exists, if QueueName empty string and NoWait is True, or if the server returns an error because:
- One of the parameter constraints described above was violated.
- One of the verification cases described above fails.
- An attempt was made to verify (i.e., the Passive parameter was True) another connection's exclusive queue.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
Declaring a Queue
// Declare a queue.
amqpc1.DeclareQueue("channel", "MyQueue", false, false, false, false, false);
DeleteExchange Method (IPWorksIoT_AMQPClassic Class)
Deletes an exchange.
Object Oriented Interface
public function doDeleteExchange($channelname, $exchangename, $ifunused, $nowait);
Procedural Interface
ipworksiot_amqpclassic_do_deleteexchange($res, $channelname, $exchangename, $ifunused, $nowait);
Remarks
This method is used to delete an exchange.
ChannelName controls what channel the class will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.
ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq..
When IfUnused is True, the server will only delete the exchange if no queues are bound to it.
The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.
An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:
- The value passed for ExchangeName fails one or more of the constraints described above.
- No exchange named ExchangeName exists. (This does not apply for RabbitMQ; attempting to delete a non-existent exchange will always succeed.)
- The IfUnused parameter was True, but the exchange still had one or more queues bound to it.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
DeleteQueue Method (IPWorksIoT_AMQPClassic Class)
Deletes a queue.
Object Oriented Interface
public function doDeleteQueue($channelname, $queuename, $ifunused, $ifempty, $nowait);
Procedural Interface
ipworksiot_amqpclassic_do_deletequeue($res, $channelname, $queuename, $ifunused, $ifempty, $nowait);
Remarks
This method is used to delete the queue named QueueName.
After each successful call to this method, the class populates the QueueMessageCount property with the number of messages deleted along with the queue. (Note that this does not occur if the NoWait parameter is set to True.)
ChannelName controls what channel the class will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.
QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq..
When IfUnused is True, the server will only delete the queue if no consumers are attached to it.
When IfEmpty is True, the server will only delete the queue if it has no messages in it. (When IfEmpty is False, servers will typically move any remaining messages to a dead-letter queue, if one is available.)
The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.
An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:
- The value passed for QueueName fails one or more of the constraints described above.
- No queue named QueueName exists. (This does not apply for RabbitMQ; attempting to delete a non-existent queue will always succeed.)
- The IfUnused parameter was True, but the queue still had one or more consumers attached to it.
- The IfEmpty parameter was True, but the queue still had one or more messages in it.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
Disconnect Method (IPWorksIoT_AMQPClassic Class)
This method disconnects from the remote host.
Object Oriented Interface
public function doDisconnect();
Procedural Interface
ipworksiot_amqpclassic_do_disconnect($res);
Remarks
This method disconnects from the remote host. Calling this method is equivalent to setting the Connected property to False.
DoEvents Method (IPWorksIoT_AMQPClassic Class)
This method processes events from the internal message queue.
Object Oriented Interface
public function doEvents();
Procedural Interface
ipworksiot_amqpclassic_do_doevents($res);
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
EnablePublishConfirms Method (IPWorksIoT_AMQPClassic Class)
Enables publish confirmations mode for a channel.
Object Oriented Interface
public function doEnablePublishConfirms($channelname, $nowait);
Procedural Interface
ipworksiot_amqpclassic_do_enablepublishconfirms($res, $channelname, $nowait);
Remarks
This method enables publish confirmations mode for the channel with the given ChannelName.
While a channel is in publish confirmations mode, the server will acknowledge each message published by the class. The class will wait to fire the MessageOut event until it receives this acknowledgment. (Note that this mode is only available when the RabbitMQCompatible configuration setting is enabled.)
Note that a channel will stay in publish confirmations mode, once enabled, until it is deleted.
The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.
An exception is thrown if the RabbitMQCompatible configuration setting is currently False, if no channel with the given ChannelName exists, or if EnableTransactionMode has been called for the specified channel previously.
EnableTransactionMode Method (IPWorksIoT_AMQPClassic Class)
Enables transaction mode for a channel.
Object Oriented Interface
public function doEnableTransactionMode($channelname);
Procedural Interface
ipworksiot_amqpclassic_do_enabletransactionmode($res, $channelname);
Remarks
This method enables transaction mode for the channel with the given ChannelName.
While a channel is in transaction mode, all messages published and acknowledgements sent over it will be part of a transaction, and the server will wait to process them until the transaction is either committed or rolled back.
To commit the current transaction on a channel, call CommitTransaction; and to roll it back (and discard the messages and acknowledgements that were part of it), call RollbackTransaction.
Keep in mind that, according to the AMQP 0.9.1 specification:
- A new transaction is always started immediately after committing or rolling back the current one, which means that...
- ...a channel will stay in transaction mode, once enabled, until it is deleted.
- Transactions are only guaranteed to be atomic if all messages published and acknowledgements sent affect a single queue.
- Any messages published on a channel in transaction mode that have the Mandatory or Immediate flags set are not guaranteed to be included in the transaction.
An exception is thrown if no channel with the given ChannelName exists, or if EnablePublishConfirms has been called for the specified channel previously.
Interrupt Method (IPWorksIoT_AMQPClassic Class)
Interrupt the current action and disconnects from the remote host.
Object Oriented Interface
public function doInterrupt();
Procedural Interface
ipworksiot_amqpclassic_do_interrupt($res);
Remarks
This method will interrupt the current method (if applicable) and cause the class to disconnect from the remote host.
PublishMessage Method (IPWorksIoT_AMQPClassic Class)
Publishes a message.
Object Oriented Interface
public function doPublishMessage($channelname, $exchangename, $routingkey, $mandatory, $immediate);
Procedural Interface
ipworksiot_amqpclassic_do_publishmessage($res, $channelname, $exchangename, $routingkey, $mandatory, $immediate);
Remarks
This method is used to publish the message specified by the Message property to the exchange named ExchangeName over the channel specified by ChannelName.
When this method is called, the message to publish is immediately added to the OutgoingMessages collection, and the MessageOut event fires once it has been sent (or, if the specified channel is in "publish confirmations" mode, after the server has acknowledged it).
Note that all AMQP 0.9.1 servers automatically bind all queues to their default exchange (which is always a direct exchange with no name) using each queue's name as the binding's routing key. This makes it easy to send a message to a specific queue without having to declare bindings; just call PublishMessage, pass empty string for ExchangeName, and the name of the desired queue for RoutingKey.
Note that messages published over channels which are in either transaction or "publish confirmations" mode may be handled differently than they would be on a channel in normal mode. Refer to the EnableTransactionMode and EnablePublishConfirms methods for more information about what each mode entails.
The server's default exchange may be specified by passing empty string for ExchangeName. Otherwise, ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.
The RoutingKey parameter specifies the message's routing key. Whether this parameter needs to be non-empty, and what format it should have if so, depends on the type of exchange it is being sent to. Some exchange types may use information included with the message, such as its MessageHeaders. Refer to BindQueue for more information about how routing keys are used, and to your server's documentation for information on what it expects.
The Mandatory parameter controls what the server should do if the message can't be routed to any queue (either because it isn't eligible for any of the queues bound to the specified exchange because of how their bindings are configured, or because no queues are bound to the exchange in the first place). If True, the server will return the message, at which point the MessageReturned event will be fired. If False, the server will drop the message.
The Immediate parameter controls what the server should do if the message can't be immediately delivered to any consumer (either because it cannot be routed to a queue, or because the queues it can be routed to have no active consumers attached to them). If True, the server will return the message, at which point the MessageReturned event will be fired. If False, the server will queue the message if possible, or drop it if not.
An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:
- The value passed for ExchangeName fails one or more of the constraints described above.
- No exchange named ExchangeName exists.
- The message is rejected for some reason.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
Publishing a Message
amqpc1.Message.Body = "Hello, world!";
// Publish a message to the server's default (no-name) exchange, using the name of a specific queue as the routing key.
amqpc1.PublishMessage("channel", "", "MyQueue", false, false);
// Publish a message to the "MyExchange" exchange, using the routing key "MyRoutingKey".
amqpc1.PublishMessage("channel", "MyExchange", "MyRoutingKey", false, false);
PurgeQueue Method (IPWorksIoT_AMQPClassic Class)
Purges all messages from a queue.
Object Oriented Interface
public function doPurgeQueue($channelname, $queuename, $nowait);
Procedural Interface
ipworksiot_amqpclassic_do_purgequeue($res, $channelname, $queuename, $nowait);
Remarks
This method purges all messages from the queue named QueueName. Messages which have been sent but are awaiting acknowledgment are not affected.
After each successful call to this method, the class populates the QueueMessageCount property with the number of messages purged from the queue. (Note that this does not occur if the NoWait parameter is set to True.)
ChannelName controls what channel the class will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.
QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.
The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.
An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because no queue named QueueName exists.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
Recover Method (IPWorksIoT_AMQPClassic Class)
Request that the server redeliver all messages on a given channel that have not been acknowledged.
Object Oriented Interface
public function doRecover($channelname, $requeue);
Procedural Interface
ipworksiot_amqpclassic_do_recover($res, $channelname, $requeue);
Remarks
This method is used to request that the server redeliver all messages that it previously sent to the class on the channel specified by ChannelName which are still awaiting acknowledgment.
A call to this method may cause the server to redeliver zero or more messages over the channel specified by ChannelName. Those messages will cause the MessageIn event to fire with its Redelivered event parameter set to True.
The Requeue parameter controls how the server should attempt to redeliver the messages awaiting acknowledgment. If set to True, the server will simple put the messages back on their original queues, and they will be delivered like any other queued messages (potentially to other consumers). If set to False, the server will redeliver the messages to the class directly.
An exception is thrown if no channel with the given ChannelName exists, or (for RabbitMQ only) if the server returns an error because Requeue was False. (RabbitMQ only supports setting Requeue to True.)
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
Reset Method (IPWorksIoT_AMQPClassic Class)
This method will reset the class.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworksiot_amqpclassic_do_reset($res);
Remarks
This method will reset the class's properties to their default values.
ResetMessage Method (IPWorksIoT_AMQPClassic Class)
Resets the Message properties.
Object Oriented Interface
public function doResetMessage();
Procedural Interface
ipworksiot_amqpclassic_do_resetmessage($res);
Remarks
This method resets the Message property.
RetrieveMessage Method (IPWorksIoT_AMQPClassic Class)
Attempts to retrieve a message from a given queue.
Object Oriented Interface
public function doRetrieveMessage($channelname, $queuename, $noack);
Procedural Interface
ipworksiot_amqpclassic_do_retrievemessage($res, $channelname, $queuename, $noack);
Remarks
This method attempts to retrieve a message from the queue named QueueName over the channel named ChannelName.
If a message is retrieved as a result of this method being called, it is immediately added to the IncomingMessages collection, the ReceivedMessage property is populated, and the MessageIn event fires.
Even if no message gets retrieved, the MessageIn event will still fire as long as the request was successful. The server returns the number of available messages in the specified queue in response to all successful retrieve requests, and that count is exposed by MessageIn event's MessageCount parameter. Refer to the MessageIn event for more information.
QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.
The NoAck parameter controls whether the server will expect the class to acknowledge the retrieved message. Refer to MessageIn for more information about acknowledging messages.
An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:
- No queue with the given QueueName exists.
- The specified queue exists, but is locked or otherwise unavailable to consume from (e.g., an exclusive consumer might be attached to it).
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
Receiving a Message
// MessageIn event handler.
amqpc1.OnMessageIn += (s, e) => {
if (e.MessageCount == -1) {
// The server pushed a message to us asynchronously due to a consumer we created.
Console.WriteLine("The server pushed this message to us via consumer '" + e.ConsumerTag + "':");
Console.WriteLine(amqpc1.ReceivedMessage.Body);
} else if (e.DeliveryTag > 0) {
// We pulled a message from a queue with the RetrieveMessage() method.
Console.WriteLine("Message successfully pulled:");
Console.WriteLine(amqpc1.ReceivedMessage.Body);
Console.WriteLine(e.MessageCount + " messages are still available to pull.");
} else {
// We tried to pull a message, but there were none available to pull.
Console.WriteLine("No messages available to pull.");
}
};
// Attach a consumer to "MyQueue".
amqpc1.Consume("channel", "MyQueue", "consumerTag", false, true, false, false);
// Or, try to retrieve a message from "MyQueue".
amqpc1.RetrieveMessage("channel", "MyQueue", true);
RollbackTransaction Method (IPWorksIoT_AMQPClassic Class)
Rolls back the current transaction for a channel.
Object Oriented Interface
public function doRollbackTransaction($channelname);
Procedural Interface
ipworksiot_amqpclassic_do_rollbacktransaction($res, $channelname);
Remarks
This method rolls back the current transaction for the channel with the given ChannelName. A new transaction is started immediately after the current one is rolled back.
Refer to EnableTransactionMode for more information about transactions.
An exception is thrown if a channel with the given ChannelName doesn't exist, or if the server returns an error because the channel does not have transaction mode enabled.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
SetChannelAccept Method (IPWorksIoT_AMQPClassic Class)
Disables or enables message acceptance for a given channel.
Object Oriented Interface
public function doSetChannelAccept($channelname, $accept);
Procedural Interface
ipworksiot_amqpclassic_do_setchannelaccept($res, $channelname, $accept);
Remarks
This method is used to disable and enable message acceptance for the channel specified by ChannelName.
A channel is always configured to accept messages when first created, allowing the server to freely deliver messages to the class for any consumers that have been created on that channel using the Consume method.
Disabling message acceptance for a channel prevents the server from automatically delivering messages to the class over it; however, it is still possible to use the RetrieveMessage method to synchronously attempt to retrieve a message on a channel with message acceptance disabled.
An exception is thrown if no channel with the given ChannelName exists, or (for RabbitMQ only) if the server returns an error because Accept was False. (RabbitMQ does not support disabling message acceptance.)
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
SetQoS Method (IPWorksIoT_AMQPClassic Class)
Requests a specific quality of service (QoS).
Object Oriented Interface
public function doSetQoS($channelname, $prefetchsize, $prefetchcount, $global);
Procedural Interface
ipworksiot_amqpclassic_do_setqos($res, $channelname, $prefetchsize, $prefetchcount, $global);
Remarks
This method is used to request a specific quality of service for a certain scope. When the PrefetchSize and/or PrefetchCount are set for a certain scope, the server will limit how many messages it sends to the class before stopping to wait for one or more of them to be acknowledged.
ChannelName is the name of the channel which is used to send the request. Depending on the server and what Global is set to, it may also be significant to the request itself (refer to the Global parameter's description, below, for more information).
PrefetchSize specifies a window size in bytes; i.e., the server will stop sending messages if the total size of all of the currently unacknowledged messages already sent, plus the size of the next message that could be sent, exceeds PrefetchSize bytes. A PrefetchSize of 0 indicates no limit. (Note that RabbitMQ does not support prefetch size limits.)
PrefetchCount specifies the number of unacknowledged messages the server will limit itself to sending. A PrefetchCount of 0 indicates no limit.
Global specifies the scope which the QoS request should apply to. It is interpreted differently based on whether the server is RabbitMQ or not. Refer to this table:
Global is... | RabbitMQ | Other Servers |
False | QoS will be applied individually to each new consumer on the specified channel (existing consumers are unaffected). | QoS applied to all existing and new consumers on the specified channel. |
True | QoS applied to all existing and new consumers on the specified channel. | QoS applied to all existing and new consumers on the whole connection. |
Keep the following things in mind when using QoS:
- The limits specified by a QoS request only affect messages that require acknowledgment.
- How the server chooses to handle interactions between QoS settings at different scopes is server-dependent.
An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error for any reason.
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
UnbindQueue Method (IPWorksIoT_AMQPClassic Class)
Removes a previously-created queue binding.
Object Oriented Interface
public function doUnbindQueue($channelname, $queuename, $exchangename, $routingkey);
Procedural Interface
ipworksiot_amqpclassic_do_unbindqueue($res, $channelname, $queuename, $exchangename, $routingkey);
Remarks
This method removes a previously-created queue binding.
ChannelName controls what channel the class will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.
QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.
The server's default exchange may be specified by passing empty string for ExchangeName. Otherwise, ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.
RoutingKey should be the same routing key used when originally creating the binding that is to be removed. For bindings created using arguments instead of a routing key, the Arguments collection must contain the same items used originally instead.
An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:
- No queue with the given QueueName exists. (Does not apply to RabbitMQ.)
- No exchange with the given ExchangeName exists. (Does not apply to RabbitMQ.)
Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.
ChannelReadyToSend Event (IPWorksIoT_AMQPClassic Class)
Fires when a channel is ready to send messages.
Object Oriented Interface
public function fireChannelReadyToSend($param);
Procedural Interface
ipworksiot_amqpclassic_register_callback($res, 1, array($this, 'fireChannelReadyToSend'));
Parameter List
'channelname'
Remarks
This event fires when a channel is ready to send messages.
ChannelName is the name of the channel.
Connected Event (IPWorksIoT_AMQPClassic Class)
This event is fired immediately after a connection completes (or fails).
Object Oriented Interface
public function fireConnected($param);
Procedural Interface
ipworksiot_amqpclassic_register_callback($res, 2, array($this, 'fireConnected'));
Parameter List
'statuscode'
'description'
Remarks
If the connection is made normally, StatusCode is 0 and Description is "OK".
If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
ConnectionStatus Event (IPWorksIoT_AMQPClassic Class)
This event is fired to indicate changes in the connection state.
Object Oriented Interface
public function fireConnectionStatus($param);
Procedural Interface
ipworksiot_amqpclassic_register_callback($res, 3, array($this, 'fireConnectionStatus'));
Parameter List
'connectionevent'
'statuscode'
'description'
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 (IPWorksIoT_AMQPClassic Class)
This event is fired when a connection is closed.
Object Oriented Interface
public function fireDisconnected($param);
Procedural Interface
ipworksiot_amqpclassic_register_callback($res, 4, array($this, 'fireDisconnected'));
Parameter List
'statuscode'
'description'
Remarks
If the connection is broken normally, StatusCode is 0 and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.
Please refer to the Error Codes section for more information.
Error Event (IPWorksIoT_AMQPClassic Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworksiot_amqpclassic_register_callback($res, 5, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class 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.
Log Event (IPWorksIoT_AMQPClassic Class)
Fires once for each log message.
Object Oriented Interface
public function fireLog($param);
Procedural Interface
ipworksiot_amqpclassic_register_callback($res, 6, array($this, 'fireLog'));
Parameter List
'loglevel'
'message'
'logtype'
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of the Message. Possible values are:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data is logged. |
3 (Debug) | Debug data is logged. |
LogType identifies the type of log entry. Possible values are:
- Info: General information about the class.
- Frame: Frame status messages.
MessageIn Event (IPWorksIoT_AMQPClassic Class)
Fires when a message is received; as well as when an attempt is made to fetch a message from a currently empty queue.
Object Oriented Interface
public function fireMessageIn($param);
Procedural Interface
ipworksiot_amqpclassic_register_callback($res, 7, array($this, 'fireMessageIn'));
Parameter List
'channelname'
'consumertag'
'deliverytag'
'redelivered'
'exchangename'
'routingkey'
'messagecount'
'accept'
Remarks
This event fires anytime a message is received. There are two possible ways for the class to receive a message:
- Messages can be asynchronously pushed to the class from the server. At any point in time, the server may push a message to the class from a queue that the Consume method has been used to attach a consumer to.
- Messages can be synchronously pulled from the server by the class. The RetrieveMessage method is used to attempt to pull (or "retrieve") messages from a specific queue.
This event also fires anytime RetrieveMessage is called against a queue that currently has no messages available to pull. This is a special case, and results in only the ChannelName and MessageCount event parameters being populated.
Other than that special case, and any exceptions noted below, this event's parameters are populated the same way regardless of the manner in which messages are received.
ChannelName always reflects the name of the associated channel.
ConsumerTag reflects the consumer tag associated with the consumer that caused the server to push the message to the class. (ConsumerTag is always empty for messages pulled from the server by RetrieveMessage since no consumers are involved.)
DeliveryTag reflects the server-assigned, channel-specific delivery tag number for the incoming message.
Redelivered reflects whether the server is redelivering a message that is has delivered previously.
ExchangeName reflects the name of the exchange to which the incoming message was originally published. (If the message was originally published to the server's default exchange, whose name is always the empty string, ExchangeName will also be empty.)
RoutingKey reflects the routing key that the message was originally published with.
MessageCount is always -1 when this event fires due to a message being pushed to the class by the server. When this event fires as a result of RetrieveMessage being called, MessageCount reflects the number of messages still available in the queue the class tried to pull a message from (even if there were no messages available to pull).
The Accept parameter can be set to control how the class responds to the incoming message, if it needs to be acknowledged (if the message doesn't need to be acknowledged, the value set to the Accept parameter is ignored). Valid values are:
- 0 - default: Accept the message; send a positive acknowledgment.
- 1: Silently accept the message; don't send any acknowledgment.
- 2: Accept the message; send a cumulative positive acknowledgment coving this, and all previously unacknowledged, messages.
- 3: Reject the message; send a negative acknowledgment for it, and instruct the server not to return it to the queue.
- 4: Reject the message; send a negative acknowledgment for it, and instruct the server to return it to the queue.
If the value provided for the Accept parameter isn't one of those described above, the default (0) will be used instead.
Receiving a Message
// MessageIn event handler.
amqpc1.OnMessageIn += (s, e) => {
if (e.MessageCount == -1) {
// The server pushed a message to us asynchronously due to a consumer we created.
Console.WriteLine("The server pushed this message to us via consumer '" + e.ConsumerTag + "':");
Console.WriteLine(amqpc1.ReceivedMessage.Body);
} else if (e.DeliveryTag > 0) {
// We pulled a message from a queue with the RetrieveMessage() method.
Console.WriteLine("Message successfully pulled:");
Console.WriteLine(amqpc1.ReceivedMessage.Body);
Console.WriteLine(e.MessageCount + " messages are still available to pull.");
} else {
// We tried to pull a message, but there were none available to pull.
Console.WriteLine("No messages available to pull.");
}
};
// Attach a consumer to "MyQueue".
amqpc1.Consume("channel", "MyQueue", "consumerTag", false, true, false, false);
// Or, try to retrieve a message from "MyQueue".
amqpc1.RetrieveMessage("channel", "MyQueue", true);
MessageOut Event (IPWorksIoT_AMQPClassic Class)
Fires when a message is published.
Object Oriented Interface
public function fireMessageOut($param);
Procedural Interface
ipworksiot_amqpclassic_register_callback($res, 8, array($this, 'fireMessageOut'));
Parameter List
'channelname'
'exchangename'
'routingkey'
'messageid'
'deliverytag'
'accepted'
Remarks
This event fires anytime a message is published; or after an outgoing message has been acknowledged by the server, if the channel it was published on is in "publish confirmations" mode.
ChannelName reflects the name of the channel the message was published on.
ExchangeName reflects the name of the exchange the message was published to. (If the message was published to the server's default exchange, whose name is always the empty string, ExchangeName will also be empty.)
RoutingKey reflects the routing key that the message was published with.
MessageId reflects the message's unique Id, if one was set.
DeliveryTag reflects the channel-specific delivery tag number for the message. (Note that this is only populated for messages published on a channel in "publish confirmations" mode; otherwise it will be set to -1.)
Accepted indicates whether the server published back a positive True or negative False acknowledgment for the outgoing message. Note that this is only valid for messages published on a channel in "publish confirmations" mode; Accepted will always be True messages published on a channel in normal or transaction mode.
Refer to EnablePublishConfirms for more information about channels in "publish confirmations" mode.
MessageReturned Event (IPWorksIoT_AMQPClassic Class)
Fires if a previously published message is returned by the server due to it being undeliverable.
Object Oriented Interface
public function fireMessageReturned($param);
Procedural Interface
ipworksiot_amqpclassic_register_callback($res, 9, array($this, 'fireMessageReturned'));
Parameter List
'channelname'
'replycode'
'replytext'
'exchangename'
'routingkey'
Remarks
This event fires if the server returns a previously published message because it could not deliver it. Typically, messages are only undeliverable in one of the following situations:
- The message was originally published with the Mandatory option enabled, but there were no queues it could be routed to.
- The message was originally published with the Immediate option enabled, but there were no consumers it could be delivered to immediately on any queue it was routed to (or there were no queues it could be routed to).
The ReceivedMessage property will be populated with the returned message.
ChannelName reflects the name of the channel the message was originally published on.
ReplyCode will be an AMQP error code that indicates the reason why the message was returned. (Tip: The AMQPClassic class's Error Codes page includes the various AMQP error codes.)
ReplyText will be a message with further details about why the message was returned.
ExchangeName reflects the name of the exchange to which the message was originally published. (If the message was originally published to the server's default exchange, whose name is always the empty string, ExchangeName will also be empty.)
RoutingKey reflects the routing key that the message was originally published with.
SSLServerAuthentication Event (IPWorksIoT_AMQPClassic Class)
Fired after the server presents its certificate to the client.
Object Oriented Interface
public function fireSSLServerAuthentication($param);
Procedural Interface
ipworksiot_amqpclassic_register_callback($res, 10, array($this, 'fireSSLServerAuthentication'));
Parameter List
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'
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 (IPWorksIoT_AMQPClassic Class)
Fired when secure connection progress messages are available.
Object Oriented Interface
public function fireSSLStatus($param);
Procedural Interface
ipworksiot_amqpclassic_register_callback($res, 11, array($this, 'fireSSLStatus'));
Parameter List
'message'
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Config Settings (AMQPClassic Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.AMQPClassic Config Settings
It is possible to pass empty string for the ConsumerTag parameter when calling the Consume method, in which case the server will auto-generate a consumer tag.
The default value is "en_US", which is supported by all AMQP 0.9.1 servers.
The value of this setting is formatted as a space-separated list of message locales.
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 65535 (0xFFFF). Note that this value is negotiated during the connection process; if the value provided by the server is lower than the specified value, the server's value will be used instead (and this setting will be updated accordingly).
The default is 2147483647 (0x7FFFFFFF). Note that this value is negotiated during the connection process; if the value provided by the server is lower than the specified value, the server's value will be used instead (and this setting will be updated accordingly).
The value of this setting is formatted as a space-separated list of authentication mechanisms.
This setting does nothing if the RabbitMQCompatible configuration setting is disabled.
Note: Currently this setting will always return "0.9.1", and cannot be changed. The AMQP class may be used instead of this one if AMQP 1.0 support is needed.
It is possible to pass empty string for the QueueName parameter when calling the DeclareQueue method to have the server create a new queue with an automatically generated name, which can then be retrieved by querying this setting.
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 classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs 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 classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs 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 class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
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 configuration setting 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 configuration 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). OpenSSL recommends the use of 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 the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. 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 class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
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 the following:
- 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_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only 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 class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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 non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class 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 configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
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 configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "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 User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (AMQPClassic Class)
AMQPClassic Errors
311 | AMQP Channel Error content-too-large: Content too large. |
312 | AMQP Channel Error no-route: Cannot deliver message published with "mandatory" flag set; message cannot be routed to any queue. |
313 | AMQP Channel Error no-consumers: Cannot deliver message published with "immediate" flag set; all possible queues are either non-empty or have no consumers. |
320 | AMQP Connection Error connection-forced: Connection forced to close. |
402 | AMQP Connection Error invalid-path: Invalid virtual host path specified. |
403 | AMQP Channel Error access-refused: Attempted to work with a server entity (exchange, queue, etc.) without necessary permissions. |
404 | AMQP Channel Error not-found: Attempted to work with a server entity (exchange, queue, etc.) that does not exist. |
405 | AMQP Channel Error resource-locked: Attempted to work with a server entity (exchange, queue, etc.) that is currently locked by another client. |
406 | AMQP Channel Error precondition-failed: Request failed due to one or more precondition failures. |
501 | AMQP Connection Error frame-error: Server received an AMQP frame that it could not decode. |
502 | AMQP Connection Error syntax-error: Server received an AMQP frame that contained illegal values for one or more fields. |
503 | AMQP Connection Error command-invalid: Server received an invalid sequence of frame, attempting to perform an invalid operation. |
504 | AMQP Connection Error channel-error: Attempted to work with a channel that does not exist (or was not opened correctly). |
505 | AMQP Connection Error unexpected-frame: Server received a frame that was unexpected, typically with regards to the content header and body. |
506 | AMQP Connection Error resource-error: Server could not complete the request due to insufficient resources. |
530 | AMQP Connection Error not-allowed: Attempted to work with some server entity (exchange, queue, etc.) in a manner that is not allowed. |
540 | AMQP Connection Error not-implemented: Requested an operation not supported by the server. |
541 | AMQP Connection Error internal-error: The server encountered an internal error while attempting to process the request. |
600 | General AMQP protocol error. Refer to the error message for more information. |
601 | Cannot open another channel. |
602 | Cannot modify message data. |
603 | Cannot publish message on inactive channel. |
604 | Action not supported. |
606 | Cannot modify configuration setting. |
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
302 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |