IPWorks IoT 2022 PHP Edition
Version 22.0 [Build 8369]

AMQP Class

Properties   Methods   Events   Config Settings   Errors  

An easy-to-use AMQP 1.0 client implementation.

Class Name

IPWorksIoT_AMQP

Procedural Interface

 ipworksiot_amqp_open();
 ipworksiot_amqp_close($res);
 ipworksiot_amqp_register_callback($res, $id, $function);
 ipworksiot_amqp_get_last_error($res);
 ipworksiot_amqp_get_last_error_code($res);
 ipworksiot_amqp_set($res, $id, $index, $value);
 ipworksiot_amqp_get($res, $id, $index);
 ipworksiot_amqp_do_closelink($res, $name);
 ipworksiot_amqp_do_closesession($res, $name);
 ipworksiot_amqp_do_config($res, $configurationstring);
 ipworksiot_amqp_do_connect($res);
 ipworksiot_amqp_do_connectto($res, $host, $port);
 ipworksiot_amqp_do_createreceiverlink($res, $sessionname, $name, $source);
 ipworksiot_amqp_do_createsenderlink($res, $sessionname, $name, $target);
 ipworksiot_amqp_do_createsession($res, $name);
 ipworksiot_amqp_do_disconnect($res);
 ipworksiot_amqp_do_doevents($res);
 ipworksiot_amqp_do_fetchmessage($res, $linkname);
 ipworksiot_amqp_do_interrupt($res);
 ipworksiot_amqp_do_reset($res);
 ipworksiot_amqp_do_resetmessage($res);
 ipworksiot_amqp_do_sendmessage($res, $linkname);

Remarks

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

Connecting

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

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

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

Connecting and Creating a Session amqp1.ContainerId = "testClient"; amqp1.ConnectTo("amqp.test-server.com", 5672); amqp1.CreateSession("TestSession");

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

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

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

Creating Sender Links

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

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

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

Sending Messages

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

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

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

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

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

Sending a Message amqp1.OnMessageOut += (s, e) => { Console.WriteLine("Message with Id '" + e.MessageId + "' has been sent on link '" + e.LinkName + "'."); }; amqp1.Message.MessageId = "TestMessageId"; amqp1.Message.Value = "Hello, world!"; amqp1.Message.ValueType = AMQPValueTypes.mvtString; amqp1.SendMessage("TestSenderLink");

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

Sending Composite AMQP Data

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

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

Creating Receiver Links

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

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

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

Creating a Receiver Link // Creating an automatic receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmAutomatic; amqp1.CreateReceiverLink("TestSession", "TestAutoReceiverLink", "TestSource1"); // Creating a fetch-based receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmFetch; amqp1.CreateReceiverLink("TestSession", "TestFetchReceiverLink", "TestSource2");

Receiving Messages

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

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

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

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

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

Property List


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

AuthSchemeThe authentication scheme to use when connecting.
ConnectedThis property triggers a connection or disconnection.
ContainerIdThe container Id the class should advertise when connecting.
FetchTimeoutHow long the class should wait for a message to be received after FetchMessage is called.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the transmission control protocol (TCP) port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleTimeoutThe maximum period of inactivity the class will allow before disconnecting.
IncomingMessageCountThe number of records in the IncomingMessage arrays.
IncomingMessageAbsoluteExpiryTimeThe absolute time at which this message should be considered expired.
IncomingMessageContentEncodingThe content encoding of this message's data.
IncomingMessageContentTypeThe content type of this message's data.
IncomingMessageCorrelationIdThe correlation Id of this message.
IncomingMessageCreationTimeThe creation time of this message.
IncomingMessageDeliveryCountHow many previous attempts there have been to deliver this message.
IncomingMessageDurableWhether this message is durable.
IncomingMessageFirstAcquirerWhether this message may have been acquired by other links previously.
IncomingMessageGroupIdThe Id of the group this message belongs to.
IncomingMessageGroupSequenceThe position of this message within its group.
IncomingMessageLinkNameThe name of the link this message is associated with.
IncomingMessageIdThe unique Id of this message.
IncomingMessagePriorityThe priority of this message.
IncomingMessageReplyToThe address of the node to send replies to for this message.
IncomingMessageReplyToGroupIdThe Id of the group to send replies to for this message.
IncomingMessageSettledWhether this message is settled.
IncomingMessageSubjectThe subject of this message.
IncomingMessageToThe address of the node which this message is intended for.
IncomingMessageTTLThe time-to-live value for this message.
IncomingMessageUserIdThe identity of the user responsible for producing this message.
IncomingMessageValueThis message's value.
IncomingMessageValueTypeThis message's value data type.
LinkCountThe number of records in the Link arrays.
LinkAvailableThe number of messages which this link's sender could send if it had credit for them.
LinkChannelNameThe channel name this link is using.
LinkCreditThe amount of credit currently available to this link's sender.
LinkDeliveryCountThe current delivery count value for this link.
LinkNameThis link's name.
LinkReadyToSendWhether this link is ready to send a message.
LinkReceiveModeThe receive mode this link is operating in.
LinkRoleThe class's role on this link.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the class binds.
MessageAbsoluteExpiryTimeThe absolute time at which this message should be considered expired.
MessageContentEncodingThe content encoding of this message's data.
MessageContentTypeThe content type of this message's data.
MessageCorrelationIdThe correlation Id of this message.
MessageCreationTimeThe creation time of this message.
MessageDeliveryCountHow many previous attempts there have been to deliver this message.
MessageDurableWhether this message is durable.
MessageFirstAcquirerWhether this message may have been acquired by other links previously.
MessageGroupIdThe Id of the group this message belongs to.
MessageGroupSequenceThe position of this message within its group.
MessageLinkNameThe name of the link this message is associated with.
MessageIdThe unique Id of this message.
MessagePriorityThe priority of this message.
MessageReplyToThe address of the node to send replies to for this message.
MessageReplyToGroupIdThe Id of the group to send replies to for this message.
MessageSettledWhether this message is settled.
MessageSubjectThe subject of this message.
MessageToThe address of the node which this message is intended for.
MessageTTLThe time-to-live value for this message.
MessageUserIdThe identity of the user responsible for producing this message.
MessageValueThis message's value.
MessageValueTypeThis message's value data type.
OutgoingMessageCountThe number of records in the OutgoingMessage arrays.
OutgoingMessageAbsoluteExpiryTimeThe absolute time at which this message should be considered expired.
OutgoingMessageContentEncodingThe content encoding of this message's data.
OutgoingMessageContentTypeThe content type of this message's data.
OutgoingMessageCorrelationIdThe correlation Id of this message.
OutgoingMessageCreationTimeThe creation time of this message.
OutgoingMessageDeliveryCountHow many previous attempts there have been to deliver this message.
OutgoingMessageDurableWhether this message is durable.
OutgoingMessageFirstAcquirerWhether this message may have been acquired by other links previously.
OutgoingMessageGroupIdThe Id of the group this message belongs to.
OutgoingMessageGroupSequenceThe position of this message within its group.
OutgoingMessageLinkNameThe name of the link this message is associated with.
OutgoingMessageIdThe unique Id of this message.
OutgoingMessagePriorityThe priority of this message.
OutgoingMessageReplyToThe address of the node to send replies to for this message.
OutgoingMessageReplyToGroupIdThe Id of the group to send replies to for this message.
OutgoingMessageSettledWhether this message is settled.
OutgoingMessageSubjectThe subject of this message.
OutgoingMessageToThe address of the node which this message is intended for.
OutgoingMessageTTLThe time-to-live value for this message.
OutgoingMessageUserIdThe identity of the user responsible for producing this message.
OutgoingMessageValueThis message's value.
OutgoingMessageValueTypeThis message's value data type.
PasswordA password to use for SASL authentication.
ReadyToSendIndicates whether the class is ready to send data.
ReceivedMessageAbsoluteExpiryTimeThe absolute time at which this message should be considered expired.
ReceivedMessageContentEncodingThe content encoding of this message's data.
ReceivedMessageContentTypeThe content type of this message's data.
ReceivedMessageCorrelationIdThe correlation Id of this message.
ReceivedMessageCreationTimeThe creation time of this message.
ReceivedMessageDeliveryCountHow many previous attempts there have been to deliver this message.
ReceivedMessageDurableWhether this message is durable.
ReceivedMessageFirstAcquirerWhether this message may have been acquired by other links previously.
ReceivedMessageGroupIdThe Id of the group this message belongs to.
ReceivedMessageGroupSequenceThe position of this message within its group.
ReceivedMessageLinkNameThe name of the link this message is associated with.
ReceivedMessageIdThe unique Id of this message.
ReceivedMessagePriorityThe priority of this message.
ReceivedMessageReplyToThe address of the node to send replies to for this message.
ReceivedMessageReplyToGroupIdThe Id of the group to send replies to for this message.
ReceivedMessageSettledWhether this message is settled.
ReceivedMessageSubjectThe subject of this message.
ReceivedMessageToThe address of the node which this message is intended for.
ReceivedMessageTTLThe time-to-live value for this message.
ReceivedMessageUserIdThe identity of the user responsible for producing this message.
ReceivedMessageValueThis message's value.
ReceivedMessageValueTypeThis message's value data type.
ReceiveModeControls what mode new receiver links are created with.
RemoteHostThis property includes the address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe port of the AQMP server (default is 5672). The default port for SSL is 5671.
SessionCountThe number of records in the Session arrays.
SessionIncomingWindowThe incoming window size of this session.
SessionNameThe name of this session.
SessionOutgoingWindowThe outgoing window size of this session.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLEnabledWhether TLS/SSL is enabled.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).
TimeoutA timeout for the class.
UserA username to use for SASL authentication.

