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_interrupt($res);
 ipworksiot_amqp_do_reset($res);
 ipworksiot_amqp_do_resetmessage($res);
 ipworksiot_amqp_do_retrievemessage($res, $linkname);
 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 property's 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 property's 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 property's 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 retrieve-based, where the class will only "retrieve" 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 retrieve-based receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmRetrieve; amqp1.CreateReceiverLink("TestSession", "TestRetrieveReceiverLink", "TestSource2");

Receiving Messages

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

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

Regardless of whether a messages is received automatically or retrieved, any incoming message will cause the class to fire the MessageIn event and update the ReceivedMessage property's 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 retrieve-based links, it's also necessary to call RetrieveMessage(). It is recommended that the // RetrieveTimeout property be set to a non-zero value (60 seconds is the default) so that the retrieve // request will eventually time out if the sender doesn't have any messages available to deliver. amqp1.RetrieveTimeout = 60; amqp1.RetrieveMessage("TestRetrieveReceiverLink");

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

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 indicates whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksiot_amqp_get($res, 2 );

Default Value

false

Remarks

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

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

Data Type

Boolean

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

FirewallAutoDetect Property (IPWorksIoT_AMQP Class)

Whether 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, 4 );
ipworksiot_amqp_set($res, 4, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (IPWorksIoT_AMQP Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworksiot_amqp_get($res, 5 );
ipworksiot_amqp_set($res, 5, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (IPWorksIoT_AMQP Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworksiot_amqp_get($res, 6 );
ipworksiot_amqp_set($res, 6, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (IPWorksIoT_AMQP Class)

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, 7 );
ipworksiot_amqp_set($res, 7, $value );

Default Value

''

Remarks

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)

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

Default Value

0

Remarks

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)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworksiot_amqp_get($res, 9 );
ipworksiot_amqp_set($res, 9, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

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, 10 );
ipworksiot_amqp_set($res, 10, $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, 11 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• IncomingMessageAbsoluteExpiryTime
• IncomingMessageContentEncoding
• IncomingMessageContentType
• IncomingMessageCorrelationId
• IncomingMessageCreationTime
• IncomingMessageDeliveryCount
• IncomingMessageDurable
• IncomingMessageFirstAcquirer
• IncomingMessageGroupId
• IncomingMessageGroupSequence
• IncomingMessageId
• IncomingMessageLinkName
• IncomingMessagePriority
• IncomingMessageReplyTo
• IncomingMessageReplyToGroupId
• IncomingMessageSettled
• IncomingMessageSubject
• IncomingMessageTo
• IncomingMessageTTL
• IncomingMessageUserId
• IncomingMessageValue
• IncomingMessageValueType

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, 12 , $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, 13 , $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, 14 , $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, 15 , $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, 16 , $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, 17 , $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, 18 , $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, 19 , $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, 20 , $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, 21 , $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, 22 , $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, 23 , $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, 24 , $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, 25 , $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, 26 , $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, 27 , $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, 28 , $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, 29 , $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, 30 , $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, 31 , $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, 32 , $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, 33 , $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).

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, 34 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• LinkAvailable
• LinkChannelName
• LinkCredit
• LinkDeliveryCount
• LinkName
• LinkReadyToSend
• LinkReceiveMode
• LinkRole

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, 35 , $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, 36 , $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, 37 , $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, 38 , $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, 39 , $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, 40 , $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, 41 , $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
• lrmRetrieve - One message will be received after each call to the RetrieveMessage 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, 42 , $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, 43 );
ipworksiot_amqp_set($res, 43, $value );

Default Value

''

Remarks

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

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

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

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

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

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

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, 45 );
ipworksiot_amqp_set($res, 45, $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, 46 );
ipworksiot_amqp_set($res, 46, $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, 47 );
ipworksiot_amqp_set($res, 47, $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, 48 );
ipworksiot_amqp_set($res, 48, $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, 49 );
ipworksiot_amqp_set($res, 49, $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, 50 );
ipworksiot_amqp_set($res, 50, $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, 51 );
ipworksiot_amqp_set($res, 51, $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, 52 );
ipworksiot_amqp_set($res, 52, $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, 53 );
ipworksiot_amqp_set($res, 53, $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, 54 );
ipworksiot_amqp_set($res, 54, $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, 55 );

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, 56 );
ipworksiot_amqp_set($res, 56, $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, 57 );
ipworksiot_amqp_set($res, 57, $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, 58 );
ipworksiot_amqp_set($res, 58, $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, 59 );
ipworksiot_amqp_set($res, 59, $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, 60 );
ipworksiot_amqp_set($res, 60, $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, 61 );
ipworksiot_amqp_set($res, 61, $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, 62 );
ipworksiot_amqp_set($res, 62, $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, 63 );
ipworksiot_amqp_set($res, 63, $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, 64 );
ipworksiot_amqp_set($res, 64, $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, 65 );
ipworksiot_amqp_set($res, 65, $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, 66 );
ipworksiot_amqp_set($res, 66, $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).

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, 67 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• OutgoingMessageAbsoluteExpiryTime
• OutgoingMessageContentEncoding
• OutgoingMessageContentType
• OutgoingMessageCorrelationId
• OutgoingMessageCreationTime
• OutgoingMessageDeliveryCount
• OutgoingMessageDurable
• OutgoingMessageFirstAcquirer
• OutgoingMessageGroupId
• OutgoingMessageGroupSequence
• OutgoingMessageId
• OutgoingMessageLinkName
• OutgoingMessagePriority
• OutgoingMessageReplyTo
• OutgoingMessageReplyToGroupId
• OutgoingMessageSettled
• OutgoingMessageSubject
• OutgoingMessageTo
• OutgoingMessageTTL
• OutgoingMessageUserId
• OutgoingMessageValue
• OutgoingMessageValueType

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, 68 , $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, 69 , $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, 70 , $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, 71 , $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, 72 , $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, 73 , $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, 74 , $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, 75 , $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, 76 , $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, 77 , $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, 78 , $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, 79 , $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, 80 , $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, 81 , $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, 82 , $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, 83 , $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, 84 , $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, 85 , $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, 86 , $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, 87 , $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, 88 , $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, 89 , $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).

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

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, 92 );

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, 93 );

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, 94 );

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, 95 );

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, 96 );

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, 97 );

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, 98 );

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, 99 );

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, 100 );

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, 101 );

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, 102 );

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, 103 );

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, 104 );

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, 105 );

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, 106 );

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, 107 );

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, 108 );

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, 109 );

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, 110 );

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, 111 );

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, 112 );

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, 113 );

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

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, 114 );
ipworksiot_amqp_set($res, 114, $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)
• rmRetrieve (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.

Retrieving Messages On-Demand

A receiver link operating in rmRetrieve (1) mode requires the RetrieveMessage 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 RetrieveMessage is called, the class will supply the sender with a single credit and then block until a message is received (if the RetrieveTimeout property is set to zero).

If RetrieveTimeout 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 RetrieveMessage and RetrieveTimeout for more information. amqp.ReceiveMode = AmqpReceiveModes.rmRetrieve; 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, 115 );
ipworksiot_amqp_set($res, 115, $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, 116 );
ipworksiot_amqp_set($res, 116, $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

RetrieveTimeout Property (IPWorksIoT_AMQP Class)

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

Object Oriented Interface

public function getRetrieveTimeout();
public function setRetrieveTimeout($value);

Procedural Interface

ipworksiot_amqp_get($res, 117 );
ipworksiot_amqp_set($res, 117, $value );

Default Value

60

Remarks

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

Refer to RetrieveMessage for more information.

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:

• SessionIncomingWindow
• SessionName
• SessionOutgoingWindow

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

SSLAcceptServerCertEffectiveDate Property (IPWorksIoT_AMQP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksiot_amqp_get($res, 122 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorksIoT_AMQP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksiot_amqp_get($res, 123 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorksIoT_AMQP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksiot_amqp_get($res, 124 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorksIoT_AMQP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksiot_amqp_get($res, 125 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorksIoT_AMQP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksiot_amqp_get($res, 126 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorksIoT_AMQP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksiot_amqp_get($res, 127 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorksIoT_AMQP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksiot_amqp_get($res, 128 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorksIoT_AMQP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksiot_amqp_get($res, 129 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksIoT_AMQP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksiot_amqp_get($res, 130 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorksIoT_AMQP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksiot_amqp_get($res, 131 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorksIoT_AMQP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksiot_amqp_get($res, 132 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksIoT_AMQP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksiot_amqp_get($res, 133 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorksIoT_AMQP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksiot_amqp_get($res, 134 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorksIoT_AMQP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksiot_amqp_get($res, 135 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorksIoT_AMQP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksiot_amqp_get($res, 136 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorksIoT_AMQP Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworksiot_amqp_get($res, 137 );
ipworksiot_amqp_set($res, 137, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorksIoT_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 getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworksiot_amqp_get($res, 138 );
ipworksiot_amqp_set($res, 138, $value );

Default Value

''

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (IPWorksIoT_AMQP Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworksiot_amqp_get($res, 139 );
ipworksiot_amqp_set($res, 139, $value );

Default Value

0

Remarks

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:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorksIoT_AMQP Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksiot_amqp_get($res, 140 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksIoT_AMQP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksiot_amqp_get($res, 141 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorksIoT_AMQP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksiot_amqp_get($res, 142 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorksIoT_AMQP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksiot_amqp_get($res, 143 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorksIoT_AMQP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksiot_amqp_get($res, 144 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorksIoT_AMQP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksiot_amqp_get($res, 145 );

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorksIoT_AMQP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksiot_amqp_get($res, 146 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorksIoT_AMQP Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworksiot_amqp_get($res, 147 );
ipworksiot_amqp_set($res, 147, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

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

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorksIoT_AMQP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksiot_amqp_get($res, 148 );
ipworksiot_amqp_set($res, 148, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (IPWorksIoT_AMQP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksiot_amqp_get($res, 149 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorksIoT_AMQP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksiot_amqp_get($res, 150 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorksIoT_AMQP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksiot_amqp_get($res, 151 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorksIoT_AMQP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksiot_amqp_get($res, 152 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorksIoT_AMQP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksiot_amqp_get($res, 153 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorksIoT_AMQP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksiot_amqp_get($res, 154 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorksIoT_AMQP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksiot_amqp_get($res, 155 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorksIoT_AMQP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksiot_amqp_get($res, 156 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorksIoT_AMQP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksiot_amqp_get($res, 157 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorksIoT_AMQP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksiot_amqp_get($res, 158 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorksIoT_AMQP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksiot_amqp_get($res, 159 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorksIoT_AMQP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksiot_amqp_get($res, 160 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorksIoT_AMQP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksiot_amqp_get($res, 161 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorksIoT_AMQP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksiot_amqp_get($res, 162 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorksIoT_AMQP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksiot_amqp_get($res, 163 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorksIoT_AMQP Class)

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, 164 );
ipworksiot_amqp_set($res, 164, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (IPWorksIoT_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, 165 );
ipworksiot_amqp_set($res, 165, $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)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworksiot_amqp_get($res, 166 );
ipworksiot_amqp_set($res, 166, $value );

Default Value

0

Remarks

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:

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorksIoT_AMQP Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksiot_amqp_get($res, 167 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksIoT_AMQP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksiot_amqp_get($res, 168 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorksIoT_AMQP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksiot_amqp_get($res, 169 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorksIoT_AMQP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksiot_amqp_get($res, 170 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorksIoT_AMQP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksiot_amqp_get($res, 171 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorksIoT_AMQP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksiot_amqp_get($res, 172 );

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorksIoT_AMQP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksiot_amqp_get($res, 173 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorksIoT_AMQP Class)

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, 174 );
ipworksiot_amqp_set($res, 174, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (IPWorksIoT_AMQP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworksiot_amqp_get($res, 175 );
ipworksiot_amqp_set($res, 175, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

SSLEnabled Property (IPWorksIoT_AMQP Class)

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

Object Oriented Interface

public function getSSLEnabled();
public function setSSLEnabled($value);

Procedural Interface

ipworksiot_amqp_get($res, 176 );
ipworksiot_amqp_set($res, 176, $value );

Default Value

false

Remarks

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

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

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

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (IPWorksIoT_AMQP Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworksiot_amqp_get($res, 177 );
ipworksiot_amqp_set($res, 177, $value );

Default Value

0

Remarks

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

Possible values are as follows:

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

SSLServerCertEffectiveDate Property (IPWorksIoT_AMQP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksiot_amqp_get($res, 178 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorksIoT_AMQP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksiot_amqp_get($res, 179 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorksIoT_AMQP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksiot_amqp_get($res, 180 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorksIoT_AMQP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksiot_amqp_get($res, 181 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorksIoT_AMQP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksiot_amqp_get($res, 182 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorksIoT_AMQP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksiot_amqp_get($res, 183 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorksIoT_AMQP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksiot_amqp_get($res, 184 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorksIoT_AMQP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksiot_amqp_get($res, 185 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorksIoT_AMQP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksiot_amqp_get($res, 186 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorksIoT_AMQP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksiot_amqp_get($res, 187 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorksIoT_AMQP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksiot_amqp_get($res, 188 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorksIoT_AMQP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksiot_amqp_get($res, 189 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorksIoT_AMQP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksiot_amqp_get($res, 190 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorksIoT_AMQP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksiot_amqp_get($res, 191 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorksIoT_AMQP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksiot_amqp_get($res, 192 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorksIoT_AMQP Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksiot_amqp_get($res, 193 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorksIoT_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 getSSLServerCertStorePassword();

Procedural Interface

ipworksiot_amqp_get($res, 194 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorksIoT_AMQP Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksiot_amqp_get($res, 195 );

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorksIoT_AMQP Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksiot_amqp_get($res, 196 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksIoT_AMQP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksiot_amqp_get($res, 197 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorksIoT_AMQP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksiot_amqp_get($res, 198 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorksIoT_AMQP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksiot_amqp_get($res, 199 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorksIoT_AMQP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksiot_amqp_get($res, 200 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorksIoT_AMQP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksiot_amqp_get($res, 201 );

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorksIoT_AMQP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksiot_amqp_get($res, 202 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorksIoT_AMQP Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksiot_amqp_get($res, 203 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

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

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

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

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

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorksIoT_AMQP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksiot_amqp_get($res, 204 );

Default Value

''

Remarks

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)

This property includes the timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksiot_amqp_get($res, 205 );
ipworksiot_amqp_set($res, 205, $value );

Default Value

60

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (IPWorksIoT_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, 206 );
ipworksiot_amqp_set($res, 206, $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 Links 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 Sessions 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 Links 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 Links 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 retrieve-based, where the class will only "retrieve" 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.rmRetrieve; 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 Links 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 Sessions 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)

This method 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.

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)

This method will 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 property.

RetrieveMessage Method (IPWorksIoT_AMQP Class)

Retrieves a single message over the specified receiver link.

Object Oriented Interface

public function doRetrieveMessage($linkname);

Procedural Interface

ipworksiot_amqp_do_retrievemessage($res, $linkname);

Remarks

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

If RetrieveTimeout 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 retrieve 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 RetrieveTimeout for more information.

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 property holds an AMQPMessage object whose properties are used to construct the message to send. At minimum, specify a and a . 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:

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

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)

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)

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

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

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

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)

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)

Fired when information is available 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.

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

LinkReadyToSend Event (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 Links 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:

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

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 Sessions collection property.

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

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

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

MessageOut Event (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 Sessions collection property.

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

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

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

MessageOutcome Event (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 Sessions collection property.

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

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

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

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

State indicates the actual message outcome. Possible values are:

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

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

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

SSLServerAuthentication Event (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

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

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

SSLStatus Event (IPWorksIoT_AMQP Class)

Fired when secure connection progress messages are available.

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. This event tracks 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

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (AMQP Class)

AMQP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors