AzureRelayReceiver Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

AzureRelayReceiver

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 DataToSend 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 (AzureRelayReceiver Class)

The Shared Access Key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccessKey();
int SetAccessKey(const char* lpszAccessKey);

Unicode (Windows)
LPWSTR GetAccessKey();
INT SetAccessKey(LPCWSTR lpszAccessKey);

char* ipworksmq_azurerelayreceiver_getaccesskey(void* lpObj);
int ipworksmq_azurerelayreceiver_setaccesskey(void* lpObj, const char* lpszAccessKey);

QString GetAccessKey();
int SetAccessKey(QString qsAccessKey);

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

The Shared Access Key Name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccessKeyName();
int SetAccessKeyName(const char* lpszAccessKeyName);

Unicode (Windows)
LPWSTR GetAccessKeyName();
INT SetAccessKeyName(LPCWSTR lpszAccessKeyName);

char* ipworksmq_azurerelayreceiver_getaccesskeyname(void* lpObj);
int ipworksmq_azurerelayreceiver_setaccesskeyname(void* lpObj, const char* lpszAccessKeyName);

QString GetAccessKeyName();
int SetAccessKeyName(QString qsAccessKeyName);

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

Whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworksmq_azurerelayreceiver_getconnected(void* lpObj);

bool GetConnected();

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

Connections Property (AzureRelayReceiver Class)

A collection of currently connected clients.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQAzureRelayConnection>* GetConnections();

int ipworksmq_azurerelayreceiver_getazurerelayconnectioncount(void* lpObj);

int ipworksmq_azurerelayreceiver_getazurerelayconnectionacceptdata(void* lpObj, int connectionid);
int ipworksmq_azurerelayreceiver_setazurerelayconnectionacceptdata(void* lpObj, int connectionid, int bAzureRelayConnectionAcceptData);

char* ipworksmq_azurerelayreceiver_getazurerelayconnectionaddress(void* lpObj, int connectionid);

int ipworksmq_azurerelayreceiver_getazurerelayconnectionbytessent(void* lpObj, int connectionid);

int ipworksmq_azurerelayreceiver_getazurerelayconnectionconnected(void* lpObj, int connectionid);

char* ipworksmq_azurerelayreceiver_getazurerelayconnectionconnectheaders(void* lpObj, int connectionid);

int ipworksmq_azurerelayreceiver_getazurerelayconnectionconnectionid(void* lpObj, int connectionid);

int ipworksmq_azurerelayreceiver_getazurerelayconnectiondataformat(void* lpObj, int connectionid);
int ipworksmq_azurerelayreceiver_setazurerelayconnectiondataformat(void* lpObj, int connectionid, int iAzureRelayConnectionDataFormat);

int ipworksmq_azurerelayreceiver_setazurerelayconnectiondatatosend(void* lpObj, int connectionid, const char* lpAzureRelayConnectionDataToSend, int lenAzureRelayConnectionDataToSend);

char* ipworksmq_azurerelayreceiver_getazurerelayconnectionextensions(void* lpObj, int connectionid);

char* ipworksmq_azurerelayreceiver_getazurerelayconnectionhost(void* lpObj, int connectionid);

char* ipworksmq_azurerelayreceiver_getazurerelayconnectionid(void* lpObj, int connectionid);

int ipworksmq_azurerelayreceiver_getazurerelayconnectionreadytosend(void* lpObj, int connectionid);

char* ipworksmq_azurerelayreceiver_getazurerelayconnectionremoteaddress(void* lpObj, int connectionid);

int ipworksmq_azurerelayreceiver_getazurerelayconnectionremoteport(void* lpObj, int connectionid);

char* ipworksmq_azurerelayreceiver_getazurerelayconnectionsubprotocols(void* lpObj, int connectionid);

int ipworksmq_azurerelayreceiver_getazurerelayconnectiontimeout(void* lpObj, int connectionid);
int ipworksmq_azurerelayreceiver_setazurerelayconnectiontimeout(void* lpObj, int connectionid, int iAzureRelayConnectionTimeout);

int GetAzureRelayConnectionCount();

bool GetAzureRelayConnectionAcceptData(int iConnectionId);
int SetAzureRelayConnectionAcceptData(int iConnectionId, bool bAzureRelayConnectionAcceptData);

QString GetAzureRelayConnectionAddress(int iConnectionId);

int GetAzureRelayConnectionBytesSent(int iConnectionId);

bool GetAzureRelayConnectionConnected(int iConnectionId);

QString GetAzureRelayConnectionConnectHeaders(int iConnectionId);

int GetAzureRelayConnectionConnectionId(int iConnectionId);

int GetAzureRelayConnectionDataFormat(int iConnectionId);
int SetAzureRelayConnectionDataFormat(int iConnectionId, int iAzureRelayConnectionDataFormat);

int SetAzureRelayConnectionDataToSend(int iConnectionId, QByteArray qbaAzureRelayConnectionDataToSend);

QString GetAzureRelayConnectionExtensions(int iConnectionId);

QString GetAzureRelayConnectionHost(int iConnectionId);

QString GetAzureRelayConnectionId(int iConnectionId);

bool GetAzureRelayConnectionReadyToSend(int iConnectionId);

QString GetAzureRelayConnectionRemoteAddress(int iConnectionId);

int GetAzureRelayConnectionRemotePort(int iConnectionId);

QString GetAzureRelayConnectionSubProtocols(int iConnectionId);

int GetAzureRelayConnectionTimeout(int iConnectionId);
int SetAzureRelayConnectionTimeout(int iConnectionId, int iAzureRelayConnectionTimeout);

Remarks

This property is a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the AzureRelayConnection type.

This collection is a hashtable type of collection, in which the connection Id string is used as the key to the desired connection. The connection Id is present when events such as the ConnectionConnected event fires.

This property is read-only.

Data Type

IPWorksMQAzureRelayConnection

DefaultTimeout Property (AzureRelayReceiver Class)

An initial timeout value to be used by incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);

Unicode (Windows)
INT GetDefaultTimeout();
INT SetDefaultTimeout(INT iDefaultTimeout);

int ipworksmq_azurerelayreceiver_getdefaulttimeout(void* lpObj);
int ipworksmq_azurerelayreceiver_setdefaulttimeout(void* lpObj, int iDefaultTimeout);

int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);

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

