AzureRelayReceiver Class

Properties   Methods   Events   Config Settings   Errors  

An Azure Relay Service listener to accept and communicate with clients.

Class Name

IPWorksMQ_AzureRelayReceiver

Procedural Interface

 ipworksmq_azurerelayreceiver_open();
 ipworksmq_azurerelayreceiver_close($res);
 ipworksmq_azurerelayreceiver_register_callback($res, $id, $function);
 ipworksmq_azurerelayreceiver_get_last_error($res);
 ipworksmq_azurerelayreceiver_get_last_error_code($res);
 ipworksmq_azurerelayreceiver_set($res, $id, $index, $value);
 ipworksmq_azurerelayreceiver_get($res, $id, $index);
 ipworksmq_azurerelayreceiver_do_config($res, $configurationstring);
 ipworksmq_azurerelayreceiver_do_disconnect($res, $connectionid);
 ipworksmq_azurerelayreceiver_do_doevents($res);
 ipworksmq_azurerelayreceiver_do_interrupt($res, $connectionid);
 ipworksmq_azurerelayreceiver_do_pausedata($res, $connectionid);
 ipworksmq_azurerelayreceiver_do_processdata($res, $connectionid);
 ipworksmq_azurerelayreceiver_do_send($res, $connectionid, $data);
 ipworksmq_azurerelayreceiver_do_sendbytes($res, $connectionid, $data);
 ipworksmq_azurerelayreceiver_do_sendfile($res, $connectionid, $filename);
 ipworksmq_azurerelayreceiver_do_sendhttpresponse($res, $connectionid, $statuscode, $statusdescription, $responsedata);
 ipworksmq_azurerelayreceiver_do_sendtext($res, $connectionid, $text);
 ipworksmq_azurerelayreceiver_do_shutdown($res);
 ipworksmq_azurerelayreceiver_do_startlistening($res);
 ipworksmq_azurerelayreceiver_do_stoplistening($res);

Remarks

The AzureRelayReceiver class implements the listener role in the Azure Relay service. The class will connect to the server and listen for incoming connections. Once a connection is established data can be exchange freely in both directions allowing a flexible messaging environment.

Authenticating and Listening

Authentication to Azure Relay is performed using the Shared Access Key Name and Shared Access Key created from the Azure portal for the Relay. To begin listening for incoming connections set Listening to True.

When set to True the class will immediately attempt to make a connection to the Azure Relay Service and begin listening. The following properties are applicable when setting Listening:

• AccessKey (required)
• AccessKeyName (required)
• HybridConnection (required)
• NamespaceAddress (required)
• DefaultTimeout
• ForwardingHost
• ForwardingPort

To stop listening set Listening to False. To shutdown the server including existing connections call Shutdown.

Handling Connections

When a connection is made the ConnectionRequest event fires with information about the connecting client. From within this event the client connection may be accepted (default) or rejected.

If the client connection is accepted the ConnectionConnected and ConnectionReadyToSend events fire when the connection completes and is ready to send and receive data.

When data is received from the client the ConnectionDataIn event fires with the received data.

To send data to the client set AzureRelayConnectionDataToSend or call Send, SendFile, or SendText.

When the client disconnects the ConnectionDisconnected event fires. To initiate the client disconnection call Disconnect.

Handling HTTP Connections

Azure Relay also supports HTTP connections which follow a request/response model. When an HTTP request is received the HTTPRequest event fires with information about the request including the request body. Save the ConnectionId value obtained within HTTPRequest for use with SendHTTPResponse.

To send a HTTP response call SendHTTPResponse with the ConnectionId, status code and description, and any response day to be sent back to the client.

Forwarding Connections

The class supports forwarding incoming connection to a separate destination. This functionality allows AzureRelayReceiver to act as a proxy for incoming requests. When ForwardingHost and ForwardingPort are set anytime a connection is made the class will establish a separate connection to the ForwardingHost and forward all incoming traffic. Responses from the ForwardingHost are then automatically sent back over the connection.

When connection forwarding is used no special steps are needed to send or receive data. Data flows freely between the connected client and the ForwardingHost.

Note: Forwarding is not supported for HTTP requests.

Code Example (WebSockets)