Method List


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

CloseLinkCloses a link.
CloseSessionCloses a session.
ConfigSets or retrieves a configuration setting.
ConnectThis method connects to a remote host.
ConnectToThis method connects to a remote host.
CreateReceiverLinkCreates a new receiver link with the given name on the specified session.
CreateSenderLinkCreates a new sender link with the given name on the specified session.
CreateSessionCreates a new session with the given name.
DisconnectThis method disconnects from the remote host.
DoEventsProcesses events from the internal message queue.
FetchMessageFetches a single message over the specified receiver link.
InterruptThis method interrupts the current action.
ResetReset the class.
ResetMessageResets the Message properties.
SendMessageSends a message on the specified link.

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.

ConnectedThis event is fired immediately after a connection completes (or fails).
ConnectionStatusThis event is fired to indicate changes in the connection state.
DisconnectedThis event is fired when a connection is closed.
ErrorInformation about errors during data delivery.
LinkReadyToSendFires when a sender link is ready to send messages.
LogFires once for each log message.
MessageInFires when the class receives a message.
MessageOutFires when the class sends a message.
MessageOutcomeFires when a message's outcome is available.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Config Settings


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

AuthorizationIdentityThe value to use as the authorization identity when SASL authentication is used.
DefaultCreditThe amount of credit to create new receiver links with.
DefaultCreditThresholdThe credit threshold to create new receiver links with.
DefaultIncomingWindowThe incoming window size to create new sessions with.
DefaultOutgoingWindowThe outgoing window size to create new sessions with.
DefaultSenderSettleModeThe sender settle mode to create new links with.
GenerateMessageIdWhether a unique message Id should be automatically generated when sending a message.
LogLevelThe level of detail that is logged.
MaxFrameSizeThe maximum frame size.
MaxLinkCountPerSessionThe maximum number of links to restrict new sessions to.
MaxMessageSizeThe maximum message size to restrict new links to.
MaxSessionCountThe maximum number of sessions.
ModifiedDeliveryFailedWhether the sender should treat this transfer as an unsuccessful delivery attempt.
ModifiedMessageAnnotationsThe message annotations that the sender should merge into those already on the message.
ModifiedUndeliverableHereWhether the receiver has indicated that the sender should not attempt to redeliver the message.
ProtocolVersionThe AMQP protocol version to conform to.
RejectErrorConditionThe error condition included with a 'Rejected' delivery outcome.
RejectErrorDescriptionThe error description included with a 'Rejected' delivery outcome.
SenderSettleMode[LinkName]Retrieves the negotiated sender settle mode for the specified link.
SimplifiedJSONFormatWhether to output simplified JSON where possible.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

AuthScheme Property (IPWorksIoT_AMQP Class)

The authentication scheme to use when connecting.

Object Oriented Interface


public function getAuthScheme();


public function setAuthScheme($value);

Procedural Interface


ipworksiot_amqp_get($res, 1 );


