AzureRelayProxy Class

Properties   Methods   Events   Config Settings   Errors  

Allows local connections to be proxied to the Azure Relay Service.

Class Name

IPWorksMQ_AzureRelayProxy

Procedural Interface

 ipworksmq_azurerelayproxy_open();
 ipworksmq_azurerelayproxy_close($res);
 ipworksmq_azurerelayproxy_register_callback($res, $id, $function);
 ipworksmq_azurerelayproxy_get_last_error($res);
 ipworksmq_azurerelayproxy_get_last_error_code($res);
 ipworksmq_azurerelayproxy_set($res, $id, $index, $value);
 ipworksmq_azurerelayproxy_get($res, $id, $index);
 ipworksmq_azurerelayproxy_do_config($res, $configurationstring);
 ipworksmq_azurerelayproxy_do_disconnect($res, $connectionid);
 ipworksmq_azurerelayproxy_do_doevents($res);
 ipworksmq_azurerelayproxy_do_reset($res);
 ipworksmq_azurerelayproxy_do_shutdown($res);
 ipworksmq_azurerelayproxy_do_startlistening($res);
 ipworksmq_azurerelayproxy_do_stoplistening($res);

Remarks

The AzureRelayProxy class is designed to listen locally and forward received data over a connection to the Azure Relay Service.

This allows any TCP-based client to connect and send data to Azure Relay Service without any additional knowledge. When listening and a client connects a corresponding connection is made to the specified NamespaceAddress and data then flows freely between the connected client and the Azure Relay Service. Each new connection made to AzureRelayProxy results in a new connection made to the Azure Relay Service. Connections are not shared between clients.

The diagram below illustrates the design of this class.

                          +---------+                       +----------+
Client A <---- TCP ----> |  Azure  | <==== WebSocket ====> |  Azure   |
Client B <---- TCP ----> |  Relay  | <==== WebSocket ====> |  Relay   |
Client C <---- TCP ----> |  Proxy  | <==== WebSocket ====> |  Service |
                          +---------+                       +----------+

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 begin listening for incoming connection. When a connection is made a corresponding connection is made to the Azure Relay Service. The following properties are required when setting Listening:

• AccessKey (required)
• AccessKeyName (required)
• HybridConnection (required)
• NamespaceAddress (required)

To use SSL for incoming connections set SSLCert to a valid certificate with private key and set SSLEnabled to True before setting Listening.

DoEvents should be called in a loop to ensure timely processing of all activity, including connection requests and data transfer.

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 Connected event fire when the connection completes and is ready to send and receive data.

Data will be proxied between the connected client and the Azure Relay Service. No special steps are required.

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

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

The Shared Access Key.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 1 );
ipworksmq_azurerelayproxy_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_AzureRelayProxy Class)

The Shared Access Key Name.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 2 );
ipworksmq_azurerelayproxy_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

ConnectionBacklog Property (IPWorksMQ_AzureRelayProxy Class)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Object Oriented Interface

public function getConnectionBacklog();
public function setConnectionBacklog($value);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 3 );
ipworksmq_azurerelayproxy_set($res, 3, $value );

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

This property is not available at design time.

Data Type

Integer

AzureRelayProxyConnectionCount Property (IPWorksMQ_AzureRelayProxy Class)

The number of records in the AzureRelayProxyConnection arrays.

Object Oriented Interface

public function getAzureRelayProxyConnectionCount();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 4 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AzureRelayProxyConnectionConnected
• AzureRelayProxyConnectionConnectionId
• AzureRelayProxyConnectionIdleTimeout
• AzureRelayProxyConnectionLocalAddress
• AzureRelayProxyConnectionRemoteHost
• AzureRelayProxyConnectionRemotePort
• AzureRelayProxyConnectionTimeout
• AzureRelayProxyConnectionUserData

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

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

Data Type

Integer

AzureRelayProxyConnectionConnected Property (IPWorksMQ_AzureRelayProxy Class)

This property indicates the status of individual connections.

Object Oriented Interface

public function getAzureRelayProxyConnectionConnected($connectionid);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 5 , $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 AzureRelayProxyConnectionCount property.

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

Data Type

Boolean

AzureRelayProxyConnectionConnectionId Property (IPWorksMQ_AzureRelayProxy Class)

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

Object Oriented Interface

public function getAzureRelayProxyConnectionConnectionId($connectionid);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 6 , $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 AzureRelayProxyConnectionCount property.

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

Data Type

Integer

AzureRelayProxyConnectionIdleTimeout Property (IPWorksMQ_AzureRelayProxy Class)

This property contains the idle timeout for this connection.

Object Oriented Interface

public function getAzureRelayProxyConnectionIdleTimeout($connectionid);
public function setAzureRelayProxyConnectionIdleTimeout($connectionid, $value);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 7 , $connectionid);
ipworksmq_azurerelayproxy_set($res, 7, $value , $connectionid);

Default Value

0

Remarks

This property contains the idle timeout for this connection. This property is similar to DefaultIdleTimeout but may be set on a per-connection basis to override DefaultIdleTimeout. This property specifies the idle timeout (in seconds) for the connected client. When set to a positive value, the class will disconnect idle clients after the specified timeout.

This applies only to clients that have not sent to received data within the specified number of seconds.

If set to 0 (default), no idle timeout is applied.

Note: DoEvents must be called for the class to check existing connections.

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

This property is not available at design time.

Data Type

Integer

AzureRelayProxyConnectionLocalAddress Property (IPWorksMQ_AzureRelayProxy Class)

This property shows the IP address of the interface through which the connection is passing.

Object Oriented Interface

public function getAzureRelayProxyConnectionLocalAddress($connectionid);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 8 , $connectionid);

Default Value

''

Remarks

This property shows the IP address of the interface through which the connection is passing.

AzureRelayProxyConnectionLocalAddress is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going.

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

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

Data Type

String

AzureRelayProxyConnectionRemoteHost Property (IPWorksMQ_AzureRelayProxy Class)

This property shows the IP address of the remote host through which the connection is coming.

Object Oriented Interface

public function getAzureRelayProxyConnectionRemoteHost($connectionid);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 9 , $connectionid);

Default Value

''

Remarks

This property shows the IP address of the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

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

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

Data Type

String

AzureRelayProxyConnectionRemotePort Property (IPWorksMQ_AzureRelayProxy Class)

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

Object Oriented Interface

public function getAzureRelayProxyConnectionRemotePort($connectionid);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 10 , $connectionid);

Default Value

0

Remarks

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

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

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

Data Type

Integer

AzureRelayProxyConnectionTimeout Property (IPWorksMQ_AzureRelayProxy Class)

This property specifies a timeout for the class.

Object Oriented Interface

public function getAzureRelayProxyConnectionTimeout($connectionid);
public function setAzureRelayProxyConnectionTimeout($connectionid, $value);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 11 , $connectionid);
ipworksmq_azurerelayproxy_set($res, 11, $value , $connectionid);

Default Value

0

Remarks

This property specifies a timeout for the class.

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

If AzureRelayProxyConnectionTimeout 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 AzureRelayProxyConnectionTimeout 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 AzureRelayProxyConnectionTimeout 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 AzureRelayProxyConnectionCount property.

This property is not available at design time.

Data Type

Integer

AzureRelayProxyConnectionUserData Property (IPWorksMQ_AzureRelayProxy Class)

The UserData property holds connection-specific user-specified data.

Object Oriented Interface

public function getAzureRelayProxyConnectionUserData($connectionid);
public function setAzureRelayProxyConnectionUserData($connectionid, $value);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 12 , $connectionid);
ipworksmq_azurerelayproxy_set($res, 12, $value , $connectionid);

Default Value

''

Remarks

The AzureRelayProxyConnectionUserData property holds connection-specific user-specified data.

User-specified data may be set or retrieved at any point while the connection is valid. This provides a simple way to associate arbitrary data with a specific connection.

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

This property is not available at design time.

Data Type

Binary String

DefaultIdleTimeout Property (IPWorksMQ_AzureRelayProxy Class)

This property includes the default idle timeout for inactive clients.

Object Oriented Interface

public function getDefaultIdleTimeout();
public function setDefaultIdleTimeout($value);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 13 );
ipworksmq_azurerelayproxy_set($res, 13, $value );

Default Value

0

Remarks

This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the class will disconnect idle clients after the specified timeout.

This applies only to clients that have not sent or received data within DefaultIdleTimeout seconds.

If set to 0 (default), no idle timeout is applied.

Note: DoEvents must be called for the class to check existing connections.

Data Type

Integer

DefaultTimeout Property (IPWorksMQ_AzureRelayProxy Class)

This property includes an initial timeout value to be used by incoming connections.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 14 );
ipworksmq_azurerelayproxy_set($res, 14, $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

HybridConnection Property (IPWorksMQ_AzureRelayProxy Class)

The hybrid connection name.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 15 );
ipworksmq_azurerelayproxy_set($res, 15, $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

KeepAlive Property (IPWorksMQ_AzureRelayProxy Class)

When True, KEEPALIVE packets are enabled (for long connections).

Object Oriented Interface

public function getKeepAlive();
public function setKeepAlive($value);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 16 );
ipworksmq_azurerelayproxy_set($res, 16, $value );

Default Value

false

Remarks

This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.

Note: System Transmission Control Protocol (TCP)/IP stack implementations are not required to support SO_KEEPALIVE.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Data Type

Boolean

Linger Property (IPWorksMQ_AzureRelayProxy Class)

When set to True, connections are terminated gracefully.

Object Oriented Interface

public function getLinger();
public function setLinger($value);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 17 );
ipworksmq_azurerelayproxy_set($res, 17, $value );

Default Value

true

Remarks

This property controls how a connection is closed. The default is True. In this case, the connection is closed only after all the data are sent. Setting it to False forces an abrupt (hard) disconnection. Any data that were in the sending queue may be lost.

The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the class returns control immediately, the system might indefinitely hold system resources until all pending data are sent (even after your application closes). This means that valuable system resources might be wasted.

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

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Data Type

Boolean

Listening Property (IPWorksMQ_AzureRelayProxy Class)

This property indicates whether the class is listening for incoming connections on LocalPort.

Object Oriented Interface

public function getListening();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 18 );

Default Value

false

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

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

Data Type

Boolean

LocalHost Property (IPWorksMQ_AzureRelayProxy 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_azurerelayproxy_get($res, 19 );
ipworksmq_azurerelayproxy_set($res, 19, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

LocalPort Property (IPWorksMQ_AzureRelayProxy Class)

This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens.

Object Oriented Interface

public function getLocalPort();
public function setLocalPort($value);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 20 );
ipworksmq_azurerelayproxy_set($res, 20, $value );

Default Value

0

Remarks

This property must be set before the class can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the class is listening (i.e., after successfully assigning True to the Listening property).

The service port is not shared among servers so two classs cannot be listening on the same port at the same time.

Data Type

Integer

NamespaceAddress Property (IPWorksMQ_AzureRelayProxy Class)

The namespace address of the relay.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 21 );
ipworksmq_azurerelayproxy_set($res, 21, $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

SSLAuthenticateClients Property (IPWorksMQ_AzureRelayProxy Class)

If set to True, the server asks the client(s) for a certificate.

Object Oriented Interface

public function getSSLAuthenticateClients();
public function setSSLAuthenticateClients($value);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 22 );
ipworksmq_azurerelayproxy_set($res, 22, $value );

Default Value

false

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

Data Type

Boolean

SSLCertEffectiveDate Property (IPWorksMQ_AzureRelayProxy Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 23 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 24 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 25 );

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

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 26 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 27 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 28 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 29 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 30 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 31 );

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

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 32 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 33 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 34 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 35 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 36 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 37 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 38 );
ipworksmq_azurerelayproxy_set($res, 38, $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_AzureRelayProxy 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_azurerelayproxy_get($res, 39 );
ipworksmq_azurerelayproxy_set($res, 39, $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_AzureRelayProxy Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 40 );
ipworksmq_azurerelayproxy_set($res, 40, $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_AzureRelayProxy Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 41 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksMQ_AzureRelayProxy Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 42 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 43 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 44 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 45 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 46 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 47 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 48 );
ipworksmq_azurerelayproxy_set($res, 48, $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_AzureRelayProxy Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 49 );
ipworksmq_azurerelayproxy_set($res, 49, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLEnabled Property (IPWorksMQ_AzureRelayProxy Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 50 );
ipworksmq_azurerelayproxy_set($res, 50, $value );

Default Value

false

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

SSLStartMode Property (IPWorksMQ_AzureRelayProxy Class)

This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.

Object Oriented Interface

public function getSSLStartMode();
public function setSSLStartMode($value);

Procedural Interface

ipworksmq_azurerelayproxy_get($res, 51 );
ipworksmq_azurerelayproxy_set($res, 51, $value );

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Config Method (IPWorksMQ_AzureRelayProxy Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksmq_azurerelayproxy_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_AzureRelayProxy Class)

This method disconnects the specified client.

Object Oriented Interface

public function doDisconnect($connectionid);

Procedural Interface

ipworksmq_azurerelayproxy_do_disconnect($res, $connectionid);

Remarks

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

DoEvents Method (IPWorksMQ_AzureRelayProxy Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

Reset Method (IPWorksMQ_AzureRelayProxy Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksmq_azurerelayproxy_do_reset($res);

Remarks

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

Shutdown Method (IPWorksMQ_AzureRelayProxy Class)

This method shuts down the server.

Object Oriented Interface

public function doShutdown();

Procedural Interface

ipworksmq_azurerelayproxy_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_AzureRelayProxy Class)

This method starts listening for incoming connections.

Object Oriented Interface

public function doStartListening();

Procedural Interface

ipworksmq_azurerelayproxy_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 are transferred.

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

StopListening Method (IPWorksMQ_AzureRelayProxy Class)

This method stops listening for new connections.

Object Oriented Interface

public function doStopListening();

Procedural Interface

ipworksmq_azurerelayproxy_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_AzureRelayProxy Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

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

Parameter List

 'connectionid'
 'statuscode'
 'description'

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (IPWorksMQ_AzureRelayProxy Class)

This event is fired when a request for connection comes from a remote host.

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

ipworksmq_azurerelayproxy_register_callback($res, 2, array($this, 'fireConnectionRequest'));

Parameter List

 'address'
 'port'
 'accept'

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

Disconnected Event (IPWorksMQ_AzureRelayProxy Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksmq_azurerelayproxy_register_callback($res, 3, array($this, 'fireDisconnected'));

Parameter List

 'connectionid'
 '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 system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

Error Event (IPWorksMQ_AzureRelayProxy Class)

This event fires information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksmq_azurerelayproxy_register_callback($res, 4, array($this, 'fireError'));

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.

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.

ConnectionId indicates the connection for which the error is applicable.

Log Event (IPWorksMQ_AzureRelayProxy Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksmq_azurerelayproxy_register_callback($res, 5, 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"

SSLClientAuthentication Event (IPWorksMQ_AzureRelayProxy Class)

This event is fired when the client presents its credentials to the server.

Object Oriented Interface

public function fireSSLClientAuthentication($param);

Procedural Interface

ipworksmq_azurerelayproxy_register_callback($res, 6, array($this, 'fireSSLClientAuthentication'));

Parameter List

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

Remarks

This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to 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").

SSLConnectionRequest Event (IPWorksMQ_AzureRelayProxy Class)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Object Oriented Interface

public function fireSSLConnectionRequest($param);

Procedural Interface

ipworksmq_azurerelayproxy_register_callback($res, 7, array($this, 'fireSSLConnectionRequest'));

Parameter List

 'connectionid'
 'supportedciphersuites'
 'supportedsignaturealgs'
 'certstoretype'
 'certstore'
 'certpassword'
 'certsubject'

Remarks

This event fires when an SSL connection is requested and SSLProvider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to Platform.

This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

ConnectionId is the connection Id of the client requesting the connection.

SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.

SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.

CertStoreType is the store type of the alternate certificate to use for this connection. 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:

CertStore is the store name or location of the alternate certificate to use for this connection.

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

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the 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.

SSLStatus Event (IPWorksMQ_AzureRelayProxy Class)

This event is fired to show the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksmq_azurerelayproxy_register_callback($res, 8, array($this, 'fireSSLStatus'));

Parameter List

 'connectionid'
 'message'

Remarks

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

Config Settings (AzureRelayProxy Class)

AzureRelayProxy Config Settings

HTTP Config Settings

TCPClient 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-----

Socket Config Settings

Trappable Errors (AzureRelayProxy Class)

AzureRelayProxy Errors