IPWorks MQ 2022 ActiveX Edition
Version 22.0 [Build 8369]

AzureRelayReceiver Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

AzureRelayReceiver

Remarks

The AzureRelayReceiver control implements the listener role in the Azure Relay service. The control 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 control will immediately attempt to make a connection to the Azure Relay Service and begin listening. The following properties are applicable when setting Listening:

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

Handling Connections

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

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

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

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

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

Handling HTTP Connections

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

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

Forwarding Connections

The control 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 control 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 control with short descriptions. Click on the links for further details.

AccessKeyThe Shared Access Key.
AccessKeyNameThe Shared Access Key Name.
ConnectedThis shows whether the control is connected.
AzureRelayConnectionCountThe number of records in the AzureRelayConnection arrays.
AzureRelayConnectionAcceptDataSetting this property to False, temporarily disables data reception (and the ConnectionDataIn event) on the connection.
AzureRelayConnectionAddressThis property holds the rendezvous URL to which the connection specific websocket connection will be made.
AzureRelayConnectionBytesSentThis property shows how many bytes were sent after the last assignment to DataToSend .
AzureRelayConnectionConnectedThis property is used to disconnect individual connections and/or show their status.
AzureRelayConnectionConnectHeadersA JSON object containing the HTTP headers that have been supplied by the sender to the Azure Relay service.
AzureRelayConnectionConnectionIdThis property contains an identifier generated by the control to identify each connection.
AzureRelayConnectionDataFormatThe format of the data being sent.
AzureRelayConnectionDataToSendThis property contains a string of data to be sent to the remote host.
AzureRelayConnectionExtensionsThe WebSocket extensions sent by the client in the initial WebSocket connection request.
AzureRelayConnectionHostThe Host header value of the connected client.
AzureRelayConnectionIdThis property holds the Id of the connection.
AzureRelayConnectionReadyToSendThis indicates whether the control is ready to send data.
AzureRelayConnectionRemoteAddressThis property holds the IP address of the connecting client.
AzureRelayConnectionRemotePortThis property holds the port of the connecting client.
AzureRelayConnectionSubProtocolsThe subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.
AzureRelayConnectionTimeoutThis property specifies a timeout for the control.
DefaultTimeoutAn initial timeout value to be used by incoming connections.
FirewallAutoDetectThis property tells the control whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the transmission control protocol (TCP) port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
ForwardingHostThe address to which traffic will automatically be forwarded.
ForwardingPortThe port to which traffic will automatically be forwarded.
HybridConnectionThe hybrid connection name.
ListeningIf , the control is listening for incoming connections.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
NamespaceAddressThe namespace address of the relay.
ProxyAuthSchemeThis property is used to tell the control which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the control whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).

Method List


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

ConfigSets or retrieves a configuration setting.
DisconnectThis method disconnects the specified client.
DoEventsProcesses events from the internal message queue.
InterruptInterrupts a synchronous send to the remote host.
PauseDataThis method pauses data reception.
ProcessDataThis method reenables data reception after a call to PauseData .
SendSends binary data to the client.
SendBytesThis method sends binary data to the specified client.
SendFileThis method sends the file to the remote host.
SendHTTPResponseSend the HTTP response.
SendTextSends text data to the client.
ShutdownThis method shuts down the server.
StartListeningStarts listening for incoming connections.
StopListeningThis method stops listening for new connections.

Event List


The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

ConnectedFired immediately after a connection completes (or fails).
ConnectionConnectedFired when a client has connected.
ConnectionDataInFired when data is received.
ConnectionDisconnectedFired when a WebSocket connection is disconnected.
ConnectionErrorInformation about errors during data delivery.
ConnectionReadyToSendFired when the control is ready to send data.
ConnectionRequestFires when a WebSocket connection is requested.
ConnectionStatusFired to indicate changes in connection state.
DisconnectedThis event is fired when a connection is closed.
ErrorInformation about errors during data delivery.
HeaderThis event is fired every time a header line comes in.
HTTPRequestFires when an HTTP request is received.
LogFires once for each log message.
RedirectThis event is fired when a redirection is received from the server.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Config Settings


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

AccessTokenReturns an access token for use outside of the controls.
AutoRenewThresholdThe threshold in seconds after which the token is renewed.
AzureRelayKeepAliveTimeThe inactivity period in seconds before a ping packet is sent to keep the connection alive.
DiagnosticIdA diagnostic id used to enable end-to-end tracing.
LogLevelThe level of detail that is logged.
TokenValidityThe validity time in seconds of the access token.
BufferMessageIndicates whether or not the entire message is buffered before firing the DataIn event.
DisconnectStatusCodeSpecifies the status code when closing a connection.
DisconnectStatusDescriptionSpecifies the message associated with the disconnect status code.
MaxFrameSizeSpecifies the maximum size of the outgoing message in bytes before fragmentation occurs.
MessageLength[ConnectionId]The length of the message (in bytes) when sending asynchronously.
WaitForCloseResponseDetermines whether or not the control will forcibly close a connection.
AllowedClientsA comma-separated list of host names or IP addresses that can access the control.
BindExclusivelyWhether or not the control considers a local port reserved for exclusive use.
BlockedClientsA comma-separated list of host names or IP addresses that cannot access the control.
DefaultConnectionTimeoutThe inactivity timeout applied to the SSL handshake.
InBufferSizeThe size in bytes of the incoming queue of the socket.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
MaxConnectionsThe maximum number of connections available.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.

AccessKey Property (AzureRelayReceiver Control)

The Shared Access Key.

Syntax

azurerelayreceivercontrol.AccessKey[=string]

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

The Shared Access Key Name.

Syntax

azurerelayreceivercontrol.AccessKeyName[=string]

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

This shows whether the control is connected.

Syntax

azurerelayreceivercontrol.Connected[=boolean]

Default Value

False

Remarks

This property is used to determine whether or not the control is connected to the remote host.

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

This property is not available at design time.

Data Type

Boolean

AzureRelayConnectionCount Property (AzureRelayReceiver Control)

The number of records in the AzureRelayConnection arrays.

Syntax

azurerelayreceivercontrol.AzureRelayConnectionCount

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

AzureRelayConnectionAcceptData Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.AzureRelayConnectionAcceptData(ConnectionId)[=boolean]

Default Value

True

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

AzureRelayConnectionAddress Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.AzureRelayConnectionAddress(ConnectionId)

Default Value

""

Remarks

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

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

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

Data Type

String

AzureRelayConnectionBytesSent Property (AzureRelayReceiver Control)

This property shows how many bytes were sent after the last assignment to DataToSend .

Syntax

azurerelayreceivercontrol.AzureRelayConnectionBytesSent(ConnectionId)

Default Value

0

Remarks

This property shows how many bytes were sent after the last assignment to AzureRelayConnectionDataToSend. Please check AzureRelayConnectionDataToSend for more information.

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

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

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

Data Type

Integer

AzureRelayConnectionConnected Property (AzureRelayReceiver Control)

This property is used to disconnect individual connections and/or show their status.

Syntax

azurerelayreceivercontrol.AzureRelayConnectionConnected(ConnectionId)[=boolean]

Default Value

False

Remarks

This property is used to disconnect individual connections and/or show their status.

The AzureRelayConnectionConnected property may be set to false to close the connection.

AzureRelayConnectionConnected also shows the status of a particular connection (connected/disconnected).

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

This property is not available at design time.

Data Type

Boolean

AzureRelayConnectionConnectHeaders Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.AzureRelayConnectionConnectHeaders(ConnectionId)

Default Value

""

Remarks

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

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

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

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

Data Type

String

AzureRelayConnectionConnectionId Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.AzureRelayConnectionConnectionId(ConnectionId)

Default Value

""

Remarks

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

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

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

Data Type

String

AzureRelayConnectionDataFormat Property (AzureRelayReceiver Control)

The format of the data being sent.

Syntax

azurerelayreceivercontrol.AzureRelayConnectionDataFormat(ConnectionId)[=integer]

Possible Values

dfAutomatic(0), 
dfText(1), 
dfBinary(2), 
dfPing(9), 
dfPong(10)

Default Value

0

Remarks

The format of the data being sent. When data is sent over an established connection it is either considered as text or binary data. Text data is UTF-8 encoded. Binary data has no encoding associated with it.

Possible values are:

0 (dfAutomatic - default) The control will attempt to automatically determine the correct data format. This is suitable for most cases.
1 (dfText) The control will UTF-8 encode the specified data before sending. Data that has already been UTF-8 encoded may also be supplied.
2 (dfBinary) The control will send the data exactly as it is provided.
9 (dfPing) The control will send the ping with data exactly as it is provided.
10 (dfPong) The control will send the pong with data exactly as it is provided.

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

This property is not available at design time.

Data Type

Integer

AzureRelayConnectionDataToSend Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.AzureRelayConnectionDataToSend(ConnectionId)[=string]

Default Value

""

Remarks

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

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

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

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .AzureRelayConnectionDataToSendB.

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

Data Type

Binary String

AzureRelayConnectionExtensions Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.AzureRelayConnectionExtensions(ConnectionId)

Default Value

""

Remarks

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

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

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

Data Type

String

AzureRelayConnectionHost Property (AzureRelayReceiver Control)

The Host header value of the connected client.

Syntax

azurerelayreceivercontrol.AzureRelayConnectionHost(ConnectionId)

Default Value

""

Remarks

The Host header value of the connected client.

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

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

Data Type

String

AzureRelayConnectionId Property (AzureRelayReceiver Control)

This property holds the Id of the connection.

Syntax

azurerelayreceivercontrol.AzureRelayConnectionId(ConnectionId)

Default Value

""

Remarks

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

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

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

Data Type

String

AzureRelayConnectionReadyToSend Property (AzureRelayReceiver Control)

This indicates whether the control is ready to send data.

Syntax

azurerelayreceivercontrol.AzureRelayConnectionReadyToSend(ConnectionId)

Default Value

False

Remarks

This indicates whether the control is ready to send data.

This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is True after a client connects but will become False after a failed AzureRelayConnectionDataToSend.

After a failed AzureRelayConnectionDataToSend, the ReadyToSend event will fire and this property will be True when data can be sent again.

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

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

Data Type

Boolean

AzureRelayConnectionRemoteAddress Property (AzureRelayReceiver Control)

This property holds the IP address of the connecting client.

Syntax

azurerelayreceivercontrol.AzureRelayConnectionRemoteAddress(ConnectionId)

Default Value

""

Remarks

This property holds the IP address of the connecting client.

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

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

Data Type

String

AzureRelayConnectionRemotePort Property (AzureRelayReceiver Control)

This property holds the port of the connecting client.

Syntax

azurerelayreceivercontrol.AzureRelayConnectionRemotePort(ConnectionId)

Default Value

0

Remarks

This property holds the port of the connecting client.

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

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

Data Type

Integer

AzureRelayConnectionSubProtocols Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.AzureRelayConnectionSubProtocols(ConnectionId)

Default Value

""

Remarks

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

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

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

Data Type

String

AzureRelayConnectionTimeout Property (AzureRelayReceiver Control)

This property specifies a timeout for the control.

Syntax

azurerelayreceivercontrol.AzureRelayConnectionTimeout(ConnectionId)[=integer]

Default Value

0

Remarks

This property specifies a timeout for the control.

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

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

The control 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 control fails with an error.

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

The default value for the AzureRelayConnectionTimeout property is 0(asynchronous operation).

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

This property is not available at design time.

Data Type

Integer

DefaultTimeout Property (AzureRelayReceiver Control)

An initial timeout value to be used by incoming connections.

Syntax

azurerelayreceivercontrol.DefaultTimeout[=integer]

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallAutoDetect Property (AzureRelayReceiver Control)

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Syntax

azurerelayreceivercontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AzureRelayReceiver Control)

This property determines the type of firewall to connect through.

Syntax

azurerelayreceivercontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

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

Data Type

Integer

FirewallHost Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.FirewallHost[=string]

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (AzureRelayReceiver Control)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

azurerelayreceivercontrol.FirewallPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (AzureRelayReceiver Control)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

azurerelayreceivercontrol.FirewallPort[=integer]

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.FirewallUser[=string]

Default Value

""

Remarks

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

Data Type

String

ForwardingHost Property (AzureRelayReceiver Control)

The address to which traffic will automatically be forwarded.

Syntax

azurerelayreceivercontrol.ForwardingHost[=string]

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 control 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 Control)

The port to which traffic will automatically be forwarded.

Syntax

azurerelayreceivercontrol.ForwardingPort[=integer]

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 control 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 Control)

The hybrid connection name.

Syntax

azurerelayreceivercontrol.HybridConnection[=string]

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

If , the control is listening for incoming connections.

Syntax

azurerelayreceivercontrol.Listening[=boolean]

Default Value

False

Remarks

This setting indicates whether the control accepts incoming connections. When the control has connected to the Azure Service and started listening for incoming connections. The initiate the conenction and begin listening clal the StartListening method.

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

This property is not available at design time.

Data Type

Boolean

LocalHost Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.LocalHost[=string]

Default Value

""

Remarks

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

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

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

Data Type

String

NamespaceAddress Property (AzureRelayReceiver Control)

The namespace address of the relay.

Syntax

azurerelayreceivercontrol.NamespaceAddress[=string]

Default Value

""

Remarks

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

Data Type

String

ProxyAuthScheme Property (AzureRelayReceiver Control)

This property is used to tell the control which type of authorization to perform when connecting to the proxy.

Syntax

azurerelayreceivercontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (AzureRelayReceiver Control)

This property tells the control whether or not to automatically detect and use proxy system settings, if available.

Syntax

azurerelayreceivercontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (AzureRelayReceiver Control)

This property contains a password if authentication is to be used for the proxy.

Syntax

azurerelayreceivercontrol.ProxyPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

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

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

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

Data Type

String

ProxyPort Property (AzureRelayReceiver Control)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

azurerelayreceivercontrol.ProxyPort[=integer]

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.ProxyServer[=string]

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (AzureRelayReceiver Control)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

azurerelayreceivercontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

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

psAutomatic (0)Default setting. If the URL is an https URL, the control will use the psTunnel option. If the URL is an http URL, the control will use the psNever option.
psAlways (1)The connection is always SSL enabled.
psNever (2)The connection is not SSL enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (AzureRelayReceiver Control)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

azurerelayreceivercontrol.ProxyUser[=string]

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (AzureRelayReceiver Control)

This is the certificate (PEM/base64 encoded).

Syntax

azurerelayreceivercontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (AzureRelayReceiver Control)

This is the certificate (PEM/base64 encoded).

Syntax

azurerelayreceivercontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AzureRelayReceiver Control)

This is the name of the certificate store for the client certificate.

Syntax

azurerelayreceivercontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform-dependent.

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

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.SSLCertStorePassword[=string]

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

This is the type of certificate store for this certificate.

Syntax

azurerelayreceivercontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used the control will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (AzureRelayReceiver Control)

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

Syntax

azurerelayreceivercontrol.SSLCertSubject[=string]

Default Value

""

Remarks

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

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (AzureRelayReceiver Control)

This specifies the SSL/TLS implementation to use.

Syntax

azurerelayreceivercontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

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 control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

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

Additional Notes

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

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (AzureRelayReceiver Control)

This is the certificate (PEM/base64 encoded).

Syntax

azurerelayreceivercontrol.SSLServerCertEncoded

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

Config Method (AzureRelayReceiver Control)

Sets or retrieves a configuration setting.

Syntax

azurerelayreceivercontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 (AzureRelayReceiver Control)

This method disconnects the specified client.

Syntax

azurerelayreceivercontrol.Disconnect ConnectionId

Remarks

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

DoEvents Method (AzureRelayReceiver Control)

Processes events from the internal message queue.

Syntax

azurerelayreceivercontrol.DoEvents 

Remarks

When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (AzureRelayReceiver Control)

Interrupts a synchronous send to the remote host.

Syntax

azurerelayreceivercontrol.Interrupt ConnectionId

Remarks

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

PauseData Method (AzureRelayReceiver Control)

This method pauses data reception.

Syntax

azurerelayreceivercontrol.PauseData ConnectionId

Remarks

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

ProcessData Method (AzureRelayReceiver Control)

This method reenables data reception after a call to PauseData .

Syntax

azurerelayreceivercontrol.ProcessData ConnectionId

Remarks

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

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

Send Method (AzureRelayReceiver Control)

Sends binary data to the client.

Syntax

azurerelayreceivercontrol.Send ConnectionId, Data

Remarks

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

SendBytes Method (AzureRelayReceiver Control)

This method sends binary data to the specified client.

Syntax

azurerelayreceivercontrol.SendBytes ConnectionId, Data

Remarks

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

When AzureRelayConnectionTimeout is set to 0, the control 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 25036: "[10035] Operation would block" (WSAEWOULDBLOCK). You can trap this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

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

SendFile Method (AzureRelayReceiver Control)

This method sends the file to the remote host.

Syntax

azurerelayreceivercontrol.SendFile ConnectionId, FileName

Remarks

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

SendHTTPResponse Method (AzureRelayReceiver Control)

Send the HTTP response.

Syntax

azurerelayreceivercontrol.SendHTTPResponse ConnectionId, StatusCode, StatusDescription, ResponseData

Remarks

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

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

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

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

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

Code Example (HTTP)

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

SendText Method (AzureRelayReceiver Control)

Sends text data to the client.

Syntax