Azurerelayreceiver listener = new Azurerelayreceiver(); listener.AccessKey = "9oKRDwjl0s440MlLUi4qHxDL34j1FS6K3t5TRoJ216c="; listener.AccessKeyName = "RootManageSharedAccessKey"; listener.NamespaceAddress = "myrelay.servicebus.windows.net"; listener.HybridConnection = "hc1"; listener.OnConnectionRequest += (s, e) => { Console.WriteLine("Connection Request From: " + e.RemoteAddress + ":" + e.RemotePort); e.Accept = true; }; listener.OnConnectionReadyToSend += (s, e) => { Console.WriteLine("Connection [" + e.ConnectionId + "] connected and ready to send and receive."); }; listener.OnConnectionDataIn += (s, e) => { Console.WriteLine("Received data from " + e.ConnectionId + ": " + e.Text); //echo the data back listener.SendText(e.ConnectionId, e.Text); Console.WriteLine("Echoed received data back"); }; listener.Listening = true; while (true) listener.DoEvents();

Code Example (HTTP)

Azurerelaylistener listener = new Azurerelaylistener(); listener.AccessKey = "9oKRDwjl0s440MlLUi4qHxDL34j1FS6K3t5TRoJ216c="; listener.AccessKeyName = "RootManageSharedAccessKey"; listener.NamespaceAddress = "myrelay.servicebus.windows.net"; listener.HybridConnection = "hc1"; listener.OnHTTPRequest += (s, e) => { Console.WriteLine("HTTP Request from " + e.RemoteAddress + ":" + e.RemotePort); Console.WriteLine("HTTP Method: " + e.RequestMethod); Console.WriteLine("HTTP Request: " + e.RequestData); myConnectionId = e.ConnectionId; }; //Send a response using the ConnectionId value from the HTTPRequest event listener.SendHTTPResponse(myConnectionId, 200, "OK", myResponseBody);

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.

AccessKey Property (IPWorksMQ_AzureRelayReceiver Class)

The Shared Access Key.

Object Oriented Interface

public function getAccessKey();
public function setAccessKey($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 1 );
ipworksmq_azurerelayreceiver_set($res, 1, $value );

Default Value

''

Remarks

This property specifies the Shared Access Key to use when authenticating. This is the primary or secondary key of the shared access policy created in the Azure portal. For instance 8oKRDwkl0s440MlLUi4qHxDL34j1FS6K3t5TRoJ216c=.

Data Type

String

AccessKeyName Property (IPWorksMQ_AzureRelayReceiver Class)

The Shared Access Key Name.

Object Oriented Interface

public function getAccessKeyName();
public function setAccessKeyName($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 2 );
ipworksmq_azurerelayreceiver_set($res, 2, $value );

Default Value

''

Remarks

This property specifies the Shared Access Key name to use when authenticating. This is the name of the shared access policy created in the Azure portal. For instance RootManageSharedAccessKey.

Data Type

String

Connected Property (IPWorksMQ_AzureRelayReceiver Class)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 3 );

Default Value

false

Remarks

This property is used to determine whether or not 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

AzureRelayConnectionCount Property (IPWorksMQ_AzureRelayReceiver Class)

The number of records in the AzureRelayConnection arrays.

Object Oriented Interface

public function getAzureRelayConnectionCount();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 4 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AzureRelayConnectionAcceptData
• AzureRelayConnectionAddress
• AzureRelayConnectionBytesSent
• AzureRelayConnectionConnected
• AzureRelayConnectionConnectHeaders
• AzureRelayConnectionConnectionId
• AzureRelayConnectionDataFormat
• AzureRelayConnectionDataToSend
• AzureRelayConnectionExtensions
• AzureRelayConnectionHost
• AzureRelayConnectionId
• AzureRelayConnectionReadyToSend
• AzureRelayConnectionRemoteAddress
• AzureRelayConnectionRemotePort
• AzureRelayConnectionSubProtocols
• AzureRelayConnectionTimeout

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

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

Data Type

Integer

AzureRelayConnectionAcceptData Property (IPWorksMQ_AzureRelayReceiver Class)

Setting this property to False, temporarily disables data reception (and the ConnectionDataIn event) on the connection.

Object Oriented Interface

public function getAzureRelayConnectionAcceptData($connectionid);
public function setAzureRelayConnectionAcceptData($connectionid, $value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 5 , $connectionid);
ipworksmq_azurerelayreceiver_set($res, 5, $value , $connectionid);

Default Value

true

Remarks

Setting this property to False, temporarily disables data reception (and the ConnectionDataIn event) on the connection. Setting this to True, re-enables data reception.

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

This property is not available at design time.

Data Type

Boolean

AzureRelayConnectionAddress Property (IPWorksMQ_AzureRelayReceiver Class)

This property holds the rendezvous URL to which the connection specific websocket connection will be made.

Object Oriented Interface

public function getAzureRelayConnectionAddress($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 6 , $connectionid);

Default Value

''

Remarks

This property holds the rendezvous URL to which the connection specific websocket connection will be made. This is for information only, no action needs to be taken based on this value. For instance: wss://g21-prod-by3-003-sb.servicebus.windows.net/$hc/hc1?sb-hc-action=accept&sb-hc-id=2d4acb89-7d15-4aeb-bcd5-66e031580a90_G21_G1

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

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

Data Type

String

AzureRelayConnectionBytesSent Property (IPWorksMQ_AzureRelayReceiver Class)

This property shows how many bytes were sent after calling Send or SendBytes .

Object Oriented Interface

public function getAzureRelayConnectionBytesSent($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 7 , $connectionid);

Default Value

0

Remarks

This property shows how many bytes were sent after calling Send or SendBytes. Please see Send or SendBytes for more information.

Note: This property will always return 0 when the class is operating in the synchronous mode (i.e., the AzureRelayConnectionTimeout property is set to a positive value).

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

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