ipworksiot_amqp_set($res, 1, $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

Connected Property (IPWorksIoT_AMQP Class)

This property triggers a connection or disconnection.

Object Oriented Interface


public function getConnected();


public function setConnected($value);

Procedural Interface


ipworksiot_amqp_get($res, 2 );


ipworksiot_amqp_set($res, 2, $value );

Default Value

false

Remarks

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

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

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

This property is not available at design time.

Data Type

Boolean

ContainerId Property (IPWorksIoT_AMQP Class)

The container Id the class should advertise when connecting.

Object Oriented Interface


public function getContainerId();


public function setContainerId($value);

Procedural Interface


ipworksiot_amqp_get($res, 3 );


ipworksiot_amqp_set($res, 3, $value );

Default Value

''

Remarks

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

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

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

Note: The container Id cannot be changed while connected.

This property is not available at design time.

Data Type

String

FetchTimeout Property (IPWorksIoT_AMQP Class)

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

Object Oriented Interface


public function getFetchTimeout();


public function setFetchTimeout($value);

Procedural Interface


ipworksiot_amqp_get($res, 4 );


ipworksiot_amqp_set($res, 4, $value );

Default Value

60

Remarks

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

Refer to FetchMessage for more information.

This property is not available at design time.

Data Type

Integer

FirewallAutoDetect Property (IPWorksIoT_AMQP 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_amqp_get($res, 5 );


ipworksiot_amqp_set($res, 5, $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_AMQP Class)

This property determines the type of firewall to connect through.

Object Oriented Interface


public function getFirewallType();


public function setFirewallType($value);

Procedural Interface


ipworksiot_amqp_get($res, 6 );


ipworksiot_amqp_set($res, 6, $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_AMQP Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface


public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface


ipworksiot_amqp_get($res, 7 );


ipworksiot_amqp_set($res, 7, $value );

Default Value

''

Remarks

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (IPWorksIoT_AMQP 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_amqp_get($res, 8 );


ipworksiot_amqp_set($res, 8, $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_AMQP 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_amqp_get($res, 9 );


ipworksiot_amqp_set($res, 9, $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_AMQP Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface


public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface


ipworksiot_amqp_get($res, 10 );


ipworksiot_amqp_set($res, 10, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

IdleTimeout Property (IPWorksIoT_AMQP Class)

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

Object Oriented Interface


public function getIdleTimeout();


public function setIdleTimeout($value);

Procedural Interface


ipworksiot_amqp_get($res, 11 );


ipworksiot_amqp_set($res, 11, $value );

Default Value

0

Remarks

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

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

Note: The idle timeout cannot be changed while connected.

This property is not available at design time.

Data Type

Integer

IncomingMessageCount Property (IPWorksIoT_AMQP Class)

The number of records in the IncomingMessage arrays.

Object Oriented Interface


public function getIncomingMessageCount();


Procedural Interface


ipworksiot_amqp_get($res, 12 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at IncomingMessageCount - 1.

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

Data Type

Integer

IncomingMessageAbsoluteExpiryTime Property (IPWorksIoT_AMQP Class)

The absolute time at which this message should be considered expired.

Object Oriented Interface


public function getIncomingMessageAbsoluteExpiryTime($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 13 , $incomingmessageindex);


Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

Long64

IncomingMessageContentEncoding Property (IPWorksIoT_AMQP Class)

The content encoding of this message's data.

Object Oriented Interface


public function getIncomingMessageContentEncoding($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 14 , $incomingmessageindex);


Default Value

''

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if IncomingMessageValueType is not set to mvtBinary (16).

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessageContentType Property (IPWorksIoT_AMQP Class)

The content type of this message's data.

Object Oriented Interface


public function getIncomingMessageContentType($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 15 , $incomingmessageindex);


Default Value

''

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if IncomingMessageValueType is not set to mvtBinary (16).

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessageCorrelationId Property (IPWorksIoT_AMQP Class)

The correlation Id of this message.

Object Oriented Interface


public function getIncomingMessageCorrelationId($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 16 , $incomingmessageindex);


Default Value

''

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessageCreationTime Property (IPWorksIoT_AMQP Class)

The creation time of this message.

Object Oriented Interface


public function getIncomingMessageCreationTime($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 17 , $incomingmessageindex);


Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

Long64

IncomingMessageDeliveryCount Property (IPWorksIoT_AMQP Class)

How many previous attempts there have been to deliver this message.

Object Oriented Interface


public function getIncomingMessageDeliveryCount($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 18 , $incomingmessageindex);


Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

Long64

IncomingMessageDurable Property (IPWorksIoT_AMQP Class)

Whether this message is durable.

Object Oriented Interface


public function getIncomingMessageDurable($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 19 , $incomingmessageindex);


Default Value

false

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

Boolean

IncomingMessageFirstAcquirer Property (IPWorksIoT_AMQP Class)

Whether this message may have been acquired by other links previously.

Object Oriented Interface


public function getIncomingMessageFirstAcquirer($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 20 , $incomingmessageindex);


Default Value

false

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

Boolean

IncomingMessageGroupId Property (IPWorksIoT_AMQP Class)

The Id of the group this message belongs to.

Object Oriented Interface


public function getIncomingMessageGroupId($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 21 , $incomingmessageindex);


Default Value

''

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessageGroupSequence Property (IPWorksIoT_AMQP Class)

The position of this message within its group.

Object Oriented Interface


public function getIncomingMessageGroupSequence($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 22 , $incomingmessageindex);


Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

Long64

IncomingMessageLinkName Property (IPWorksIoT_AMQP Class)

The name of the link this message is associated with.

Object Oriented Interface


public function getIncomingMessageLinkName($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 23 , $incomingmessageindex);


Default Value

''

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessageId Property (IPWorksIoT_AMQP Class)

The unique Id of this message.

Object Oriented Interface


public function getIncomingMessageId($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 24 , $incomingmessageindex);


Default Value

''

Remarks

The unique Id of this message.

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

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessagePriority Property (IPWorksIoT_AMQP Class)

The priority of this message.

Object Oriented Interface


public function getIncomingMessagePriority($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 25 , $incomingmessageindex);


Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

Integer

IncomingMessageReplyTo Property (IPWorksIoT_AMQP Class)

The address of the node to send replies to for this message.

Object Oriented Interface


public function getIncomingMessageReplyTo($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 26 , $incomingmessageindex);


Default Value

''

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessageReplyToGroupId Property (IPWorksIoT_AMQP Class)

The Id of the group to send replies to for this message.

Object Oriented Interface


public function getIncomingMessageReplyToGroupId($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 27 , $incomingmessageindex);


Default Value

''

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessageSettled Property (IPWorksIoT_AMQP Class)

Whether this message is settled.

Object Oriented Interface


public function getIncomingMessageSettled($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 28 , $incomingmessageindex);


Default Value

true

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

Boolean

IncomingMessageSubject Property (IPWorksIoT_AMQP Class)

The subject of this message.

Object Oriented Interface


public function getIncomingMessageSubject($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 29 , $incomingmessageindex);


Default Value

''

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject set.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessageTo Property (IPWorksIoT_AMQP Class)

The address of the node which this message is intended for.

Object Oriented Interface


public function getIncomingMessageTo($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 30 , $incomingmessageindex);


Default Value

''

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessageTTL Property (IPWorksIoT_AMQP Class)

The time-to-live value for this message.

Object Oriented Interface


public function getIncomingMessageTTL($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 31 , $incomingmessageindex);


Default Value

-1

Remarks

The time-to-live value for this message.

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

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

Long64

IncomingMessageUserId Property (IPWorksIoT_AMQP Class)

The identity of the user responsible for producing this message.

Object Oriented Interface


public function getIncomingMessageUserId($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 32 , $incomingmessageindex);


Default Value

''

Remarks

The identity of the user responsible for producing this message.

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

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

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessageValue Property (IPWorksIoT_AMQP Class)

This message's value.

Object Oriented Interface


public function getIncomingMessageValue($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 33 , $incomingmessageindex);


Default Value

''

Remarks

This message's value.

This property specifies the value to send in this message. The IncomingMessageValueType property should be used to specify the data type of the value.

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

String

IncomingMessageValueType Property (IPWorksIoT_AMQP Class)

This message's value data type.

Object Oriented Interface


public function getIncomingMessageValueType($incomingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 34 , $incomingmessageindex);


Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's IncomingMessageValue.

The table below shows the possible value types, their descriptions, and how to format the data assigned to IncomingMessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

Type Description Value Format
mvtNull (0 - default) Null N/A (IncomingMessageValue is ignored)
mvtBoolean (1) Boolean "True" or "False"
mvtUbyte (2) Unsigned byte 0 to 255
mvtUshort (3) Unsigned short 0 to 65535
mvtUint (4) Unsigned integer 0 to 4294967295
mvtUlong (5) Unsigned long 0 to 18446744073709551615
mvtByte (6) Byte -128 to 127
mvtShort (7) Short -32768 to 32767
mvtInt (8) Integer -2147483648 to 2147483647
mvtLong (9) Long -9223372036854775808 to 9223372036854775807
mvtFloat (10) Float IEEE 754 32-bit floating point number
mvtDouble (11) Double IEEE 754 64-bit floating point number
mvtDecimal (12) Decimal Hex-encoded byte string
mvtChar (13) Char Single character
mvtTimestamp (14) Timestamp Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC).
mvtUuid (15) UUID Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive)
mvtBinary (16) Binary data Hex-encoded byte string
mvtString (17) String String
mvtSymbol (18) Symbolic value ASCII string
mvtJson (19) Composite data Composite data JSON structured according to the schema shown in the SendMessage method's documentation

The $incomingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

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

Data Type

Integer

LinkCount Property (IPWorksIoT_AMQP Class)

The number of records in the Link arrays.

Object Oriented Interface


public function getLinkCount();


Procedural Interface


ipworksiot_amqp_get($res, 35 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at LinkCount - 1.

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

Data Type

Integer

LinkAvailable Property (IPWorksIoT_AMQP Class)

The number of messages which this link's sender could send if it had credit for them.

Object Oriented Interface


public function getLinkAvailable($linkindex);


Procedural Interface


ipworksiot_amqp_get($res, 36 , $linkindex);


Default Value

0

Remarks

The number of messages which this link's sender could send if it had credit for them.

This property returns the number of messages which this link's sender has indicated that it could send if it had the credit to do so.

The $linkindex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Long64

LinkChannelName Property (IPWorksIoT_AMQP Class)

The channel name this link is using.

Object Oriented Interface


public function getLinkChannelName($linkindex);


Procedural Interface


ipworksiot_amqp_get($res, 37 , $linkindex);


Default Value

''

Remarks

The channel name this link is using.

This property holds the channel name this link is using.

The $linkindex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

String

LinkCredit Property (IPWorksIoT_AMQP Class)

The amount of credit currently available to this link's sender.

Object Oriented Interface


public function getLinkCredit($linkindex);


Procedural Interface


ipworksiot_amqp_get($res, 38 , $linkindex);


Default Value

0

Remarks

The amount of credit currently available to this link's sender.

This property holds the amount of credit currently available to this link's sender. The sender on a link can only send messages if it has non-zero credit.

The $linkindex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Long64

LinkDeliveryCount Property (IPWorksIoT_AMQP Class)

The current delivery count value for this link.

Object Oriented Interface


public function getLinkDeliveryCount($linkindex);


Procedural Interface


ipworksiot_amqp_get($res, 39 , $linkindex);


Default Value

0

Remarks

The current delivery count value for this link.

This property holds the current delivery count value for this link.

The $linkindex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Long64

LinkName Property (IPWorksIoT_AMQP Class)

This link's name.

Object Oriented Interface


public function getLinkName($linkindex);


Procedural Interface


ipworksiot_amqp_get($res, 40 , $linkindex);


Default Value

''

Remarks

This link's name.

This property holds this link's name.

The $linkindex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

String

LinkReadyToSend Property (IPWorksIoT_AMQP Class)

Whether this link is ready to send a message.

Object Oriented Interface


public function getLinkReadyToSend($linkindex);


Procedural Interface


ipworksiot_amqp_get($res, 41 , $linkindex);


Default Value

false

Remarks

Whether this link is ready to send a message.

This property reflects whether this link is currently ready to send a message or not; it always returns False if LinkRole is lrReceiver (1).

The $linkindex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Boolean

LinkReceiveMode Property (IPWorksIoT_AMQP Class)

The receive mode this link is operating in.

Object Oriented Interface


public function getLinkReceiveMode($linkindex);


Procedural Interface


ipworksiot_amqp_get($res, 42 , $linkindex);


Default Value

0

Remarks

The receive mode this link is operating in.

This property reflects the receive mode which this link is operating in, if it is a receiver link. (For sender links, this property's value means nothing.) Values can be:

  • lrmAutomatic - Messages will be received automatically
  • lrmFetch - One message will be received after each call to the FetchMessage method.

Refer to ReceiveMode for more information.

The $linkindex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Integer

LinkRole Property (IPWorksIoT_AMQP Class)

The class's role on this link.

Object Oriented Interface


public function getLinkRole($linkindex);


Procedural Interface


ipworksiot_amqp_get($res, 43 , $linkindex);


Default Value

0

Remarks

The class's role on this link.

This property reflects which role the class is in for this link. Valid values are:

  • lrSender (0)
  • lrReceiver (1)

The $linkindex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Integer

LocalHost Property (IPWorksIoT_AMQP Class)

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_amqp_get($res, 44 );


ipworksiot_amqp_set($res, 44, $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 multi-homed 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 property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

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

Data Type

String

LocalPort Property (IPWorksIoT_AMQP 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_amqp_get($res, 45 );


ipworksiot_amqp_set($res, 45, $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 in the client side.

Data Type

Integer

MessageAbsoluteExpiryTime Property (IPWorksIoT_AMQP Class)

The absolute time at which this message should be considered expired.

Object Oriented Interface


public function getMessageAbsoluteExpiryTime();


public function setMessageAbsoluteExpiryTime($value);

Procedural Interface


ipworksiot_amqp_get($res, 46 );


ipworksiot_amqp_set($res, 46, $value );

Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

This property is not available at design time.

Data Type

Long64

MessageContentEncoding Property (IPWorksIoT_AMQP Class)

The content encoding of this message's data.

Object Oriented Interface


public function getMessageContentEncoding();


public function setMessageContentEncoding($value);

Procedural Interface


ipworksiot_amqp_get($res, 47 );


ipworksiot_amqp_set($res, 47, $value );

Default Value

''

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if MessageValueType is not set to mvtBinary (16).

This property is not available at design time.

Data Type

String

MessageContentType Property (IPWorksIoT_AMQP Class)

The content type of this message's data.

Object Oriented Interface


public function getMessageContentType();


public function setMessageContentType($value);

Procedural Interface


ipworksiot_amqp_get($res, 48 );


ipworksiot_amqp_set($res, 48, $value );

Default Value

''

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if MessageValueType is not set to mvtBinary (16).

This property is not available at design time.

Data Type

String

MessageCorrelationId Property (IPWorksIoT_AMQP Class)

The correlation Id of this message.

Object Oriented Interface


public function getMessageCorrelationId();


public function setMessageCorrelationId($value);

Procedural Interface


ipworksiot_amqp_get($res, 49 );


ipworksiot_amqp_set($res, 49, $value );

Default Value

''

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

This property is not available at design time.

Data Type

String

MessageCreationTime Property (IPWorksIoT_AMQP Class)

The creation time of this message.

Object Oriented Interface


public function getMessageCreationTime();


public function setMessageCreationTime($value);

Procedural Interface


ipworksiot_amqp_get($res, 50 );


ipworksiot_amqp_set($res, 50, $value );

Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

This property is not available at design time.

Data Type

Long64

MessageDeliveryCount Property (IPWorksIoT_AMQP Class)

How many previous attempts there have been to deliver this message.

Object Oriented Interface


public function getMessageDeliveryCount();


public function setMessageDeliveryCount($value);

Procedural Interface


ipworksiot_amqp_get($res, 51 );


ipworksiot_amqp_set($res, 51, $value );

Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

This property is not available at design time.

Data Type

Long64

MessageDurable Property (IPWorksIoT_AMQP Class)

Whether this message is durable.

Object Oriented Interface


public function getMessageDurable();


public function setMessageDurable($value);

Procedural Interface


ipworksiot_amqp_get($res, 52 );


ipworksiot_amqp_set($res, 52, $value );

Default Value

false

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

This property is not available at design time.

Data Type

Boolean

MessageFirstAcquirer Property (IPWorksIoT_AMQP Class)

Whether this message may have been acquired by other links previously.

Object Oriented Interface


public function getMessageFirstAcquirer();


public function setMessageFirstAcquirer($value);

Procedural Interface


ipworksiot_amqp_get($res, 53 );


ipworksiot_amqp_set($res, 53, $value );

Default Value

false

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

This property is not available at design time.

Data Type

Boolean

MessageGroupId Property (IPWorksIoT_AMQP Class)

The Id of the group this message belongs to.

Object Oriented Interface


public function getMessageGroupId();


public function setMessageGroupId($value);

Procedural Interface


ipworksiot_amqp_get($res, 54 );


ipworksiot_amqp_set($res, 54, $value );

Default Value

''

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

This property is not available at design time.

Data Type

String

MessageGroupSequence Property (IPWorksIoT_AMQP Class)

The position of this message within its group.

Object Oriented Interface


public function getMessageGroupSequence();


public function setMessageGroupSequence($value);

Procedural Interface


ipworksiot_amqp_get($res, 55 );


ipworksiot_amqp_set($res, 55, $value );

Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

This property is not available at design time.

Data Type

Long64

MessageLinkName Property (IPWorksIoT_AMQP Class)

The name of the link this message is associated with.

Object Oriented Interface


public function getMessageLinkName();


Procedural Interface


ipworksiot_amqp_get($res, 56 );


Default Value

''

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

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

Data Type

String

MessageId Property (IPWorksIoT_AMQP Class)

The unique Id of this message.

Object Oriented Interface


public function getMessageId();


public function setMessageId($value);

Procedural Interface


ipworksiot_amqp_get($res, 57 );


ipworksiot_amqp_set($res, 57, $value );

Default Value

''

Remarks

The unique Id of this message.

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

This property is not available at design time.

Data Type

String

MessagePriority Property (IPWorksIoT_AMQP Class)

The priority of this message.

Object Oriented Interface


public function getMessagePriority();


public function setMessagePriority($value);

Procedural Interface


ipworksiot_amqp_get($res, 58 );


ipworksiot_amqp_set($res, 58, $value );

Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

This property is not available at design time.

Data Type

Integer

MessageReplyTo Property (IPWorksIoT_AMQP Class)

The address of the node to send replies to for this message.

Object Oriented Interface


public function getMessageReplyTo();


public function setMessageReplyTo($value);

Procedural Interface


ipworksiot_amqp_get($res, 59 );


ipworksiot_amqp_set($res, 59, $value );

Default Value

''

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

This property is not available at design time.

Data Type

String

MessageReplyToGroupId Property (IPWorksIoT_AMQP Class)

The Id of the group to send replies to for this message.

Object Oriented Interface


public function getMessageReplyToGroupId();


public function setMessageReplyToGroupId($value);

Procedural Interface


ipworksiot_amqp_get($res, 60 );


ipworksiot_amqp_set($res, 60, $value );

Default Value

''

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

This property is not available at design time.

Data Type

String

MessageSettled Property (IPWorksIoT_AMQP Class)

Whether this message is settled.

Object Oriented Interface


public function getMessageSettled();


public function setMessageSettled($value);

Procedural Interface


ipworksiot_amqp_get($res, 61 );


ipworksiot_amqp_set($res, 61, $value );

Default Value

true

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

This property is not available at design time.

Data Type

Boolean

MessageSubject Property (IPWorksIoT_AMQP Class)

The subject of this message.

Object Oriented Interface


public function getMessageSubject();


public function setMessageSubject($value);

Procedural Interface


ipworksiot_amqp_get($res, 62 );


ipworksiot_amqp_set($res, 62, $value );

Default Value

''

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject set.

This property is not available at design time.

Data Type

String

MessageTo Property (IPWorksIoT_AMQP Class)

The address of the node which this message is intended for.

Object Oriented Interface


public function getMessageTo();


public function setMessageTo($value);

Procedural Interface


ipworksiot_amqp_get($res, 63 );


ipworksiot_amqp_set($res, 63, $value );

Default Value

''

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

This property is not available at design time.

Data Type

String

MessageTTL Property (IPWorksIoT_AMQP Class)

The time-to-live value for this message.

Object Oriented Interface


public function getMessageTTL();


public function setMessageTTL($value);

Procedural Interface


ipworksiot_amqp_get($res, 64 );


ipworksiot_amqp_set($res, 64, $value );

Default Value

-1

Remarks

The time-to-live value for this message.

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

This property is not available at design time.

Data Type

Long64

MessageUserId Property (IPWorksIoT_AMQP Class)

The identity of the user responsible for producing this message.

Object Oriented Interface


public function getMessageUserId();


public function setMessageUserId($value);

Procedural Interface


ipworksiot_amqp_get($res, 65 );


ipworksiot_amqp_set($res, 65, $value );

Default Value

''

Remarks

The identity of the user responsible for producing this message.

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

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

This property is not available at design time.

Data Type

String

MessageValue Property (IPWorksIoT_AMQP Class)

This message's value.

Object Oriented Interface


public function getMessageValue();


public function setMessageValue($value);

Procedural Interface


ipworksiot_amqp_get($res, 66 );


ipworksiot_amqp_set($res, 66, $value );

Default Value

''

Remarks

This message's value.

This property specifies the value to send in this message. The MessageValueType property should be used to specify the data type of the value.

This property is not available at design time.

Data Type

String

MessageValueType Property (IPWorksIoT_AMQP Class)

This message's value data type.

Object Oriented Interface


public function getMessageValueType();


public function setMessageValueType($value);

Procedural Interface


ipworksiot_amqp_get($res, 67 );


ipworksiot_amqp_set($res, 67, $value );

Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's MessageValue.

The table below shows the possible value types, their descriptions, and how to format the data assigned to MessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

Type Description Value Format
mvtNull (0 - default) Null N/A (MessageValue is ignored)
mvtBoolean (1) Boolean "True" or "False"
mvtUbyte (2) Unsigned byte 0 to 255
mvtUshort (3) Unsigned short 0 to 65535
mvtUint (4) Unsigned integer 0 to 4294967295
mvtUlong (5) Unsigned long 0 to 18446744073709551615
mvtByte (6) Byte -128 to 127
mvtShort (7) Short -32768 to 32767
mvtInt (8) Integer -2147483648 to 2147483647
mvtLong (9) Long -9223372036854775808 to 9223372036854775807
mvtFloat (10) Float IEEE 754 32-bit floating point number
mvtDouble (11) Double IEEE 754 64-bit floating point number
mvtDecimal (12) Decimal Hex-encoded byte string
mvtChar (13) Char Single character
mvtTimestamp (14) Timestamp Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC).
mvtUuid (15) UUID Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive)
mvtBinary (16) Binary data Hex-encoded byte string
mvtString (17) String String
mvtSymbol (18) Symbolic value ASCII string
mvtJson (19) Composite data Composite data JSON structured according to the schema shown in the SendMessage method's documentation

This property is not available at design time.

Data Type

Integer

OutgoingMessageCount Property (IPWorksIoT_AMQP Class)

The number of records in the OutgoingMessage arrays.

Object Oriented Interface


public function getOutgoingMessageCount();


Procedural Interface


ipworksiot_amqp_get($res, 68 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at OutgoingMessageCount - 1.

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

Data Type

Integer

OutgoingMessageAbsoluteExpiryTime Property (IPWorksIoT_AMQP Class)

The absolute time at which this message should be considered expired.

Object Oriented Interface


public function getOutgoingMessageAbsoluteExpiryTime($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 69 , $outgoingmessageindex);


Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

Long64

OutgoingMessageContentEncoding Property (IPWorksIoT_AMQP Class)

The content encoding of this message's data.

Object Oriented Interface


public function getOutgoingMessageContentEncoding($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 70 , $outgoingmessageindex);


Default Value

''

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if OutgoingMessageValueType is not set to mvtBinary (16).

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessageContentType Property (IPWorksIoT_AMQP Class)

The content type of this message's data.

Object Oriented Interface


public function getOutgoingMessageContentType($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 71 , $outgoingmessageindex);


Default Value

''

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if OutgoingMessageValueType is not set to mvtBinary (16).

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessageCorrelationId Property (IPWorksIoT_AMQP Class)

The correlation Id of this message.

Object Oriented Interface


public function getOutgoingMessageCorrelationId($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 72 , $outgoingmessageindex);


Default Value

''

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessageCreationTime Property (IPWorksIoT_AMQP Class)

The creation time of this message.

Object Oriented Interface


public function getOutgoingMessageCreationTime($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 73 , $outgoingmessageindex);


Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

Long64

OutgoingMessageDeliveryCount Property (IPWorksIoT_AMQP Class)

How many previous attempts there have been to deliver this message.

Object Oriented Interface


public function getOutgoingMessageDeliveryCount($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 74 , $outgoingmessageindex);


Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

Long64

OutgoingMessageDurable Property (IPWorksIoT_AMQP Class)

Whether this message is durable.

Object Oriented Interface


public function getOutgoingMessageDurable($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 75 , $outgoingmessageindex);


Default Value

false

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

Boolean

OutgoingMessageFirstAcquirer Property (IPWorksIoT_AMQP Class)

Whether this message may have been acquired by other links previously.

Object Oriented Interface


public function getOutgoingMessageFirstAcquirer($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 76 , $outgoingmessageindex);


Default Value

false

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

Boolean

OutgoingMessageGroupId Property (IPWorksIoT_AMQP Class)

The Id of the group this message belongs to.

Object Oriented Interface


public function getOutgoingMessageGroupId($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 77 , $outgoingmessageindex);


Default Value

''

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessageGroupSequence Property (IPWorksIoT_AMQP Class)

The position of this message within its group.

Object Oriented Interface


public function getOutgoingMessageGroupSequence($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 78 , $outgoingmessageindex);


Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

Long64

OutgoingMessageLinkName Property (IPWorksIoT_AMQP Class)

The name of the link this message is associated with.

Object Oriented Interface


public function getOutgoingMessageLinkName($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 79 , $outgoingmessageindex);


Default Value

''

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessageId Property (IPWorksIoT_AMQP Class)

The unique Id of this message.

Object Oriented Interface


public function getOutgoingMessageId($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 80 , $outgoingmessageindex);


Default Value

''

Remarks

The unique Id of this message.

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

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessagePriority Property (IPWorksIoT_AMQP Class)

The priority of this message.

Object Oriented Interface


public function getOutgoingMessagePriority($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 81 , $outgoingmessageindex);


Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

Integer

OutgoingMessageReplyTo Property (IPWorksIoT_AMQP Class)

The address of the node to send replies to for this message.

Object Oriented Interface


public function getOutgoingMessageReplyTo($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 82 , $outgoingmessageindex);


Default Value

''

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessageReplyToGroupId Property (IPWorksIoT_AMQP Class)

The Id of the group to send replies to for this message.

Object Oriented Interface


public function getOutgoingMessageReplyToGroupId($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 83 , $outgoingmessageindex);


Default Value

''

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessageSettled Property (IPWorksIoT_AMQP Class)

Whether this message is settled.

Object Oriented Interface


public function getOutgoingMessageSettled($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 84 , $outgoingmessageindex);


Default Value

true

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

Boolean

OutgoingMessageSubject Property (IPWorksIoT_AMQP Class)

The subject of this message.

Object Oriented Interface


public function getOutgoingMessageSubject($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 85 , $outgoingmessageindex);


Default Value

''

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject set.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessageTo Property (IPWorksIoT_AMQP Class)

The address of the node which this message is intended for.

Object Oriented Interface


public function getOutgoingMessageTo($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 86 , $outgoingmessageindex);


Default Value

''

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessageTTL Property (IPWorksIoT_AMQP Class)

The time-to-live value for this message.

Object Oriented Interface


public function getOutgoingMessageTTL($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 87 , $outgoingmessageindex);


Default Value

-1

Remarks

The time-to-live value for this message.

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

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

Long64

OutgoingMessageUserId Property (IPWorksIoT_AMQP Class)

The identity of the user responsible for producing this message.

Object Oriented Interface


public function getOutgoingMessageUserId($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 88 , $outgoingmessageindex);


Default Value

''

Remarks

The identity of the user responsible for producing this message.

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

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

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessageValue Property (IPWorksIoT_AMQP Class)

This message's value.

Object Oriented Interface


public function getOutgoingMessageValue($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 89 , $outgoingmessageindex);


Default Value

''

Remarks

This message's value.

This property specifies the value to send in this message. The OutgoingMessageValueType property should be used to specify the data type of the value.

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

String

OutgoingMessageValueType Property (IPWorksIoT_AMQP Class)

This message's value data type.

Object Oriented Interface


public function getOutgoingMessageValueType($outgoingmessageindex);


Procedural Interface


ipworksiot_amqp_get($res, 90 , $outgoingmessageindex);


Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's OutgoingMessageValue.

The table below shows the possible value types, their descriptions, and how to format the data assigned to OutgoingMessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

Type Description Value Format
mvtNull (0 - default) Null N/A (OutgoingMessageValue is ignored)
mvtBoolean (1) Boolean "True" or "False"
mvtUbyte (2) Unsigned byte 0 to 255
mvtUshort (3) Unsigned short 0 to 65535
mvtUint (4) Unsigned integer 0 to 4294967295
mvtUlong (5) Unsigned long 0 to 18446744073709551615
mvtByte (6) Byte -128 to 127
mvtShort (7) Short -32768 to 32767
mvtInt (8) Integer -2147483648 to 2147483647
mvtLong (9) Long -9223372036854775808 to 9223372036854775807
mvtFloat (10) Float IEEE 754 32-bit floating point number
mvtDouble (11) Double IEEE 754 64-bit floating point number
mvtDecimal (12) Decimal Hex-encoded byte string
mvtChar (13) Char Single character
mvtTimestamp (14) Timestamp Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC).
mvtUuid (15) UUID Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive)
mvtBinary (16) Binary data Hex-encoded byte string
mvtString (17) String String
mvtSymbol (18) Symbolic value ASCII string
mvtJson (19) Composite data Composite data JSON structured according to the schema shown in the SendMessage method's documentation

The $outgoingmessageindex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

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

Data Type

Integer

Password Property (IPWorksIoT_AMQP Class)

A password to use for SASL authentication.

Object Oriented Interface


public function getPassword();


public function setPassword($value);

Procedural Interface


ipworksiot_amqp_get($res, 91 );


ipworksiot_amqp_set($res, 91, $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

ReadyToSend Property (IPWorksIoT_AMQP Class)

Indicates whether the class is ready to send data.

Object Oriented Interface


public function getReadyToSend();


Procedural Interface


ipworksiot_amqp_get($res, 92 );


Default Value

false

Remarks

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

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

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

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

Data Type

Boolean

ReceivedMessageAbsoluteExpiryTime Property (IPWorksIoT_AMQP Class)

The absolute time at which this message should be considered expired.

Object Oriented Interface


public function getReceivedMessageAbsoluteExpiryTime();


Procedural Interface


ipworksiot_amqp_get($res, 93 );


Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

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

Data Type

Long64

ReceivedMessageContentEncoding Property (IPWorksIoT_AMQP Class)

The content encoding of this message's data.

Object Oriented Interface


public function getReceivedMessageContentEncoding();


Procedural Interface


ipworksiot_amqp_get($res, 94 );


Default Value

''

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if ReceivedMessageValueType is not set to mvtBinary (16).

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

Data Type

String

ReceivedMessageContentType Property (IPWorksIoT_AMQP Class)

The content type of this message's data.

Object Oriented Interface


public function getReceivedMessageContentType();


Procedural Interface


ipworksiot_amqp_get($res, 95 );


Default Value

''

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if ReceivedMessageValueType is not set to mvtBinary (16).

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

Data Type

String

ReceivedMessageCorrelationId Property (IPWorksIoT_AMQP Class)

The correlation Id of this message.

Object Oriented Interface


public function getReceivedMessageCorrelationId();


Procedural Interface


ipworksiot_amqp_get($res, 96 );


Default Value

''

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

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

Data Type

String

ReceivedMessageCreationTime Property (IPWorksIoT_AMQP Class)

The creation time of this message.

Object Oriented Interface


public function getReceivedMessageCreationTime();


Procedural Interface


ipworksiot_amqp_get($res, 97 );


Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

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

Data Type

Long64

ReceivedMessageDeliveryCount Property (IPWorksIoT_AMQP Class)

How many previous attempts there have been to deliver this message.

Object Oriented Interface


public function getReceivedMessageDeliveryCount();


Procedural Interface


ipworksiot_amqp_get($res, 98 );


Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

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

Data Type

Long64

ReceivedMessageDurable Property (IPWorksIoT_AMQP Class)

Whether this message is durable.

Object Oriented Interface


public function getReceivedMessageDurable();


Procedural Interface


ipworksiot_amqp_get($res, 99 );


Default Value

false

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

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

Data Type

Boolean

ReceivedMessageFirstAcquirer Property (IPWorksIoT_AMQP Class)

Whether this message may have been acquired by other links previously.

Object Oriented Interface


public function getReceivedMessageFirstAcquirer();


Procedural Interface


ipworksiot_amqp_get($res, 100 );


Default Value

false

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

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

Data Type

Boolean

ReceivedMessageGroupId Property (IPWorksIoT_AMQP Class)

The Id of the group this message belongs to.

Object Oriented Interface


public function getReceivedMessageGroupId();


Procedural Interface


ipworksiot_amqp_get($res, 101 );


Default Value

''

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

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

Data Type

String

ReceivedMessageGroupSequence Property (IPWorksIoT_AMQP Class)

The position of this message within its group.

Object Oriented Interface


public function getReceivedMessageGroupSequence();


Procedural Interface


ipworksiot_amqp_get($res, 102 );


Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

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

Data Type

Long64

ReceivedMessageLinkName Property (IPWorksIoT_AMQP Class)

The name of the link this message is associated with.

Object Oriented Interface


public function getReceivedMessageLinkName();


Procedural Interface


ipworksiot_amqp_get($res, 103 );


Default Value

''

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

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

Data Type

String

ReceivedMessageId Property (IPWorksIoT_AMQP Class)

The unique Id of this message.

Object Oriented Interface


public function getReceivedMessageId();


Procedural Interface


ipworksiot_amqp_get($res, 104 );


Default Value

''

Remarks

The unique Id of this message.

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

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

Data Type

String

ReceivedMessagePriority Property (IPWorksIoT_AMQP Class)

The priority of this message.

Object Oriented Interface


public function getReceivedMessagePriority();


Procedural Interface


ipworksiot_amqp_get($res, 105 );


Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

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

Data Type

Integer

ReceivedMessageReplyTo Property (IPWorksIoT_AMQP Class)

The address of the node to send replies to for this message.

Object Oriented Interface


public function getReceivedMessageReplyTo();


Procedural Interface


ipworksiot_amqp_get($res, 106 );


Default Value

''

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

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

Data Type

String

ReceivedMessageReplyToGroupId Property (IPWorksIoT_AMQP Class)

The Id of the group to send replies to for this message.

Object Oriented Interface


public function getReceivedMessageReplyToGroupId();


Procedural Interface


ipworksiot_amqp_get($res, 107 );


Default Value

''

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

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

Data Type

String

ReceivedMessageSettled Property (IPWorksIoT_AMQP Class)

Whether this message is settled.

Object Oriented Interface


public function getReceivedMessageSettled();


Procedural Interface


ipworksiot_amqp_get($res, 108 );


Default Value

true

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

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

Data Type

Boolean

ReceivedMessageSubject Property (IPWorksIoT_AMQP Class)

The subject of this message.

Object Oriented Interface


public function getReceivedMessageSubject();


Procedural Interface


ipworksiot_amqp_get($res, 109 );


Default Value

''

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject set.

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

Data Type

String

ReceivedMessageTo Property (IPWorksIoT_AMQP Class)

The address of the node which this message is intended for.

Object Oriented Interface


public function getReceivedMessageTo();


Procedural Interface


ipworksiot_amqp_get($res, 110 );


Default Value

''

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

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

Data Type

String

ReceivedMessageTTL Property (IPWorksIoT_AMQP Class)

The time-to-live value for this message.

Object Oriented Interface


public function getReceivedMessageTTL();


Procedural Interface


ipworksiot_amqp_get($res, 111 );


Default Value

-1

Remarks

The time-to-live value for this message.

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

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

Data Type

Long64

ReceivedMessageUserId Property (IPWorksIoT_AMQP Class)

The identity of the user responsible for producing this message.

Object Oriented Interface


public function getReceivedMessageUserId();


Procedural Interface


ipworksiot_amqp_get($res, 112 );


Default Value

''

Remarks

The identity of the user responsible for producing this message.

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

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

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

Data Type

String

ReceivedMessageValue Property (IPWorksIoT_AMQP Class)

This message's value.

Object Oriented Interface


public function getReceivedMessageValue();


Procedural Interface


ipworksiot_amqp_get($res, 113 );


Default Value

''

Remarks

This message's value.

This property specifies the value to send in this message. The ReceivedMessageValueType property should be used to specify the data type of the value.

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

Data Type

String

ReceivedMessageValueType Property (IPWorksIoT_AMQP Class)

This message's value data type.

Object Oriented Interface


public function getReceivedMessageValueType();


Procedural Interface


ipworksiot_amqp_get($res, 114 );


Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's ReceivedMessageValue.

The table below shows the possible value types, their descriptions, and how to format the data assigned to ReceivedMessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

Type Description Value Format
mvtNull (0 - default) Null N/A (ReceivedMessageValue is ignored)
mvtBoolean (1) Boolean "True" or "False"
mvtUbyte (2) Unsigned byte 0 to 255
mvtUshort (3) Unsigned short 0 to 65535
mvtUint (4) Unsigned integer 0 to 4294967295
mvtUlong (5) Unsigned long 0 to 18446744073709551615
mvtByte (6) Byte -128 to 127
mvtShort (7) Short -32768 to 32767
mvtInt (8) Integer -2147483648 to 2147483647
mvtLong (9) Long -9223372036854775808 to 9223372036854775807
mvtFloat (10) Float IEEE 754 32-bit floating point number
mvtDouble (11) Double IEEE 754 64-bit floating point number
mvtDecimal (12) Decimal Hex-encoded byte string
mvtChar (13) Char Single character
mvtTimestamp (14) Timestamp Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC).
mvtUuid (15) UUID Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive)
mvtBinary (16) Binary data Hex-encoded byte string
mvtString (17) String String
mvtSymbol (18) Symbolic value ASCII string
mvtJson (19) Composite data Composite data JSON structured according to the schema shown in the SendMessage method's documentation

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

Data Type

Integer

ReceiveMode Property (IPWorksIoT_AMQP Class)

Controls what mode new receiver links are created with.

Object Oriented Interface


public function getReceiveMode();


public function setReceiveMode($value);

Procedural Interface


ipworksiot_amqp_get($res, 115 );


ipworksiot_amqp_set($res, 115, $value );

Default Value

0

Remarks

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

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

Receiving Messages Automatically

A receiver link operating in rmAutomatic (0) mode strives to ensure that the sender always has sufficient credit so that messages are received as soon as they are available, thus simulating a "subscription-based"/"push-based" messaging model.

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

Fetching Messages On-Demand

A receiver link operating in rmFetch (1) mode requires the FetchMessage method to be called in order for a message to be received, thus simulating a "polling"/"pull-based" messaging model.

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

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

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

This property is not available at design time.

Data Type

Integer

RemoteHost Property (IPWorksIoT_AMQP 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_amqp_get($res, 116 );


ipworksiot_amqp_set($res, 116, $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_AMQP 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_amqp_get($res, 117 );


ipworksiot_amqp_set($res, 117, $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

SessionCount Property (IPWorksIoT_AMQP Class)

The number of records in the Session arrays.

Object Oriented Interface


public function getSessionCount();


Procedural Interface


ipworksiot_amqp_get($res, 118 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SessionCount - 1.

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

Data Type

Integer

SessionIncomingWindow Property (IPWorksIoT_AMQP Class)

The incoming window size of this session.

Object Oriented Interface


public function getSessionIncomingWindow($sessionindex);


Procedural Interface


ipworksiot_amqp_get($res, 119 , $sessionindex);


Default Value

0

Remarks

The incoming window size of this session.

This property holds the incoming window size (in frames) of this session.

The $sessionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.

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

Data Type

Long64

SessionName Property (IPWorksIoT_AMQP Class)

The name of this session.

Object Oriented Interface


public function getSessionName($sessionindex);


Procedural Interface


ipworksiot_amqp_get($res, 120 , $sessionindex);


Default Value

''

Remarks

The name of this session.

This property holds the name of this session.

The $sessionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.

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

Data Type

String

SessionOutgoingWindow Property (IPWorksIoT_AMQP Class)

The outgoing window size of this session.

Object Oriented Interface


public function getSessionOutgoingWindow($sessionindex);


Procedural Interface


ipworksiot_amqp_get($res, 121 , $sessionindex);


Default Value

0

Remarks

The outgoing window size of this session.

This property holds the outgoing window size (in frames) of this session.

The $sessionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.

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

Data Type

Long64

SSLAcceptServerCertEncoded Property (IPWorksIoT_AMQP Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface


ipworksiot_amqp_get($res, 123 );


ipworksiot_amqp_set($res, 123, $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

SSLCertEncoded Property (IPWorksIoT_AMQP Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface


ipworksiot_amqp_get($res, 151 );


ipworksiot_amqp_set($res, 151, $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

SSLCertStore Property (IPWorksIoT_AMQP 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_amqp_get($res, 167 );


ipworksiot_amqp_set($res, 167, $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 are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorksIoT_AMQP 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_amqp_get($res, 168 );


ipworksiot_amqp_set($res, 168, $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_AMQP Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface


ipworksiot_amqp_get($res, 169 );


ipworksiot_amqp_set($res, 169, $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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 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 cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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 certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (IPWorksIoT_AMQP 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_amqp_get($res, 170 );


ipworksiot_amqp_set($res, 170, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLEnabled Property (IPWorksIoT_AMQP Class)

Whether TLS/SSL is enabled.

Object Oriented Interface


public function getSSLEnabled();


public function setSSLEnabled($value);

Procedural Interface


ipworksiot_amqp_get($res, 178 );


ipworksiot_amqp_set($res, 178, $value );

Default Value

false

Remarks

This setting 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_AMQP Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface


public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface


ipworksiot_amqp_get($res, 179 );


ipworksiot_amqp_set($res, 179, $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:

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

Additional Notes

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

When Automatic is selected, 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

SSLServerCertEncoded Property (IPWorksIoT_AMQP Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLServerCertEncoded();


Procedural Interface


ipworksiot_amqp_get($res, 181 );


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_AMQP Class)

A timeout for the class.

Object Oriented Interface


public function getTimeout();


public function setTimeout($value);

Procedural Interface


ipworksiot_amqp_get($res, 208 );


ipworksiot_amqp_set($res, 208, $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.

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (IPWorksIoT_AMQP Class)

A username to use for SASL authentication.

Object Oriented Interface


public function getUser();


public function setUser($value);

Procedural Interface


ipworksiot_amqp_get($res, 209 );


ipworksiot_amqp_set($res, 209, $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

CloseLink Method (IPWorksIoT_AMQP Class)

Closes a link.

Object Oriented Interface

public function doCloseLink($name);

Procedural Interface

ipworksiot_amqp_do_closelink($res, $name);

Remarks

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

CloseSession Method (IPWorksIoT_AMQP Class)

Closes a session.

Object Oriented Interface

public function doCloseSession($name);

Procedural Interface

ipworksiot_amqp_do_closesession($res, $name);

Remarks

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

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

Config Method (IPWorksIoT_AMQP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksiot_amqp_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_AMQP Class)

This method connects to a remote host.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksiot_amqp_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_AMQP Class)

This method connects to a remote host.

Object Oriented Interface

public function doConnectTo($host, $port);

Procedural Interface

ipworksiot_amqp_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)

CreateReceiverLink Method (IPWorksIoT_AMQP Class)

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

Object Oriented Interface

public function doCreateReceiverLink($sessionname, $name, $source);

Procedural Interface

ipworksiot_amqp_do_createreceiverlink($res, $sessionname, $name, $source);

Remarks

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

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

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

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

AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions. amqp.ReceiveMode = AmqpReceiveModes.rmFetch; amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");

CreateSenderLink Method (IPWorksIoT_AMQP Class)

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

Object Oriented Interface

public function doCreateSenderLink($sessionname, $name, $target);

Procedural Interface

ipworksiot_amqp_do_createsenderlink($res, $sessionname, $name, $target);

Remarks

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

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

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

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

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

CreateSession Method (IPWorksIoT_AMQP Class)

Creates a new session with the given name.

Object Oriented Interface

public function doCreateSession($name);

Procedural Interface

ipworksiot_amqp_do_createsession($res, $name);

Remarks

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

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

Disconnect Method (IPWorksIoT_AMQP Class)

This method disconnects from the remote host.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksiot_amqp_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_AMQP Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

FetchMessage Method (IPWorksIoT_AMQP Class)

Fetches a single message over the specified receiver link.

Object Oriented Interface

public function doFetchMessage($linkname);

Procedural Interface

ipworksiot_amqp_do_fetchmessage($res, $linkname);

Remarks

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

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

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

Refer to ReceiveMode and FetchTimeout for more information.

Interrupt Method (IPWorksIoT_AMQP Class)

This method interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksiot_amqp_do_interrupt($res);

Remarks

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

Reset Method (IPWorksIoT_AMQP Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksiot_amqp_do_reset($res);

Remarks

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

ResetMessage Method (IPWorksIoT_AMQP Class)

Resets the Message properties.

Object Oriented Interface

public function doResetMessage();

Procedural Interface

ipworksiot_amqp_do_resetmessage($res);

Remarks

This method resets the Message* properties.

SendMessage Method (IPWorksIoT_AMQP Class)

Sends a message on the specified link.

Object Oriented Interface

public function doSendMessage($linkname);

Procedural Interface

ipworksiot_amqp_do_sendmessage($res, $linkname);

Remarks

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

The Message* properties are used to construct the message to send. At minimum, specify a MessageValue and a MessageValueType; all other properties are optional. The ResetMessage method can be used to reset the Message* properties. amqp.Message.ValueType = AMQPValueTypes.mvtString; amqp.Message.Value = "Hello World!"; amqp.SendMessage("SenderLinkName");

Message Settlement

AMQP provides the ability to negotiate delivery guarantees through the system of "message settlement". When a link is created, both the sender and the receiver negotiate a settle mode (one for each role) to use. Senders will operate in one of these modes:
  • Settled - All messages will be sent in a settled state.
  • Unsettled - All messages will be sent in an unsettled state.
  • Mixed - Messages may be sent either settled or unsettled.
and receivers will operate in one of these modes:
  • First - Incoming messages will be settled immediately (and the sender will be notified that the message has been received, if the message was not already settled when sent).
  • Second - Incoming messages will be settled after the sender has settled them (and the sender will be notified when a message has been received, if the message was not already settled when sent).

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

Sender's Settle Mode Receiver's Settle Mode Effective Delivery Guarantee
Settled (Any) At most once
Unsettled First At least once
Unsettled Second Exactly once

(Note that, if the sender's settle mode is Mixed, the values in the "Sender's Settle Mode" column apply for each individual message.)

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

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

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

Sending Composite Data

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

Composite Data JSON Schema

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

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

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

Typename Description Value Format
null Null null
boolean Boolean true or false
ubyte Unsigned byte 0 to 255
ushort Unsigned short 0 to 65535
uint Unsigned integer 0 to 4294967295
ulong Unsigned long 0 to 18446744073709551615
byte Byte -128 to 127
short Short -32768 to 32767
int Integer -2147483648 to 2147483647
long Long -9223372036854775808 to 9223372036854775807
float Float [IEEE 754 32-bit floating point number]
double Double [IEEE 754 64-bit floating point number]
decimal Decimal Hex-encoded byte string like "0A1B2C3D"
char Char "c"
timestamp Timestamp [Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC)]
uuid UUID Hex-encoded UUID string like "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" (hyphens optional, case-insensitive)
binary Binary data Hex-encoded byte string like "0A1B2C3D"
string String "UTF-8 string (correctly escaped for JSON)"
symbol Symbolic value "ASCII string"
array AMQP array JSON array with zero or more type-value objects of the same type
list AMQP list JSON array with zero or more type-value objects
map AMQP map JSON array with even number of type-value objects representing keys and values; no duplicate keys allowed

Note that typenames must be lowercase in order to be parsed correctly.

Arrays, Lists, and Maps

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

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

  • The elements in an array must all be of the same type (e.g., their typenames must match).
  • The elements in a map represent keys (odd-numbered elements) and values (even-numbered elements). There must be an even number of elements (or none), and the values of the "key" elements must be unique.
{
  "type": "map",
  "value": [
    { "type": "symbol", "value": "key1" },
    { "type": "string", "value": "value1" },
    { "type": "symbol", "value": "key2" },
    { "type": "int", "value": 100 }
  ]
}

Described Types

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

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

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

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

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

Abbreviated Value Syntax

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

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

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

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

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

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

Composite Data JSON Example

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

Connected Event (IPWorksIoT_AMQP Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksiot_amqp_register_callback($res, 1, 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_AMQP Class)

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

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksiot_amqp_register_callback($res, 2, 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.

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

Disconnected Event (IPWorksIoT_AMQP Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksiot_amqp_register_callback($res, 3, 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_AMQP Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksiot_amqp_register_callback($res, 4, 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.

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

LinkReadyToSend Event (IPWorksIoT_AMQP Class)

Fires when a sender link is ready to send messages.

Object Oriented Interface

public function fireLinkReadyToSend($param);

Procedural Interface

ipworksiot_amqp_register_callback($res, 5, array($this, 'fireLinkReadyToSend'));

Parameter List

 'linkname'
'linkindex'

Remarks

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

LinkName is the name of the sender link.

LinkIndex is the index of the sender link in the Link* properties.

Log Event (IPWorksIoT_AMQP Class)

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksiot_amqp_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.
  • Session: Session status messages.
  • Frame: Frame status messages.

MessageIn Event (IPWorksIoT_AMQP Class)

Fires when the class receives a message.

Object Oriented Interface

public function fireMessageIn($param);

Procedural Interface

ipworksiot_amqp_register_callback($res, 7, array($this, 'fireMessageIn'));

Parameter List

 'sessionname'
'sessionindex'
'linkname'
'linkindex'
'messageid'
'state'

Remarks

This event fires whenever the class receives a message. The message itself is automatically stored in the ReceivedMessage* properties.

Specifying a Delivery Outcome

The State parameter can be set to one of the following values to specify what delivery outcome the class should report to the sender (the default is Accepted (0)):
  • 0: Accepted - The message has been processed successfully.
  • 1: Rejected - The message failed to process successfully. Includes an error describing why.
  • 2: Released - The message has not been (and will not be) processed.
  • 3: Modified - Same as "Released", but with additional metadata for the sender.

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

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

Other Parameters

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

SessionIndex is the index of the session in the Session* properties.

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

LinkIndex is the index of the link in the Link* properties.

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

MessageOut Event (IPWorksIoT_AMQP Class)

Fires when the class sends a message.

Object Oriented Interface

public function fireMessageOut($param);

Procedural Interface

ipworksiot_amqp_register_callback($res, 8, array($this, 'fireMessageOut'));

Parameter List

 'sessionname'
'sessionindex'
'linkname'
'linkindex'
'messageid'

Remarks

This event fires whenever the class sends a message.

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

SessionIndex is the index of the session in the Session* properties.

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

LinkIndex is the index of the link in the Link* properties.

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

MessageOutcome Event (IPWorksIoT_AMQP Class)

Fires when a message's outcome is available.

Object Oriented Interface

public function fireMessageOutcome($param);

Procedural Interface

ipworksiot_amqp_register_callback($res, 9, array($this, 'fireMessageOutcome'));

Parameter List

 'sessionname'
'sessionindex'
'linkname'
'linkindex'
'messageid'
'direction'
'state'

Remarks

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

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

SessionIndex is the index of the session in the Session* properties.

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

LinkIndex is the index of the link in the Link* properties.

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

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

State indicates the actual message outcome. Possible values are:

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

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

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

SSLServerAuthentication Event (IPWorksIoT_AMQP Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksiot_amqp_register_callback($res, 10, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
'certsubject'
'certissuer'
'status'
'accept'

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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_AMQP Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksiot_amqp_register_callback($res, 11, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (AMQP 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.

AMQP Config Settings

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

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

DefaultCredit:   The amount of credit to create new receiver links with.

This setting controls the amount of credit that new receiver links are created with.

The default is 1024.

DefaultCreditThreshold:   The credit threshold to create new receiver links with.

The setting controls the credit threshold that new receiver links are created with. When a link's credit reaches the credit threshold, the class will automatically set it back to the amount of credit the link initially had.

The default is 256.

DefaultIncomingWindow:   The incoming window size to create new sessions with.

This setting controls the incoming window size (in frames) that new sessions are created with.

The default is 2014.

DefaultOutgoingWindow:   The outgoing window size to create new sessions with.

This setting controls the outgoing window size (in frames) that new sessions are created with.

The default is 2014.

DefaultSenderSettleMode:   The sender settle mode to create new links with.

This setting controls the sender settle mode that new links (both sender and receiver) are created with. Possible values are:

  • 0 (Unsettled): The sender will send messages to the receiver in an unsettled state.
  • 1 (Settled): The sender will send messages to the receiver in a settled state.
  • 2 (Mixed - default): The sender may send messages to the receiver in either a settled or an unsettled state.
GenerateMessageId:   Whether a unique message Id should be automatically generated when sending a message.

This setting controls whether the class will automatically generate a MessageId value (overwriting any existing value in the process) when SendMessage is called.

The default is False.

LogLevel:   The level of detail that is logged.

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

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

MaxFrameSize:   The maximum frame size.

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

The default is 4294967295 (0xFFFFFFFF), which is the maximum value allowed.

MaxLinkCountPerSession:   The maximum number of links to restrict new sessions to.

This setting controls the maximum number of links which newly created sessions will be restricted to.

The default is 4294967295 (0xFFFFFFFF), which is the maximum value allowed.

MaxMessageSize:   The maximum message size to restrict new links to.

This setting controls the maximum message size (in bytes) which newly created links will be restricted to.

The default value is 1073741824 (0x40000000).

MaxSessionCount:   The maximum number of sessions.

This setting controls the maximum number of sessions which can be opened.

The default is 65535 (0xFFFF).

ModifiedDeliveryFailed:   Whether the sender should treat this transfer as an unsuccessful delivery attempt.

This setting specifies whether the sender should increment the "delivery count" value of the message that the associated "Modified" delivery outcome applies to (thus treating the transfer as an unsuccessful delivery attempt).

This setting is only valid while inside one of the MessageIn or MessageOutcome event handlers, and can only be set while inside the MessageIn event handler.

ModifiedMessageAnnotations:   The message annotations that the sender should merge into those already on the message.

This setting specifies a set of message annotations that the sender should merge into the existing ones for the message that the associated "Modified" delivery outcome applies to.

If not empty, this setting's value must be specified as valid composite data JSON containing a single AMQP map. The JSON must be structured according to the composite data JSON schema detailed in the SendMessage method's documentation. For example:

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

This setting is only valid while inside one of the MessageIn or MessageOutcome event handlers, and can only be set while inside the MessageIn event handler.

ModifiedUndeliverableHere:   Whether the receiver has indicated that the sender should not attempt to redeliver the message.

This setting specifies whether the receiver has indicated that the sender should not attempt to redeliver the message that the associated "Modified" delivery outcome applies to. (Note that the sender is free to try and deliver the message to another receiver if it so chooses.)

This setting is only valid while inside one of the MessageIn or MessageOutcome event handlers, and can only be set while inside the MessageIn event handler.

ProtocolVersion:   The AMQP protocol version to conform to.

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

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

RejectErrorCondition:   The error condition included with a 'Rejected' delivery outcome.

This setting specifies the error condition included with a "Rejected" delivery outcome. Possible values are:

amqp:internal-error An internal error occurred.
amqp:not-found A peer attempted to work with a remote entity that does not exists.
amqp:unauthorized-access A peer attempted to work with a remote entity it does not have access to.
amqp:decode-error Data could not be decoded.
amqp:resource-limited-exceeded A peer exceeded its resource allocation.
amqp:not-allowed A peer tried to use a frame in a manner inconsistent with the AMQP specification.
amqp:invalid-field An invalid field was supplied in a frame body.
amqp:not-implemented A peer tried to use functionality that its partner does not implement.
amqp:resource-locked A peer tried to access a resource which is currently in use.
amqp:precondition-failed A peer made a request that was denied because a precondition failed.
amqp:resource-deleted A peer tried to work with a deleted resource.
amqp:illegal-state A peer sent a frame that is not permitted given the current state.
amqp:frame-size-too-small A peer attempted to send a frame larger than the negotiated maximum frame size.

This setting is only valid while inside one of the MessageIn or MessageOutcome event handlers, and can only be set while inside the MessageIn event handler.

RejectErrorDescription:   The error description included with a 'Rejected' delivery outcome.

This setting specifies a description of the error included with a "Rejected" delivery outcome. It may be empty.

This setting is only valid while inside one of the MessageIn or MessageOutcome event handlers, and can only be set while inside the MessageIn event handler.

SenderSettleMode[LinkName]:   Retrieves the negotiated sender settle mode for the specified link.

This setting can be queried to obtain the negotiated sender settle mode for an existing link specified by "LinkName".

SimplifiedJSONFormat:   Whether to output simplified JSON where possible.

This setting controls whether the class should output JSON using the abbreviated value syntax where possible. Refer to the composite data JSON schema detail in the documentation of the SendMessage method for more information.

The default is true.

TCPClient Config Settings

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

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

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

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

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

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

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

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

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

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

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

FirewallPort:   The TCP port for the FirewallHost;.

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

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

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

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

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

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

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

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

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

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

Note: This value is not applicable in macOS.

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

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

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

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

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

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

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

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

LingerTime:   Time in seconds to have the connection linger.

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

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

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

In multi-homed 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 multi-homed hosts (machines with more than one IP interface).

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

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

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

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

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

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

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

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

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

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

MaxTransferRate:   The transfer rate limit in bytes per second.

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

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

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

www.google.com;www.nsoftware.com

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

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

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

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

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

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

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

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

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

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

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

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

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.

ReuseSSLSession:   Determines if the SSL session is reused.

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

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

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

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:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

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

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

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 will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

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

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

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

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

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

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

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

The enabled cipher suites to be used in SSL negotiation.

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

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

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

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

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation.

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

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

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

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

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

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

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

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

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

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

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

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

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

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

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

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

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

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

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

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

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

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

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

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

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

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

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

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

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

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

When specified the class will verify that the server certificate signature algorithm is among the values specified in this 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: TCPClient.SSLProvider = TCPClientSSLProviders.sslpInternal; TCPClient.Config("SSLEnabledProtocols=3072"); //TLS 1.2 TCPClient.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

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

TLS12SupportedGroups:   The supported groups for ECC.

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

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

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

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

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

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

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

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

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

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

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

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

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

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

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

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

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

Socket Config Settings

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

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

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

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

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

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

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

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

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

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

Base Config Settings

BuildInfo:   Information about the product's build.

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

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

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

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to true tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (AMQP Class)

AMQP Errors

600   AMQP protocol error. Refer to the error message for more information.
601   Malformed frame.
602   SASL authentication failed.
603   Cannot open another session or link.
604   Invalid data format.
605   Cannot modify message data.
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 non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't 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] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory 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 not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2022 PHP Edition - Version 22.0 [Build 8369]