Firewall Property (AzureRelayReceiver Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksMQFirewall* GetFirewall();
int SetFirewall(IPWorksMQFirewall* val);

int ipworksmq_azurerelayreceiver_getfirewallautodetect(void* lpObj);
int ipworksmq_azurerelayreceiver_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksmq_azurerelayreceiver_getfirewalltype(void* lpObj);
int ipworksmq_azurerelayreceiver_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksmq_azurerelayreceiver_getfirewallhost(void* lpObj);
int ipworksmq_azurerelayreceiver_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksmq_azurerelayreceiver_getfirewallpassword(void* lpObj);
int ipworksmq_azurerelayreceiver_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksmq_azurerelayreceiver_getfirewallport(void* lpObj);
int ipworksmq_azurerelayreceiver_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworksmq_azurerelayreceiver_getfirewalluser(void* lpObj);
int ipworksmq_azurerelayreceiver_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

IPWorksMQFirewall

ForwardingHost Property (AzureRelayReceiver Class)

The address to which traffic will automatically be forwarded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetForwardingHost();
int SetForwardingHost(const char* lpszForwardingHost);

Unicode (Windows)
LPWSTR GetForwardingHost();
INT SetForwardingHost(LPCWSTR lpszForwardingHost);

char* ipworksmq_azurerelayreceiver_getforwardinghost(void* lpObj);
int ipworksmq_azurerelayreceiver_setforwardinghost(void* lpObj, const char* lpszForwardingHost);

QString GetForwardingHost();
int SetForwardingHost(QString qsForwardingHost);

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

The port to which traffic will automatically be forwarded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetForwardingPort();
int SetForwardingPort(int iForwardingPort);

Unicode (Windows)
INT GetForwardingPort();
INT SetForwardingPort(INT iForwardingPort);

int ipworksmq_azurerelayreceiver_getforwardingport(void* lpObj);
int ipworksmq_azurerelayreceiver_setforwardingport(void* lpObj, int iForwardingPort);

int GetForwardingPort();
int SetForwardingPort(int iForwardingPort);

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

The hybrid connection name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHybridConnection();
int SetHybridConnection(const char* lpszHybridConnection);

Unicode (Windows)
LPWSTR GetHybridConnection();
INT SetHybridConnection(LPCWSTR lpszHybridConnection);

char* ipworksmq_azurerelayreceiver_gethybridconnection(void* lpObj);
int ipworksmq_azurerelayreceiver_sethybridconnection(void* lpObj, const char* lpszHybridConnection);

QString GetHybridConnection();
int SetHybridConnection(QString qsHybridConnection);

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

If , the class is listening for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListening();
int SetListening(int bListening);

Unicode (Windows)
BOOL GetListening();
INT SetListening(BOOL bListening);

int ipworksmq_azurerelayreceiver_getlistening(void* lpObj);
int ipworksmq_azurerelayreceiver_setlistening(void* lpObj, int bListening);

bool GetListening();
int SetListening(bool bListening);

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

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksmq_azurerelayreceiver_getlocalhost(void* lpObj);
int ipworksmq_azurerelayreceiver_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

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

The namespace address of the relay.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNamespaceAddress();
int SetNamespaceAddress(const char* lpszNamespaceAddress);

Unicode (Windows)
LPWSTR GetNamespaceAddress();
INT SetNamespaceAddress(LPCWSTR lpszNamespaceAddress);

char* ipworksmq_azurerelayreceiver_getnamespaceaddress(void* lpObj);
int ipworksmq_azurerelayreceiver_setnamespaceaddress(void* lpObj, const char* lpszNamespaceAddress);

QString GetNamespaceAddress();
int SetNamespaceAddress(QString qsNamespaceAddress);

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

Proxy Property (AzureRelayReceiver Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

IPWorksMQProxy* GetProxy();
int SetProxy(IPWorksMQProxy* val);

int ipworksmq_azurerelayreceiver_getproxyauthscheme(void* lpObj);
int ipworksmq_azurerelayreceiver_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int ipworksmq_azurerelayreceiver_getproxyautodetect(void* lpObj);
int ipworksmq_azurerelayreceiver_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* ipworksmq_azurerelayreceiver_getproxypassword(void* lpObj);
int ipworksmq_azurerelayreceiver_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int ipworksmq_azurerelayreceiver_getproxyport(void* lpObj);
int ipworksmq_azurerelayreceiver_setproxyport(void* lpObj, int iProxyPort);

char* ipworksmq_azurerelayreceiver_getproxyserver(void* lpObj);
int ipworksmq_azurerelayreceiver_setproxyserver(void* lpObj, const char* lpszProxyServer);

int ipworksmq_azurerelayreceiver_getproxyssl(void* lpObj);
int ipworksmq_azurerelayreceiver_setproxyssl(void* lpObj, int iProxySSL);

char* ipworksmq_azurerelayreceiver_getproxyuser(void* lpObj);
int ipworksmq_azurerelayreceiver_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

IPWorksMQProxy

SSLAcceptServerCert Property (AzureRelayReceiver Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksMQCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksMQCertificate* val);

char* ipworksmq_azurerelayreceiver_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertissuer(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertprivatekey(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertpublickey(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksmq_azurerelayreceiver_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertstorepassword(void* lpObj);
int ipworksmq_azurerelayreceiver_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksmq_azurerelayreceiver_getsslacceptservercertstoretype(void* lpObj);
int ipworksmq_azurerelayreceiver_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertusage(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslacceptservercertusageflags(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertversion(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslacceptservercertsubject(void* lpObj);
int ipworksmq_azurerelayreceiver_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksmq_azurerelayreceiver_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksmq_azurerelayreceiver_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorksMQCertificate

SSLCert Property (AzureRelayReceiver Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksMQCertificate* GetSSLCert();
int SetSSLCert(IPWorksMQCertificate* val);

char* ipworksmq_azurerelayreceiver_getsslcerteffectivedate(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertexpirationdate(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertextendedkeyusage(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertfingerprint(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertfingerprintsha1(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertfingerprintsha256(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertissuer(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertprivatekey(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertpublickey(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslcertpublickeylength(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertserialnumber(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertsignaturealgorithm(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksmq_azurerelayreceiver_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksmq_azurerelayreceiver_getsslcertstorepassword(void* lpObj);
int ipworksmq_azurerelayreceiver_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksmq_azurerelayreceiver_getsslcertstoretype(void* lpObj);
int ipworksmq_azurerelayreceiver_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksmq_azurerelayreceiver_getsslcertsubjectaltnames(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertthumbprintmd5(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertthumbprintsha1(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertthumbprintsha256(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertusage(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslcertusageflags(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertversion(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslcertsubject(void* lpObj);
int ipworksmq_azurerelayreceiver_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksmq_azurerelayreceiver_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksmq_azurerelayreceiver_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksMQCertificate

SSLProvider Property (AzureRelayReceiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksmq_azurerelayreceiver_getsslprovider(void* lpObj);
int ipworksmq_azurerelayreceiver_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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

SSLServerCert Property (AzureRelayReceiver Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksMQCertificate* GetSSLServerCert();

char* ipworksmq_azurerelayreceiver_getsslservercerteffectivedate(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertexpirationdate(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertfingerprint(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertissuer(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertprivatekey(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertpublickey(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslservercertpublickeylength(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertserialnumber(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertsignaturealgorithm(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworksmq_azurerelayreceiver_getsslservercertstorepassword(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslservercertstoretype(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertusage(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslservercertusageflags(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertversion(void* lpObj);

char* ipworksmq_azurerelayreceiver_getsslservercertsubject(void* lpObj);

int ipworksmq_azurerelayreceiver_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksMQCertificate

Config Method (AzureRelayReceiver Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksmq_azurerelayreceiver_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Disconnect Method (AzureRelayReceiver Class)

This method disconnects the specified client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect(int iConnectionId);

Unicode (Windows)
INT Disconnect(INT iConnectionId);

int ipworksmq_azurerelayreceiver_disconnect(void* lpObj, int iConnectionId);

int Disconnect(int iConnectionId);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (AzureRelayReceiver Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksmq_azurerelayreceiver_doevents(void* lpObj);

int DoEvents();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (AzureRelayReceiver Class)

Interrupts a synchronous send to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt(int iConnectionId);

Unicode (Windows)
INT Interrupt(INT iConnectionId);

int ipworksmq_azurerelayreceiver_interrupt(void* lpObj, int iConnectionId);

int Interrupt(int iConnectionId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

PauseData Method (AzureRelayReceiver Class)

This method pauses data reception.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PauseData(int iConnectionId);

Unicode (Windows)
INT PauseData(INT iConnectionId);

int ipworksmq_azurerelayreceiver_pausedata(void* lpObj, int iConnectionId);

int PauseData(int iConnectionId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ProcessData Method (AzureRelayReceiver Class)

This method reenables data reception after a call to PauseData .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ProcessData(int iConnectionId);

Unicode (Windows)
INT ProcessData(INT iConnectionId);

int ipworksmq_azurerelayreceiver_processdata(void* lpObj, int iConnectionId);

int ProcessData(int iConnectionId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Send Method (AzureRelayReceiver Class)

This method sends binary data to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Send(int iConnectionId, const char* lpData, int lenData);

Unicode (Windows)
INT Send(INT iConnectionId, LPCSTR lpData, INT lenData);

int ipworksmq_azurerelayreceiver_send(void* lpObj, int iConnectionId, const char* lpData, int lenData);

int Send(int iConnectionId, QByteArray qbaData);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendBytes Method (AzureRelayReceiver Class)

This method sends binary data to the specified client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendBytes(int iConnectionId, const char* lpData, int lenData);

Unicode (Windows)
INT SendBytes(INT iConnectionId, LPCSTR lpData, INT lenData);

int ipworksmq_azurerelayreceiver_sendbytes(void* lpObj, int iConnectionId, const char* lpData, int lenData);

int SendBytes(int iConnectionId, QByteArray qbaData);

Remarks

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

When Timeout 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendFile Method (AzureRelayReceiver Class)

This method sends the file to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendFile(int iConnectionId, const char* lpszFileName);

Unicode (Windows)
INT SendFile(INT iConnectionId, LPCWSTR lpszFileName);

int ipworksmq_azurerelayreceiver_sendfile(void* lpObj, int iConnectionId, const char* lpszFileName);

int SendFile(int iConnectionId, const QString& qsFileName);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendHTTPResponse Method (AzureRelayReceiver Class)

Send the HTTP response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendHTTPResponse(int iConnectionId, int iStatusCode, const char* lpszStatusDescription, const char* lpResponseData, int lenResponseData);

Unicode (Windows)
INT SendHTTPResponse(INT iConnectionId, INT iStatusCode, LPCWSTR lpszStatusDescription, LPCSTR lpResponseData, INT lenResponseData);

int ipworksmq_azurerelayreceiver_sendhttpresponse(void* lpObj, int iConnectionId, int iStatusCode, const char* lpszStatusDescription, const char* lpResponseData, int lenResponseData);

int SendHTTPResponse(int iConnectionId, int iStatusCode, const QString& qsStatusDescription, QByteArray qbaResponseData);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendText Method (AzureRelayReceiver Class)

This method sends text data to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendText(int iConnectionId, const char* lpszText);

Unicode (Windows)
INT SendText(INT iConnectionId, LPCWSTR lpszText);

int ipworksmq_azurerelayreceiver_sendtext(void* lpObj, int iConnectionId, const char* lpszText);

int SendText(int iConnectionId, const QString& qsText);

Remarks

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

When Timeout 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 DataFormat. The class will UTF-8 encode the supplied text.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Shutdown Method (AzureRelayReceiver Class)

This method shuts down the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Shutdown();

Unicode (Windows)
INT Shutdown();

int ipworksmq_azurerelayreceiver_shutdown(void* lpObj);

int Shutdown();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartListening Method (AzureRelayReceiver Class)

Starts listening for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();

int ipworksmq_azurerelayreceiver_startlistening(void* lpObj);

int StartListening();

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StopListening Method (AzureRelayReceiver Class)

This method stops listening for new connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();

int ipworksmq_azurerelayreceiver_stoplistening(void* lpObj);

int StopListening();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (AzureRelayReceiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(AzureRelayReceiverConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} AzureRelayReceiverConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(AzureRelayReceiverConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} AzureRelayReceiverConnectedEventParams;

#define EID_AZURERELAYRECEIVER_CONNECTED 1

virtual INT IPWORKSMQ_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class AzureRelayReceiverConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(AzureRelayReceiverConnectedEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireConnected(AzureRelayReceiverConnectedEventParams *e) {...}

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

Fired when a client has connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionConnected(AzureRelayReceiverConnectionConnectedEventParams *e);

typedef struct {
  int ConnectionId;
  int reserved;
} AzureRelayReceiverConnectionConnectedEventParams;


Unicode (Windows)
virtual INT FireConnectionConnected(AzureRelayReceiverConnectionConnectedEventParams *e);

typedef struct {
  INT ConnectionId;
  INT reserved;
} AzureRelayReceiverConnectionConnectedEventParams;

#define EID_AZURERELAYRECEIVER_CONNECTIONCONNECTED 2

virtual INT IPWORKSMQ_CALL FireConnectionConnected(INT &iConnectionId);

class AzureRelayReceiverConnectionConnectedEventParams {
public:
  int ConnectionId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionConnected(AzureRelayReceiverConnectionConnectedEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireConnectionConnected(AzureRelayReceiverConnectionConnectedEventParams *e) {...}

Remarks

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

ConnectionId identifies the connection.

ConnectionDataIn Event (AzureRelayReceiver Class)

Fired when data is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionDataIn(AzureRelayReceiverConnectionDataInEventParams *e);

typedef struct {
  int ConnectionId;
  int DataFormat;
  const char *Text;
  int lenText;
  int EOM;
  int reserved;
} AzureRelayReceiverConnectionDataInEventParams;


Unicode (Windows)
virtual INT FireConnectionDataIn(AzureRelayReceiverConnectionDataInEventParams *e);

typedef struct {
  INT ConnectionId;
  INT DataFormat;
  LPCSTR Text;
  INT lenText;
  BOOL EOM;
  INT reserved;
} AzureRelayReceiverConnectionDataInEventParams;

#define EID_AZURERELAYRECEIVER_CONNECTIONDATAIN 3

virtual INT IPWORKSMQ_CALL FireConnectionDataIn(INT &iConnectionId, INT &iDataFormat, LPSTR &lpText, INT &lenText, BOOL &bEOM);

class AzureRelayReceiverConnectionDataInEventParams {
public:
  int ConnectionId();

  int DataFormat();

  const QByteArray &Text();

  bool EOM();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionDataIn(AzureRelayReceiverConnectionDataInEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireConnectionDataIn(AzureRelayReceiverConnectionDataInEventParams *e) {...}

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

Fired when a WebSocket connection is disconnected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionDisconnected(AzureRelayReceiverConnectionDisconnectedEventParams *e);

typedef struct {
  int ConnectionId;
  int StatusCode;
  const char *Description;
  int reserved;
} AzureRelayReceiverConnectionDisconnectedEventParams;


Unicode (Windows)
virtual INT FireConnectionDisconnected(AzureRelayReceiverConnectionDisconnectedEventParams *e);

typedef struct {
  INT ConnectionId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} AzureRelayReceiverConnectionDisconnectedEventParams;

#define EID_AZURERELAYRECEIVER_CONNECTIONDISCONNECTED 4

virtual INT IPWORKSMQ_CALL FireConnectionDisconnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);

class AzureRelayReceiverConnectionDisconnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionDisconnected(AzureRelayReceiverConnectionDisconnectedEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireConnectionDisconnected(AzureRelayReceiverConnectionDisconnectedEventParams *e) {...}

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

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionError(AzureRelayReceiverConnectionErrorEventParams *e);

typedef struct {
  int ConnectionId;
  int ErrorCode;
  const char *Description;
  int reserved;
} AzureRelayReceiverConnectionErrorEventParams;


Unicode (Windows)
virtual INT FireConnectionError(AzureRelayReceiverConnectionErrorEventParams *e);

typedef struct {
  INT ConnectionId;
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} AzureRelayReceiverConnectionErrorEventParams;

#define EID_AZURERELAYRECEIVER_CONNECTIONERROR 5

virtual INT IPWORKSMQ_CALL FireConnectionError(INT &iConnectionId, INT &iErrorCode, LPSTR &lpszDescription);

class AzureRelayReceiverConnectionErrorEventParams {
public:
  int ConnectionId();

  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionError(AzureRelayReceiverConnectionErrorEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireConnectionError(AzureRelayReceiverConnectionErrorEventParams *e) {...}

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

Fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionReadyToSend(AzureRelayReceiverConnectionReadyToSendEventParams *e);

typedef struct {
  int ConnectionId;
  int reserved;
} AzureRelayReceiverConnectionReadyToSendEventParams;


Unicode (Windows)
virtual INT FireConnectionReadyToSend(AzureRelayReceiverConnectionReadyToSendEventParams *e);

typedef struct {
  INT ConnectionId;
  INT reserved;
} AzureRelayReceiverConnectionReadyToSendEventParams;

#define EID_AZURERELAYRECEIVER_CONNECTIONREADYTOSEND 6

virtual INT IPWORKSMQ_CALL FireConnectionReadyToSend(INT &iConnectionId);

class AzureRelayReceiverConnectionReadyToSendEventParams {
public:
  int ConnectionId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionReadyToSend(AzureRelayReceiverConnectionReadyToSendEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireConnectionReadyToSend(AzureRelayReceiverConnectionReadyToSendEventParams *e) {...}

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

Fires when a WebSocket connection is requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionRequest(AzureRelayReceiverConnectionRequestEventParams *e);

typedef struct {
  int Accept;
  const char *RendezvousAddress;
  const char *Id;
  const char *ConnectHeaders;
  const char *SubProtocols;
  const char *Extensions;
  const char *Host;
  const char *RemoteAddress;
  int RemotePort;
  int StatusCode;
  char *StatusDescription;
  int reserved;
} AzureRelayReceiverConnectionRequestEventParams;


Unicode (Windows)
virtual INT FireConnectionRequest(AzureRelayReceiverConnectionRequestEventParams *e);

typedef struct {
  BOOL Accept;
  LPCWSTR RendezvousAddress;
  LPCWSTR Id;
  LPCWSTR ConnectHeaders;
  LPCWSTR SubProtocols;
  LPCWSTR Extensions;
  LPCWSTR Host;
  LPCWSTR RemoteAddress;
  INT RemotePort;
  INT StatusCode;
  LPWSTR StatusDescription;
  INT reserved;
} AzureRelayReceiverConnectionRequestEventParams;

#define EID_AZURERELAYRECEIVER_CONNECTIONREQUEST 7

virtual INT IPWORKSMQ_CALL FireConnectionRequest(BOOL &bAccept, LPSTR &lpszRendezvousAddress, LPSTR &lpszId, LPSTR &lpszConnectHeaders, LPSTR &lpszSubProtocols, LPSTR &lpszExtensions, LPSTR &lpszHost, LPSTR &lpszRemoteAddress, INT &iRemotePort, INT &iStatusCode, LPSTR &lpszStatusDescription);

class AzureRelayReceiverConnectionRequestEventParams {
public:
  bool Accept();
  void SetAccept(bool bAccept);

  const QString &RendezvousAddress();

  const QString &Id();

  const QString &ConnectHeaders();

  const QString &SubProtocols();

  const QString &Extensions();

  const QString &Host();

  const QString &RemoteAddress();

  int RemotePort();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  const QString &StatusDescription();
  void SetStatusDescription(const QString &qsStatusDescription);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionRequest(AzureRelayReceiverConnectionRequestEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireConnectionRequest(AzureRelayReceiverConnectionRequestEventParams *e) {...}

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

This event is fired to indicate changes in connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(AzureRelayReceiverConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} AzureRelayReceiverConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(AzureRelayReceiverConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} AzureRelayReceiverConnectionStatusEventParams;

#define EID_AZURERELAYRECEIVER_CONNECTIONSTATUS 8

virtual INT IPWORKSMQ_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class AzureRelayReceiverConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(AzureRelayReceiverConnectionStatusEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireConnectionStatus(AzureRelayReceiverConnectionStatusEventParams *e) {...}

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

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(AzureRelayReceiverDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} AzureRelayReceiverDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(AzureRelayReceiverDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} AzureRelayReceiverDisconnectedEventParams;

#define EID_AZURERELAYRECEIVER_DISCONNECTED 9

virtual INT IPWORKSMQ_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class AzureRelayReceiverDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(AzureRelayReceiverDisconnectedEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireDisconnected(AzureRelayReceiverDisconnectedEventParams *e) {...}

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

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(AzureRelayReceiverErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} AzureRelayReceiverErrorEventParams;


Unicode (Windows)
virtual INT FireError(AzureRelayReceiverErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} AzureRelayReceiverErrorEventParams;

#define EID_AZURERELAYRECEIVER_ERROR 10

virtual INT IPWORKSMQ_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class AzureRelayReceiverErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(AzureRelayReceiverErrorEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireError(AzureRelayReceiverErrorEventParams *e) {...}

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

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(AzureRelayReceiverHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} AzureRelayReceiverHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(AzureRelayReceiverHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} AzureRelayReceiverHeaderEventParams;

#define EID_AZURERELAYRECEIVER_HEADER 11

virtual INT IPWORKSMQ_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class AzureRelayReceiverHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(AzureRelayReceiverHeaderEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireHeader(AzureRelayReceiverHeaderEventParams *e) {...}

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

Fires when an HTTP request is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHTTPRequest(AzureRelayReceiverHTTPRequestEventParams *e);

typedef struct {
  int ConnectionId;
  const char *RendezvousAddress;
  const char *Id;
  const char *RequestHeaders;
  const char *RequestTarget;
  const char *RequestMethod;
  const char *Host;
  const char *RemoteAddress;
  int RemotePort;
  const char *RequestData;
  int lenRequestData;
  int reserved;
} AzureRelayReceiverHTTPRequestEventParams;


Unicode (Windows)
virtual INT FireHTTPRequest(AzureRelayReceiverHTTPRequestEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR RendezvousAddress;
  LPCWSTR Id;
  LPCWSTR RequestHeaders;
  LPCWSTR RequestTarget;
  LPCWSTR RequestMethod;
  LPCWSTR Host;
  LPCWSTR RemoteAddress;
  INT RemotePort;
  LPCSTR RequestData;
  INT lenRequestData;
  INT reserved;
} AzureRelayReceiverHTTPRequestEventParams;

#define EID_AZURERELAYRECEIVER_HTTPREQUEST 12

virtual INT IPWORKSMQ_CALL FireHTTPRequest(INT &iConnectionId, LPSTR &lpszRendezvousAddress, LPSTR &lpszId, LPSTR &lpszRequestHeaders, LPSTR &lpszRequestTarget, LPSTR &lpszRequestMethod, LPSTR &lpszHost, LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpRequestData, INT &lenRequestData);

class AzureRelayReceiverHTTPRequestEventParams {
public:
  int ConnectionId();

  const QString &RendezvousAddress();

  const QString &Id();

  const QString &RequestHeaders();

  const QString &RequestTarget();

  const QString &RequestMethod();

  const QString &Host();

  const QString &RemoteAddress();

  int RemotePort();

  const QByteArray &RequestData();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void HTTPRequest(AzureRelayReceiverHTTPRequestEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireHTTPRequest(AzureRelayReceiverHTTPRequestEventParams *e) {...}

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

This event fires once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(AzureRelayReceiverLogEventParams *e);

typedef struct {
  int ConnectionId;
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} AzureRelayReceiverLogEventParams;


Unicode (Windows)
virtual INT FireLog(AzureRelayReceiverLogEventParams *e);

typedef struct {
  INT ConnectionId;
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} AzureRelayReceiverLogEventParams;

#define EID_AZURERELAYRECEIVER_LOG 13

virtual INT IPWORKSMQ_CALL FireLog(INT &iConnectionId, INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class AzureRelayReceiverLogEventParams {
public:
  int ConnectionId();

  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(AzureRelayReceiverLogEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireLog(AzureRelayReceiverLogEventParams *e) {...}

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

Fired when a redirection is received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRedirect(AzureRelayReceiverRedirectEventParams *e);

typedef struct {
  const char *Location;
  int Accept;
  int reserved;
} AzureRelayReceiverRedirectEventParams;


Unicode (Windows)
virtual INT FireRedirect(AzureRelayReceiverRedirectEventParams *e);

typedef struct {
  LPCWSTR Location;
  BOOL Accept;
  INT reserved;
} AzureRelayReceiverRedirectEventParams;

#define EID_AZURERELAYRECEIVER_REDIRECT 14

virtual INT IPWORKSMQ_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);

class AzureRelayReceiverRedirectEventParams {
public:
  const QString &Location();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Redirect(AzureRelayReceiverRedirectEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireRedirect(AzureRelayReceiverRedirectEventParams *e) {...}

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

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(AzureRelayReceiverSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} AzureRelayReceiverSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(AzureRelayReceiverSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} AzureRelayReceiverSSLServerAuthenticationEventParams;

#define EID_AZURERELAYRECEIVER_SSLSERVERAUTHENTICATION 15

virtual INT IPWORKSMQ_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class AzureRelayReceiverSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(AzureRelayReceiverSSLServerAuthenticationEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireSSLServerAuthentication(AzureRelayReceiverSSLServerAuthenticationEventParams *e) {...}

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

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(AzureRelayReceiverSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} AzureRelayReceiverSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(AzureRelayReceiverSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} AzureRelayReceiverSSLStatusEventParams;

#define EID_AZURERELAYRECEIVER_SSLSTATUS 16

virtual INT IPWORKSMQ_CALL FireSSLStatus(LPSTR &lpszMessage);

class AzureRelayReceiverSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(AzureRelayReceiverSSLStatusEventParams *e);

// Or, subclass AzureRelayReceiver and override this emitter function.
virtual int FireSSLStatus(AzureRelayReceiverSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

AzureRelayConnection Type

A currently connected client.

Syntax

IPWorksMQAzureRelayConnection (declared in ipworksmq.h)

Remarks

This type describes the connection of a client which is currently connected to the class. You may use the different fields of this type to manage the connection.

Fields

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

Constructors

AzureRelayConnection()

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksMQCertificate (declared in ipworksmq.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksMQFirewall (declared in ipworksmq.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

Firewall()

Proxy Type

The proxy the component will connect to.

Syntax

IPWorksMQProxy (declared in ipworksmq.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

IPWorksMQList Type

Syntax

IPWorksMQList<T> (declared in ipworksmq.h)

Remarks

IPWorksMQList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the AzureRelayReceiver class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

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)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

WebSocketServer Errors

TCPServer Errors

SSL Errors

TCP/IP Errors