azurerelayreceivercontrol.SendText ConnectionId, Text

Remarks

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

When AzureRelayConnectionTimeout is set to 0, the control 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 25036: "[10035] Operation would block" (WSAEWOULDBLOCK). You can trap this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

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

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

Shutdown Method (AzureRelayReceiver Control)

This method shuts down the server.

Syntax

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

StartListening Method (AzureRelayReceiver Control)

Starts listening for incoming connections.

Syntax

azurerelayreceivercontrol.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:

StopListening Method (AzureRelayReceiver Control)

This method stops listening for new connections.

Syntax

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

Connected Event (AzureRelayReceiver Control)

Fired immediately after a connection completes (or fails).

Syntax

Sub azurerelayreceivercontrol_Connected(StatusCode As Integer, Description As String)

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 TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

ConnectionConnected Event (AzureRelayReceiver Control)

Fired when a client has connected.

Syntax

Sub azurerelayreceivercontrol_ConnectionConnected(ConnectionId As Integer)

Remarks

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

ConnectionId identifies the connection.

ConnectionDataIn Event (AzureRelayReceiver Control)

Fired when data is received.

Syntax

Sub azurerelayreceivercontrol_ConnectionDataIn(ConnectionId As Integer, DataFormat As Integer, Text As String, EOM As Boolean)

Remarks

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

The incoming data is provided through the Text parameter.

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

0 If LineMode is disabled, a value of 0 indicates a continuation packet. If LineMode is enabled the value will always be 0, regardless of packet type.
1 The data is UTF-8 encoded.
2 The data is binary and has no encoding.

The EOM parameter stands for End Of Message. By default the control will fire the DataIn event as data is 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 control 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 false if the DataIn event fired because MaxLineLength was reached.

ConnectionDisconnected Event (AzureRelayReceiver Control)

Fired when a WebSocket connection is disconnected.

Syntax

Sub azurerelayreceivercontrol_ConnectionDisconnected(ConnectionId As Integer, StatusCode As Integer, Description As String)

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:

1000 (default) Normal closure.
1001 The resource is going away. For instance the server is shutting down or a browser is navigating away from the page.
1002 A protocol error occurred.
1003 Unexpected data was received (e.g., an endpoint that only accepts text data could send this if binary data is received).
1007 Invalid payload data was received (e.g., an endpoint that receives non-UTF-8 data in a text message could send this).
1008 A generic code that indicates the endpoint received a message that violates its policy.
1009 A message that was too large was received.
1010 A required extension could not be negotiated.
1011 An unexpected error occurred.

ConnectionError Event (AzureRelayReceiver Control)

Information about errors during data delivery.

Syntax

Sub azurerelayreceivercontrol_ConnectionError(ConnectionId As Integer, ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control 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 Control)

Fired when the control is ready to send data.

Syntax

Sub azurerelayreceivercontrol_ConnectionReadyToSend(ConnectionId As Integer)

Remarks

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

ConnectionRequest Event (AzureRelayReceiver Control)

Fires when a WebSocket connection is requested.

Syntax

Sub azurerelayreceivercontrol_ConnectionRequest(Accept As Boolean, RendezvousAddress As String, Id As String, ConnectHeaders As String, SubProtocols As String, Extensions As String, Host As String, RemoteAddress As String, RemotePort As Integer, StatusCode As Integer, StatusDescription As String)

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

Fired to indicate changes in connection state.

Syntax

Sub azurerelayreceivercontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)

Remarks

The ConnectionStatus event is fired when the connection state changes: completion of a firewall or proxy connection, completion of a security handshake, etc.

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

Firewall connection complete.
SSL handshake complete (where applicable).
WebSocket handshake complete.
Remote host connection complete.
Remote host disconnected.
WebSocket connection broken.
SSL connection broken.
Firewall host disconnected.

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Disconnected Event (AzureRelayReceiver Control)

This event is fired when a connection is closed.

Syntax

Sub azurerelayreceivercontrol_Disconnected(StatusCode As Integer, Description As String)

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

Error Event (AzureRelayReceiver Control)

Information about errors during data delivery.

Syntax

Sub azurerelayreceivercontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control 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.

Header Event (AzureRelayReceiver Control)

This event is fired every time a header line comes in.

Syntax

Sub azurerelayreceivercontrol_Header(Field As String, Value As String)

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

Fires when an HTTP request is received.

Syntax