Data Type

Integer

AzureRelayConnectionConnected Property (IPWorksMQ_AzureRelayReceiver Class)

This property indicates the status of individual connections.

Object Oriented Interface

public function getAzureRelayConnectionConnected($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 8 , $connectionid);

Default Value

false

Remarks

This property indicates the status of individual connections.

When true, the connection is established. Use the Disconnect method to disconnect an existing connection.

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

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

Data Type

Boolean

AzureRelayConnectionConnectHeaders Property (IPWorksMQ_AzureRelayReceiver Class)

A JSON object containing the HTTP headers that have been supplied by the sender to the Azure Relay service.

Object Oriented Interface

public function getAzureRelayConnectionConnectHeaders($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 9 , $connectionid);

Default Value

''

Remarks

A JSON object containing the HTTP headers that have been supplied by the sender to the Azure Relay service. For instance:

"connectHeaders": {
	"Sec-WebSocket-Key": "QocLBwK5J40Qp35L2duoBg==",
	"Sec-WebSocket-Version": "13",
	"Origin": "null",
	"Connection": "Upgrade",
	"Upgrade": "websocket",
	"Accept-Encoding": "gzip, deflate",
	"Host": "nstest.servicebus.windows.net",
	"User-Agent": "IPWorks HTTP Component - www.nsoftware.com"
}

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

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

Data Type

String

AzureRelayConnectionConnectionId Property (IPWorksMQ_AzureRelayReceiver Class)

This property contains an identifier generated by the class to identify each connection.

Object Oriented Interface

public function getAzureRelayConnectionConnectionId($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 10 , $connectionid);

Default Value

0

Remarks

This property contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.

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

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

Data Type

Integer

AzureRelayConnectionDataFormat Property (IPWorksMQ_AzureRelayReceiver Class)

This property includes the format of the data being sent.

Object Oriented Interface

public function getAzureRelayConnectionDataFormat($connectionid);
public function setAzureRelayConnectionDataFormat($connectionid, $value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 11 , $connectionid);
ipworksmq_azurerelayreceiver_set($res, 11, $value , $connectionid);

Default Value

0

Remarks

This property includes the format of the data being sent. When data are sent over an established connection, it is either considered as text or binary data. Text data are UTF-8 encoded. Binary data have no encoding associated with it.

Possible values are as follows:

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

This property is not available at design time.

Data Type

Integer

AzureRelayConnectionDataToSend Property (IPWorksMQ_AzureRelayReceiver Class)

This property contains a string of data to be sent to the remote host.

Object Oriented Interface

public function setAzureRelayConnectionDataToSend($connectionid, $value);

Procedural Interface

ipworksmq_azurerelayreceiver_set($res, 12, $value , $connectionid);

Default Value

''

Remarks

This property contains a string of data to be sent to the remote host. Write-only property.

Assigning a string to the AzureRelayConnectionDataToSend makes the class send the string to the remote host. The Send method provides similar functionality.

If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

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

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

Data Type

Binary String

AzureRelayConnectionExtensions Property (IPWorksMQ_AzureRelayReceiver Class)

The WebSocket extensions sent by the client in the initial WebSocket connection request.

Object Oriented Interface

public function getAzureRelayConnectionExtensions($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 13 , $connectionid);

Default Value

''

Remarks

The WebSocket extensions sent by the client in the initial WebSocket connection request.

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

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

Data Type

String

AzureRelayConnectionHost Property (IPWorksMQ_AzureRelayReceiver Class)

This property includes the Host header value of the connected client.

Object Oriented Interface

public function getAzureRelayConnectionHost($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 14 , $connectionid);

Default Value

''

Remarks

This property includes the Host header value of the connected client.

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

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

Data Type

String

AzureRelayConnectionId Property (IPWorksMQ_AzureRelayReceiver Class)

This property holds the Id of the connection.

Object Oriented Interface

public function getAzureRelayConnectionId($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 15 , $connectionid);

Default Value

''

Remarks

This property holds the Id of the connection. If an Id was specified by the client it is present here, otherwise the Azure Relay service generates a value. For instance: 2d4acb89-7d15-4aeb-bcd5-66e031580a90_G21_G1.

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

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

Data Type

String

AzureRelayConnectionReadyToSend Property (IPWorksMQ_AzureRelayReceiver Class)

This property indicates whether the class is ready to send data.

Object Oriented Interface

public function getAzureRelayConnectionReadyToSend($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 16 , $connectionid);

Default Value

false

Remarks

This property indicates whether the class is ready to send data.

This is true after a client connects but will become false after a failed call to Send or SendBytes. After a failed call to Send or SendBytes, the ReadyToSend event will fire and this property will be true when data can be sent again.

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

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

Data Type

Boolean

AzureRelayConnectionRemoteAddress Property (IPWorksMQ_AzureRelayReceiver Class)

This property holds the IP address of the connecting client.

Object Oriented Interface

public function getAzureRelayConnectionRemoteAddress($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 17 , $connectionid);

Default Value

''

Remarks

This property holds the IP address of the connecting client.

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

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

Data Type

String

AzureRelayConnectionRemotePort Property (IPWorksMQ_AzureRelayReceiver Class)

This property holds the port of the connecting client.

Object Oriented Interface

public function getAzureRelayConnectionRemotePort($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 18 , $connectionid);

Default Value

0

Remarks

This property holds the port of the connecting client.

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

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

Data Type

Integer

AzureRelayConnectionSubProtocols Property (IPWorksMQ_AzureRelayReceiver Class)

This property includes the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

Object Oriented Interface

public function getAzureRelayConnectionSubProtocols($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 19 , $connectionid);

Default Value

''

Remarks

This property includes the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

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

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

Data Type

String

AzureRelayConnectionTimeout Property (IPWorksMQ_AzureRelayReceiver Class)

This property specifies a timeout for the class.

Object Oriented Interface

public function getAzureRelayConnectionTimeout($connectionid);
public function setAzureRelayConnectionTimeout($connectionid, $value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 20 , $connectionid);
ipworksmq_azurerelayreceiver_set($res, 20, $value , $connectionid);

Default Value

0

Remarks

This property specifies a timeout for the class.

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

If AzureRelayConnectionTimeout 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 AzureRelayConnectionTimeout 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 AzureRelayConnectionTimeout property is 0(asynchronous operation).

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

This property is not available at design time.

Data Type

Integer

DefaultTimeout Property (IPWorksMQ_AzureRelayReceiver Class)

An initial timeout value to be used by incoming connections.

Object Oriented Interface

public function getDefaultTimeout();
public function setDefaultTimeout($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 22 );
ipworksmq_azurerelayreceiver_set($res, 22, $value );

Default Value

0

Remarks

This property is used by the class to set the operational timeout value of all inbound connections once they are established.

By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

Data Type

Integer

FirewallAutoDetect Property (IPWorksMQ_AzureRelayReceiver Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 23 );
ipworksmq_azurerelayreceiver_set($res, 23, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (IPWorksMQ_AzureRelayReceiver Class)

The type of firewall to connect through.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 24 );
ipworksmq_azurerelayreceiver_set($res, 24, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (IPWorksMQ_AzureRelayReceiver Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 25 );
ipworksmq_azurerelayreceiver_set($res, 25, $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 (IPWorksMQ_AzureRelayReceiver 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

ipworksmq_azurerelayreceiver_get($res, 26 );
ipworksmq_azurerelayreceiver_set($res, 26, $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 (IPWorksMQ_AzureRelayReceiver Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 27 );
ipworksmq_azurerelayreceiver_set($res, 27, $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 (IPWorksMQ_AzureRelayReceiver 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

ipworksmq_azurerelayreceiver_get($res, 28 );
ipworksmq_azurerelayreceiver_set($res, 28, $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

ForwardingHost Property (IPWorksMQ_AzureRelayReceiver Class)

The address to which traffic will automatically be forwarded.

Object Oriented Interface

public function getForwardingHost();
public function setForwardingHost($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 29 );
ipworksmq_azurerelayreceiver_set($res, 29, $value );

Default Value

''

Remarks

ForwardingHost optionally specifies an address to which traffic will be automatically forwarded. Traffic will only be forwarded if both ForwardingHost and ForwardingPort are specified.

When a connection is made the class will automatically establish a connection to ForwardingHost on the port specified by ForwardingPort. Data will then flow freely between the connected client and the ForwardingHost.

Note: This functionality is not applicable to HTTP requests.

Data Type

String

ForwardingPort Property (IPWorksMQ_AzureRelayReceiver Class)

The port to which traffic will automatically be forwarded.

Object Oriented Interface

public function getForwardingPort();
public function setForwardingPort($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 30 );
ipworksmq_azurerelayreceiver_set($res, 30, $value );

Default Value

0

Remarks

ForwardingPort is used together with ForwardingHost to define a location where traffic is automatically forwarded.

ForwardingHost optionally specifies an address to which traffic will be automatically forwarded. Traffic will only be forwarded if both ForwardingHost and ForwardingPort are specified.

When a connection is made the class will automatically establish a connection to ForwardingHost on the port specified by ForwardingPort. Data will then flow freely between the connected client and the ForwardingHost.

Note: This functionality is not applicable to HTTP requests.

Data Type

Integer

HybridConnection Property (IPWorksMQ_AzureRelayReceiver Class)

The hybrid connection name.

Object Oriented Interface

public function getHybridConnection();
public function setHybridConnection($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 31 );
ipworksmq_azurerelayreceiver_set($res, 31, $value );

Default Value

''

Remarks

This setting specifies the name of the hybrid connection that was created in the Azure portal. For instance hc1.

Data Type

String

Listening Property (IPWorksMQ_AzureRelayReceiver Class)

If , the class is listening for incoming connections.

Object Oriented Interface

public function getListening();
public function setListening($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 32 );
ipworksmq_azurerelayreceiver_set($res, 32, $value );

Default Value

false

Remarks

This setting indicates whether the class accepts incoming connections. When true the class has connected to the Azure Service and started listening for incoming connections. The initiate the connection and begin listening call the StartListening method.

Use the StartListening and StopListening methods to control whether the class is listening.

This property is not available at design time.

Data Type

Boolean

LocalHost Property (IPWorksMQ_AzureRelayReceiver 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

ipworksmq_azurerelayreceiver_get($res, 33 );
ipworksmq_azurerelayreceiver_set($res, 33, $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

NamespaceAddress Property (IPWorksMQ_AzureRelayReceiver Class)

The namespace address of the relay.

Object Oriented Interface

public function getNamespaceAddress();
public function setNamespaceAddress($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 34 );
ipworksmq_azurerelayreceiver_set($res, 34, $value );

Default Value

''

Remarks

This property specifies the full fully qualified domain name of the relay namespace. For instance myrelay.servicebus.windows.net.

Data Type

String

ProxyAuthScheme Property (IPWorksMQ_AzureRelayReceiver Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 35 );
ipworksmq_azurerelayreceiver_set($res, 35, $value );

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (IPWorksMQ_AzureRelayReceiver Class)

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

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 36 );
ipworksmq_azurerelayreceiver_set($res, 36, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (IPWorksMQ_AzureRelayReceiver Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 37 );
ipworksmq_azurerelayreceiver_set($res, 37, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (IPWorksMQ_AzureRelayReceiver Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 38 );
ipworksmq_azurerelayreceiver_set($res, 38, $value );

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (IPWorksMQ_AzureRelayReceiver Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 39 );
ipworksmq_azurerelayreceiver_set($res, 39, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (IPWorksMQ_AzureRelayReceiver Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 40 );
ipworksmq_azurerelayreceiver_set($res, 40, $value );

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (IPWorksMQ_AzureRelayReceiver Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 41 );
ipworksmq_azurerelayreceiver_set($res, 41, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (IPWorksMQ_AzureRelayReceiver Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 42 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 43 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 44 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 45 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 46 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 47 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 48 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 49 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 50 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 51 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 52 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 53 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 54 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 55 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 56 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 57 );
ipworksmq_azurerelayreceiver_set($res, 57, $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 (IPWorksMQ_AzureRelayReceiver 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

ipworksmq_azurerelayreceiver_get($res, 58 );
ipworksmq_azurerelayreceiver_set($res, 58, $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 (IPWorksMQ_AzureRelayReceiver Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 59 );
ipworksmq_azurerelayreceiver_set($res, 59, $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 (IPWorksMQ_AzureRelayReceiver Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 60 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksMQ_AzureRelayReceiver Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 61 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 62 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 63 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 64 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 65 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 66 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 67 );
ipworksmq_azurerelayreceiver_set($res, 67, $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 (IPWorksMQ_AzureRelayReceiver Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 68 );
ipworksmq_azurerelayreceiver_set($res, 68, $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 (IPWorksMQ_AzureRelayReceiver Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 69 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 70 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 71 );

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

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 72 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 73 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 74 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 75 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 76 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 77 );

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

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 78 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 79 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 80 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 81 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 82 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 83 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 84 );
ipworksmq_azurerelayreceiver_set($res, 84, $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 (IPWorksMQ_AzureRelayReceiver 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

ipworksmq_azurerelayreceiver_get($res, 85 );
ipworksmq_azurerelayreceiver_set($res, 85, $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 (IPWorksMQ_AzureRelayReceiver Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 86 );
ipworksmq_azurerelayreceiver_set($res, 86, $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 (IPWorksMQ_AzureRelayReceiver Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 87 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksMQ_AzureRelayReceiver Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 88 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 89 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 90 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 91 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 92 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 93 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 94 );
ipworksmq_azurerelayreceiver_set($res, 94, $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 (IPWorksMQ_AzureRelayReceiver Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 95 );
ipworksmq_azurerelayreceiver_set($res, 95, $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

SSLProvider Property (IPWorksMQ_AzureRelayReceiver 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

ipworksmq_azurerelayreceiver_get($res, 96 );
ipworksmq_azurerelayreceiver_set($res, 96, $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:

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

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 97 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 98 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 99 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 100 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 101 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 102 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 103 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 104 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 105 );

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

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 106 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 107 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 108 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 109 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 110 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 111 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 112 );

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

ipworksmq_azurerelayreceiver_get($res, 113 );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 114 );

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

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 115 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksMQ_AzureRelayReceiver Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 116 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 117 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 118 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 119 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 120 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 121 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 122 );

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

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksmq_azurerelayreceiver_get($res, 123 );

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

Config Method (IPWorksMQ_AzureRelayReceiver Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Disconnect Method (IPWorksMQ_AzureRelayReceiver Class)

This method disconnects the specified client.

Object Oriented Interface

public function doDisconnect($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_do_disconnect($res, $connectionid);

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

DoEvents Method (IPWorksMQ_AzureRelayReceiver Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksmq_azurerelayreceiver_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 (IPWorksMQ_AzureRelayReceiver Class)

Interrupts a synchronous send to the remote host.

Object Oriented Interface

public function doInterrupt($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_do_interrupt($res, $connectionid);

Remarks

This property is called using the Connection ID if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the class. If you use SendFile to upload a file, the class will run synchronously on that Connection ID until it is completed.

PauseData Method (IPWorksMQ_AzureRelayReceiver Class)

This method pauses data reception.

Object Oriented Interface

public function doPauseData($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_do_pausedata($res, $connectionid);

Remarks

This method pauses data reception for the connection identified by ConnectionId when called. While data reception is paused, the DataIn event will not fire for the specified connection. Call ProcessData to reenable data reception.

ProcessData Method (IPWorksMQ_AzureRelayReceiver Class)

This method reenables data reception after a call to PauseData .

Object Oriented Interface

public function doProcessData($connectionid);

Procedural Interface

ipworksmq_azurerelayreceiver_do_processdata($res, $connectionid);

Remarks

This method reenables data reception for the connection identified by ConnectionId after a previous call to PauseData. When PauseData is called, the DataIn event will not fire for the specified connection. To reenable data reception and allow DataIn to fire, call this method.

Note: This method is used only after previously calling PauseData. It does not need to be called to process incoming data by default.

Send Method (IPWorksMQ_AzureRelayReceiver Class)

This method sends binary data to the client.

Object Oriented Interface

public function doSend($connectionid, $data);

Procedural Interface

ipworksmq_azurerelayreceiver_do_send($res, $connectionid, $data);

Remarks

This method sends the binary data specified by Data to the client specified by ConnectionId.

SendBytes Method (IPWorksMQ_AzureRelayReceiver Class)

This method sends binary data to the specified client.

Object Oriented Interface

public function doSendBytes($connectionid, $data);

Procedural Interface

ipworksmq_azurerelayreceiver_do_sendbytes($res, $connectionid, $data);

Remarks

This method sends binary data to the client identified by ConnectionId. To send text, use the SendText method instead.

When AzureRelayConnectionTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

SendFile Method (IPWorksMQ_AzureRelayReceiver Class)

This method sends the file to the remote host.

Object Oriented Interface

public function doSendFile($connectionid, $filename);

Procedural Interface

ipworksmq_azurerelayreceiver_do_sendfile($res, $connectionid, $filename);

Remarks

This method sends the file to the client specified by the ConnectionId.

SendHTTPResponse Method (IPWorksMQ_AzureRelayReceiver Class)

Send the HTTP response.

Object Oriented Interface

public function doSendHTTPResponse($connectionid, $statuscode, $statusdescription, $responsedata);

Procedural Interface

ipworksmq_azurerelayreceiver_do_sendhttpresponse($res, $connectionid, $statuscode, $statusdescription, $responsedata);

Remarks

This method sends an HTTP response to the HTTP request identified by ConnectionId.

The response status code and description, as well as the response body, are sent to the client using this method. The ConnectionId value should be obtained from the HTTPRequest event.

StatusCode is the three digit HTTP status code to return, for instance 200.

StatusDescription is the text corresponding to the StatusCode. For instance OK.

ResponseBody specifies the body to be sent back to the client (if any).

Code Example (HTTP)

Azurerelaylistener listener = new Azurerelaylistener(); listener.AccessKey = "9oKRDwjl0s440MlLUi4qHxDL34j1FS6K3t5TRoJ216c="; listener.AccessKeyName = "RootManageSharedAccessKey"; listener.NamespaceAddress = "myrelay.servicebus.windows.net"; listener.HybridConnection = "hc1"; listener.OnHTTPRequest += (s, e) => { Console.WriteLine("HTTP Request from " + e.RemoteAddress + ":" + e.RemotePort); Console.WriteLine("HTTP Method: " + e.RequestMethod); Console.WriteLine("HTTP Request: " + e.RequestData); myConnectionId = e.ConnectionId; }; //Send a response using the ConnectionId value from the HTTPRequest event listener.SendHTTPResponse(myConnectionId, 200, "OK", myResponseBody);

SendText Method (IPWorksMQ_AzureRelayReceiver Class)

This method sends text data to the client.

Object Oriented Interface

public function doSendText($connectionid, $text);

Procedural Interface

ipworksmq_azurerelayreceiver_do_sendtext($res, $connectionid, $text);

Remarks

This method sends text to the client identified by ConnectionId. To send binary data, use the SendBytes method instead.

When AzureRelayConnectionTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

This method sends text to the client identified by ConnectionId. Data sent with this method will always be treated as text data regardless of the value of AzureRelayConnectionDataFormat. The class will UTF-8 encode the supplied text.

Shutdown Method (IPWorksMQ_AzureRelayReceiver Class)

This method shuts down the server.

Object Oriented Interface

public function doShutdown();

Procedural Interface

ipworksmq_azurerelayreceiver_do_shutdown($res);

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

StartListening Method (IPWorksMQ_AzureRelayReceiver Class)

Starts listening for incoming connections.

Object Oriented Interface

public function doStartListening();

Procedural Interface

ipworksmq_azurerelayreceiver_do_startlistening($res);

Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening events will fire as new clients connect and data is transferred.

To stop listening for new connections call StopListening. To stop listening for new connections and disconnect all existing clients call Shutdown.

The following properties are applicable when calling this method:

• AccessKey (required)
• AccessKeyName (required)
• HybridConnection (required)
• NamespaceAddress (required)
• DefaultTimeout
• ForwardingHost
• ForwardingPort

StopListening Method (IPWorksMQ_AzureRelayReceiver Class)

This method stops listening for new connections.

Object Oriented Interface

public function doStopListening();

Procedural Interface

ipworksmq_azurerelayreceiver_do_stoplistening($res);

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

Connected Event (IPWorksMQ_AzureRelayReceiver Class)

This event is fired immediately after the WebSocket handshake completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

Remarks

The Connected event will fire after the entire WebSocket connection and handshake process finishes (or fails). This consists of three steps: (1) the initial TCP connection (along with SSL negotiation, if used), (2) the HTTP "Upgrade" request, and (3) the 101 HTTP response.

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 TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Note: Please refer to the Error Codes section for more information.

ConnectionConnected Event (IPWorksMQ_AzureRelayReceiver Class)

Fired when a client has connected.

Object Oriented Interface

public function fireConnectionConnected($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 2, array($this, 'fireConnectionConnected'));

Parameter List

 'connectionid'

Remarks

This event fires when a client has successfully established a WebSocket connection.

ConnectionId identifies the connection.

ConnectionDataIn Event (IPWorksMQ_AzureRelayReceiver Class)

Fired when data is received.

Object Oriented Interface

public function fireConnectionDataIn($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 3, array($this, 'fireConnectionDataIn'));

Parameter List

 'connectionid'
 'dataformat'
 'text'
 'eom'

Remarks

The DataIn event provides the data received from the client identified by the ConnectionId parameter.

The incoming data are provided through the Text parameter.

The DataFormat parameter identifies the encoding (if any) of the data. Possible value are as follows:

The EOM parameter stands for End of Message. By default, the class will fire the DataIn event as data are received. Larger messages will be fragmented and will cause the event to fire multiple times. When EOM is True within the event, this indicates the current fragment is also the final fragment of the message. The class may also be configured to buffer the message internally until the complete message is received. To enable this, set BufferMessage to True.

The EOL parameter stands for End of Line. When LineMode is False, EOL will always be False. When LineMode is True, EOL will be True if the DataIn event fired because an EOL was received and will be False if the DataIn event fired because MaxLineLength was reached.

ConnectionDisconnected Event (IPWorksMQ_AzureRelayReceiver Class)

Fired when a WebSocket connection is disconnected.

Object Oriented Interface

public function fireConnectionDisconnected($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 4, array($this, 'fireConnectionDisconnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

Remarks

When the connection is closed the StatusCode parameter may be used to determine if the disconnect occurred normally or if there was an error condition. If the connection is closed normally the StatusCode will be 1000. The Description parameter will contain a textual description returned by the server. Common StatusCode values are:

ConnectionError Event (IPWorksMQ_AzureRelayReceiver Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireConnectionError($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 5, array($this, 'fireConnectionError'));

Parameter List

 'connectionid'
 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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

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

ConnectionReadyToSend Event (IPWorksMQ_AzureRelayReceiver Class)

Fired when the class is ready to send data.

Object Oriented Interface

public function fireConnectionReadyToSend($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 6, array($this, 'fireConnectionReadyToSend'));

Parameter List

 'connectionid'

Remarks

The ReadyToSend event indicates that the underlying TCP/IP subsystem is ready to accept data after a failed Send. The event is also fired immediately after a connection is established.

ConnectionRequest Event (IPWorksMQ_AzureRelayReceiver Class)

Fires when a WebSocket connection is requested.

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 7, array($this, 'fireConnectionRequest'));

Parameter List

 'accept'
 'rendezvousaddress'
 'id'
 'connectheaders'
 'subprotocols'
 'extensions'
 'host'
 'remoteaddress'
 'remoteport'
 'statuscode'
 'statusdescription'

Remarks

This event fires when a client requests a connection. The parameters of this event may be used to determine whether to accept or reject the connection.

To accept a connection set Accept to True (default). To reject a connection set Accept to False and set StatusCode and StatusDescription.

Accept defines whether the connection request is accepted or rejected. The default value is True. Set this to False to reject the connection.

RendezvousAddress holds the rendezvous URL to which the connection specific websocket connection will be made. This is informational only.

Id holds the Id of the connection. If an Id was specified by the client it is present here, otherwise the Azure Relay Service generates a value. For instance: b3ac97ea-d0f0-4286-bf1d-d493a4a22c27_G23_G22.

ConnectHeaders contains a JSON object with the HTTP headers that have been supplied by the sender to the Azure Relay service. For instance:

"connectHeaders": {
	"Sec-WebSocket-Key": "wIdDlRBg\/J\/Hx12q6iFdUQ==",
	"Sec-WebSocket-Version": "13",
	"Origin": "null",
	"Connection": "Upgrade",
	"Upgrade": "websocket",
	"Accept-Encoding": "gzip, deflate",
	"Host": "nstest.servicebus.windows.net",
	"User-Agent": "IPWorks HTTP Component - www.nsoftware.com"
}

SubProtocols holds the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

Extensions holds the WebSocket extensions sent by the client in the initial WebSocket connection request.

Host is the Host header value of the connected client.

RemoteAddress is the IP address of the connecting client.

RemotePort is the port used by the connecting client.

StatusCode is a 3 digit HTTP status code used when Accept is set to False. Set this to any 3 digit HTTP status code when rejecting a connection. For instance: 404.

StatusDescription should be set to the text description corresponding to the StatusCode value when rejecting a connection. For instance: Not Found.

ConnectionStatus Event (IPWorksMQ_AzureRelayReceiver Class)

This event is fired to indicate changes in connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 8, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

The ConnectionStatus event is fired when the connection state changes, such as 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:

Disconnected Event (IPWorksMQ_AzureRelayReceiver Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 9, 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 (IPWorksMQ_AzureRelayReceiver Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 10, 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.

Header Event (IPWorksMQ_AzureRelayReceiver Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 11, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

HTTPRequest Event (IPWorksMQ_AzureRelayReceiver Class)

Fires when an HTTP request is received.

Object Oriented Interface

public function fireHTTPRequest($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 12, array($this, 'fireHTTPRequest'));

Parameter List

 'connectionid'
 'rendezvousaddress'
 'id'
 'requestheaders'
 'requesttarget'
 'requestmethod'
 'host'
 'remoteaddress'
 'remoteport'
 'requestdata'

Remarks

This event fires when an HTTP request is received. The parameters of this event describe the details of the HTTP request.

The ConnectionId value must be saved and used when calling SendHTTPResponse.

Parameter Descriptions

ConnectionId contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.

RendezvousAddress holds the rendezvous URL to which the connection specific websocket connection may be made. This is for information only, no action needs to be taken based on this value. For instance: wss://g2-prod-by3-003-sb.servicebus.windows.net/$hc/hc1?sb-hc-action=request&sb-hc-id=e1df5efe-0988-450c-9512-f9f1d91b39a0_G2

Id holds the Id of the connection. If an Id was specified by the client it is present here, otherwise the Azure Relay service generates a value. For instance: 2d4acb89-7d15-4aeb-bcd5-66e031580a90_G21_G1.

RequestHeaders contains a JSON object containing the HTTP headers supplied to the Azure Relay service by the sender. Note that authorization values used to authenticate to the Azure Relay service, as well as all headers defined in RFC 7230 with the exception of Via are also stripped. For instance headers such as Content-Length are stripped by the relay and are not present in this value. For instance:

"requestHeaders": {
	"Accept-Encoding": "gzip, deflate",
	"Host": "nstest.servicebus.windows.net",
	"User-Agent": "IPWorks HTTP Component - www.nsoftware.com",
	"Via": "1.1 nstest.servicebus.windows.net"
}

RequestTarget is the request target including query string params, as defined in RFC 7230 section 5.3. For instance /hc1.

RequestMethod contains HTTP method sent in the request. For instance POST or GET.

Hostholds the Host header value of the connected client.

RemoteHost contains the IP address of the remote host that initiated the HTTP request (the client).

RemotePort contains the port used by the remote host to establish the connection.

RequestData holds the body of the HTTP request (if any).

Log Event (IPWorksMQ_AzureRelayReceiver Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 13, array($this, 'fireLog'));

Parameter List

 'connectionid'
 '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 message. Possible values are as follows:

The value 1 (Info) logs basic information including the URL, HTTP version, and connection status details.

The value 2 (Verbose) logs additional information about the initial HTTP request.

The value 3 (Debug) logs additional debug information (if available).

Message is the log entry.

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

• "Info"
• "Error"
• "Verbose"
• "Debug"

Redirect Event (IPWorksMQ_AzureRelayReceiver Class)

Fired when a redirection is received from the server.

Object Oriented Interface

public function fireRedirect($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 14, array($this, 'fireRedirect'));

Parameter List

 'location'
 'accept'

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SSLServerAuthentication Event (IPWorksMQ_AzureRelayReceiver Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 15, 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 (IPWorksMQ_AzureRelayReceiver Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksmq_azurerelayreceiver_register_callback($res, 16, 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 (AzureRelayReceiver Class)

AzureRelayReceiver Config Settings

WebSocketServer Config Settings

TCPServer Config Settings

SSL Config Settings

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

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

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

Trappable Errors (AzureRelayReceiver Class)

WebSocketServer Errors

TCPServer Errors

SSL Errors

TCP/IP Errors