Sub azurerelayreceivercontrol_HTTPRequest(ConnectionId As Integer, RendezvousAddress As String, Id As String, RequestHeaders As String, RequestTarget As String, RequestMethod As String, Host As String, RemoteAddress As String, RemotePort As Integer, RequestData As String)

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 control 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 Control)

Fires once for each log message.

Syntax

Sub azurerelayreceivercontrol_Log(ConnectionId As Integer, LogLevel As Integer, Message As String, LogType As String)

Remarks

This event fires once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are:

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

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:

  • "Info"
  • "Error"
  • "Verbose"
  • "Debug"
ConnectionId specifies the Id of the connection to which the log applies.

Redirect Event (AzureRelayReceiver Control)

This event is fired when a redirection is received from the server.

Syntax

Sub azurerelayreceivercontrol_Redirect(Location As String, Accept As Boolean)

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 control 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 Control)

Fired after the server presents its certificate to the client.

Syntax

Sub azurerelayreceivercontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

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

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

SSLStatus Event (AzureRelayReceiver Control)

Shows the progress of the secure connection.

Syntax

Sub azurerelayreceivercontrol_SSLStatus(Message As String)

Remarks

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

Config Settings (AzureRelayReceiver Control)

The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

AzureRelayReceiver Config Settings

AccessToken:   Returns an access token for use outside of the components.

This setting returns an access token suitable for use in the HTTP Authorization header of a request. This is useful when a separate HTTP client is used to make a HTTP request to the relay service. The value returned by this setting can be set directly as the value for the Authorization header.

The value will be in the format:

SharedAccessSignature sr=sb%3a%2f%2fnstest.servicebus.windows.net%2fhc1&sig=a2EjYWw%2fDlg%2bPcNb%2fC7%2fxBbM11JjfgdO6ZVsQRm18Gg%3d&se=1555368805&skn=RootManageSharedAccessKey

AutoRenewThreshold:   The threshold in seconds after which the token is renewed.

This setting specifies a threshold used by the control to determine when to automatically renew the listener token while connected to the Azure Relay service.

When connected to the Azure Relay a Shared Access Token grants access to the service. After TokenValidity seconds this token will expire. To prevent disconnection the control will automatically renew the token once the remaining seconds on the life of the token is below this threshold.

For instance if AutoRenewThreshold is set to 100 (seconds). Once the control token is valid for only 99 seconds it will be automatically renewed.

The default value is 300 (seconds).

AzureRelayKeepAliveTime:   The inactivity period in seconds before a ping packet is sent to keep the connection alive.

This setting specifies the inactivity period in seconds after which a ping packet is sent on the control channel to keep the connection to the Azure Relay Service alive.

The default value is 0 (disabled).

Note: This functionality is not yet supported

DiagnosticId:   A diagnostic id used to enable end-to-end tracing.

This setting optionally specifies a diagnostic Id that is associated with the control connection established to the Azure Relay server when Listening is set to True. If set, this allows end-to-end tracing of the connection for diagnostic purposes. If specified this should be a GUID. For instance f479cece-a32d-4caf-aed3-6dcc3b7b661e.

LogLevel:   The level of detail that is logged.

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

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

The value 1 (Info) logs basic information about the connection and connecting clients.

The value 2 (Verbose) logs detailed information about each connection and the control connection.

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

TokenValidity:   The validity time in seconds of the access token.

This setting specifies the validity time of the access token to create when authenticating. The default value is 3600 seconds.

WebSocketServer Config Settings

BufferMessage:   Indicates whether or not the entire message is buffered before firing the DataIn event.

When receiving large messages the DataIn event may fire multiple times to provide data as it is received in each message fragment. When BufferMessage is set to True the control will internally buffer the message as it is received until it is complete before firing the DataIn event. The default value is False.

DisconnectStatusCode:   Specifies the status code when closing a connection.

When the Disconnect method is called the control will send the status code specified here. By default the value is 1000 which indicates a normal closure. Any other value represents an error condition. You may set any value you wish, however the protocol defines the following common values.

1000 (default) Normal closure.
1001 The resource is going away. For instance the server is shutting down or a browser is navigating away from the page.
1002 A protocol error occurred.
1003 Unexpected data was received (e.g., an endpoint that only accepts text data could send this if binary data is received).
1007 Invalid payload data was received (e.g., an endpoint that receives non-UTF-8 data in a text message could send this).
1008 A generic code that indicates the endpoint received a message that violates its policy.
1009 A message that was too large was received.
1010 A required extension could not be negotiated.
1011 An unexpected error occurred.

DisconnectStatusDescription:   Specifies the message associated with the disconnect status code.

This setting may be used to provide a textual description of the status code sent when closing the connection. This setting works in conjunction with DisconnectStatusCode. For any of the standard codes listed in DisconnectStatusCode the control will use a default description that may be overridden with this setting. For any non-standard codes that are not listed, this setting should be set or no description will be sent.

MaxFrameSize:   Specifies the maximum size of the outgoing message in bytes before fragmentation occurs.

This setting specifies the maximum size of the outgoing message in bytes before fragmentation will occur. When a message that is larger than MaxFrameSize is sent, it will be broken into fragments with the maximum size specified here. The default value is 131072 (128K).

When a message is fragmented, the receiving side may check the EOM parameter of the DataIn event to determine when the message is complete.

Note: When Timeout is set to 0 messages that are fragmented are always sent as individual smaller messages and EOM will always be True in the DataIn event on the receiving side.

MessageLength[ConnectionId]:   The length of the message (in bytes) when sending asynchronously.

This setting specifies the length of messages being sent when operating asynchronously.

When DefaultTimeout is set to 0 the control operates asynchronously and by default all data sent when Send is called or AzureRelayConnectionDataToSend is set is considered a complete message. Each packet leaving the control has the End-of-Message flag set.

To send messages which may be fragmented, set MessageLength to the length of the message (in bytes) that is being sent. When set the control will consider the next MessageLength bytes sent as part of a single message and only the last packet will set the End-of-Message flag.

This setting is helpful when data is organized into messages and the receiving side expected the End-of-Message flag to signal the end of a message.

Note: This setting is only applicable when DefaultTimeout is set to 0. When DefaultTimeout is set to a positive value the message data may be passed in its entirety to AzureRelayConnectionDataToSend or Send and will be automatically handled as needed by the control.

WaitForCloseResponse:   Determines whether or not the control will forcibly close a connection.

When true (default) the control will wait for a response from the client when closing the connection. When this setting is set to false, the control will forcibly close the connection without waiting for a response from the client.

TCPServer Config Settings

AllowedClients:   A comma-separated list of host names or IP addresses that can access the control.

This configuration setting defines a comma-separated list of host names or IPv4 addresses that may access the control. The wildcard character "*" is supported. The default value is "*" and all connections are accepted.

When a client connects, the client's address is checked against the list defined here. If there is no match, the ConnectionRequest event fires with an Accept value set to False. If no action is taken within the ConnectionRequest event, the client will be disconnected.

BindExclusively:   Whether or not the component considers a local port reserved for exclusive use.

If this is True (default), the component will bind to the local port with the ExclusiveAddressUse option set, meaning that nothing else can bind to the same port. Also the component will not be able to bind to local ports that are already in use by some other instance, and attempts to do so will result in failure.

BlockedClients:   A comma-separated list of host names or IP addresses that cannot access the control.

This configuration setting defines a comma-separated list of host names or IPv4 addresses that cannot access the control.The default value is "" and all connections are accepted.

When a client connects, the client's address is checked against the list defined here. If there is a match, the ConnectionRequest event fires with an Accept value set to False. If no action is taken within the ConnectionRequest event, the client will not be connected.

DefaultConnectionTimeout:   The inactivity timeout applied to the SSL handshake.

This configuration setting specifies the inactivity (in seconds) to apply to incoming Secure Sockets Layer (SSL) connections. When set to a positive value, if the other end is unresponsive for the specified number of seconds, the connection will timeout. This is not applicable to the entire handshake. It is applicable only to the inactivity of the connecting client during the handshake if a response is expected and none is received within the timeout window. The default value is 0, and no connection-specific timeout is applied.

Note: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so.

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

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

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

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

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

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

Note: This value is not applicable in macOS.

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

By default, the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. If this value is not specified here, the system default is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. This setting is applicable to all connections.

MaxConnections:   The maximum number of connections available.

This is the maximum number of connections available. This property must be set before Listening is set to True, and once set, it can no longer be changed for the current instance of the control. The maximum value for this setting is 100,000 connections. Use this setting with caution. Extremely large values may affect performance. The default value is 1000.

Note: Unix/Linux operating systems limit the number of simultaneous connections to 1024.

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

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

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

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

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the control will use IPv4 exclusively. When set to 1, the control will use IPv6 exclusively. When set to 2, the control will listen for both IPv4 and IPv6 connections. If IPv6 is not available on the system, only IPv4 will be used. The default value is 0. Possible values are as follows:

0 IPv4 Only
1 IPv6 Only
2 IPv6 and IPv4

SSL Config Settings

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

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

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

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

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

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

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

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

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

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

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

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

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

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

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

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

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

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

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

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

When set to 0 (default) the CRL check will not be performed by the control. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

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

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

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

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

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

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

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

The enabled cipher suites to be used in SSL negotiation.

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

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

Multiple cipher suites are separated by semicolons.

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

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

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

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

Used to enable/disable the supported security protocols.

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

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

SSLEnabledProtocols - TLS 1.3 Notes

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

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

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

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

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

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

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

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

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

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

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

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

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

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

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

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

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength.

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

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

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite.

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

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

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

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

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

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

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

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

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

SSLSecurityFlags:   Flags that control certificate verification.

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

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

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

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

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

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

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

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

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

When specified the control will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the control fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: TCPClient.SSLProvider = TCPClientSSLProviders.sslpInternal; TCPClient.Config("SSLEnabledProtocols=3072"); //TLS 1.2 TCPClient.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

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

TLS12SupportedGroups:   The supported groups for ECC.

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

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

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

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

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

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

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

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

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

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

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

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

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

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

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

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

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

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

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

Trappable Errors (AzureRelayReceiver Control)

WebSocketServer Errors

24203    Error sending data to the connected client.

TCPServer Errors

20101    You cannot change the RemotePort at this time. A connection is in progress.
20102    You cannot change the RemoteHost at this time. A connection is in progress.
20103    The RemoteHost address is invalid (0.0.0.0).
20105    TCPServer is already listening.
20107    Cannot change LocalPort when TCPServer is listening.
20108    Cannot change LocalHost when TCPServer is listening.
20109    Cannot change MaxConnections when TCPServer is listening.
20113    You cannot change MaxLineLength at this time. A connection is in progress.
20117    RemotePort cannot be zero. Please specify a valid service port number.
20127    Invalid ConnectionId.
20136    Operation would block.

SSL Errors

20271    Cannot load specified security library.
20272    Cannot open certificate store.
20273    Cannot find specified certificate.
20274    Cannot acquire security credentials.
20275    Cannot find certificate chain.
20276    Cannot verify certificate chain.
20277    Error during handshake.
20281    Error verifying certificate.
20282    Could not find client certificate.
20283    Could not find server certificate.
20284    Error encrypting data.
20285    Error decrypting data.

TCP/IP Errors

25005    [10004] Interrupted system call.
25010    [10009] Bad file number.
25014    [10013] Access denied.
25015    [10014] Bad address.
25023    [10022] Invalid argument.
25025    [10024] Too many open files.
25036    [10035] Operation would block.
25037    [10036] Operation now in progress.
25038    [10037] Operation already in progress.
25039    [10038] Socket operation on non-socket.
25040    [10039] Destination address required.
25041    [10040] Message too long.
25042    [10041] Protocol wrong type for socket.
25043    [10042] Bad protocol option.
25044    [10043] Protocol not supported.
25045    [10044] Socket type not supported.
25046    [10045] Operation not supported on socket.
25047    [10046] Protocol family not supported.
25048    [10047] Address family not supported by protocol family.
25049    [10048] Address already in use.
25050    [10049] Can't assign requested address.
25051    [10050] Network is down.
25052    [10051] Network is unreachable.
25053    [10052] Net dropped connection or reset.
25054    [10053] Software caused connection abort.
25055    [10054] Connection reset by peer.
25056    [10055] No buffer space available.
25057    [10056] Socket is already connected.
25058    [10057] Socket is not connected.
25059    [10058] Can't send after socket shutdown.
25060    [10059] Too many references, can't splice.
25061    [10060] Connection timed out.
25062    [10061] Connection refused.
25063    [10062] Too many levels of symbolic links.
25064    [10063] File name too long.
25065    [10064] Host is down.
25066    [10065] No route to host.
25067    [10066] Directory not empty
25068    [10067] Too many processes.
25069    [10068] Too many users.
25070    [10069] Disc Quota Exceeded.
25071    [10070] Stale NFS file handle.
25072    [10071] Too many levels of remote in path.
25092    [10091] Network subsystem is unavailable.
25093    [10092] WINSOCK DLL Version out of range.
25094    [10093] Winsock not loaded yet.
26002    [11001] Host not found.
26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
26005    [11004] Valid name, no data record (check DNS setup).

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