AzureRelayReceiver Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.IPWorksMQ.Azurerelayreceiver

Remarks

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

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

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

Handling Connections

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

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

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

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

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

Handling HTTP Connections

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

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

Forwarding Connections

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

Method List

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

Event List

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

Config Settings

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

AccessKey Property (AzureRelayReceiver Component)

The Shared Access Key.

Syntax

• C#
• VB.NET

public string AccessKey { get; set; }

Public Property AccessKey As 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=.

AccessKeyName Property (AzureRelayReceiver Component)

The Shared Access Key Name.

Syntax

• C#
• VB.NET

public string AccessKeyName { get; set; }

Public Property AccessKeyName As 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.

Connected Property (AzureRelayReceiver Component)

This shows whether the component is connected.

Syntax

• C#
• VB.NET

public bool Connected { get; set; }

Public Property Connected As Boolean

Default Value

False

Remarks

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

Connections Property (AzureRelayReceiver Component)

A collection of currently connected clients.

Syntax

• C#
• VB.NET

public AzureRelayConnectionMap Connections { get; }

Public ReadOnly Property Connections As AzureRelayConnectionMap

Remarks

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

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

This property is read-only.

DefaultTimeout Property (AzureRelayReceiver Component)

An initial timeout value to be used by incoming connections.

Syntax

• C#
• VB.NET

public int DefaultTimeout { get; set; }

Public Property DefaultTimeout As Integer

Default Value

0

Remarks

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

If DefaultTimeout is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If DefaultTimeout is set to a positive value, the component will wait for the operation to complete before returning control.

Firewall Property (AzureRelayReceiver Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

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

ForwardingHost Property (AzureRelayReceiver Component)

The address to which traffic will automatically be forwarded.

Syntax

• C#
• VB.NET

public string ForwardingHost { get; set; }

Public Property ForwardingHost As 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 component 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.

ForwardingPort Property (AzureRelayReceiver Component)

The port to which traffic will automatically be forwarded.

Syntax

• C#
• VB.NET

public int ForwardingPort { get; set; }

Public Property ForwardingPort As 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 component 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.

HybridConnection Property (AzureRelayReceiver Component)

The hybrid connection name.

Syntax

• C#
• VB.NET

public string HybridConnection { get; set; }

Public Property HybridConnection As String

Default Value

""

Remarks

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

Listening Property (AzureRelayReceiver Component)

If , the component is listening for incoming connections.

Syntax

• C#
• VB.NET

public bool Listening { get; set; }

Public Property Listening As Boolean

Default Value

False

Remarks

This setting indicates whether the component accepts incoming connections. When true the component 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 component is listening.

This property is not available at design time.

LocalHost Property (AzureRelayReceiver Component)

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

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As 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 component initiate connections (or accept in the case of server components) only through that interface.

If the component 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.

NamespaceAddress Property (AzureRelayReceiver Component)

The namespace address of the relay.

Syntax

• C#
• VB.NET

public string NamespaceAddress { get; set; }

Public Property NamespaceAddress As String

Default Value

""

Remarks

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

Proxy Property (AzureRelayReceiver Component)

This property includes a set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

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

SSLAcceptServerCert Property (AzureRelayReceiver Component)

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

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

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

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

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

SSLCert Property (AzureRelayReceiver Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

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

SSLProvider Property (AzureRelayReceiver Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public AzurerelayreceiverSSLProviders SSLProvider { get; set; }

enum AzurerelayreceiverSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As AzurerelayreceiverSSLProviders

Enum AzurerelayreceiverSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

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

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

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (AzureRelayReceiver Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Config Method (AzureRelayReceiver Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

This method disconnects the specified client.

Syntax

• C#
• VB.NET

public void Disconnect(string connectionId);

Async Version
public async Task Disconnect(string connectionId);
public async Task Disconnect(string connectionId, CancellationToken cancellationToken);

Public Sub Disconnect(ByVal ConnectionId As String)

Async Version
Public Sub Disconnect(ByVal ConnectionId As String) As Task
Public Sub Disconnect(ByVal ConnectionId As String, cancellationToken As CancellationToken) As Task

Remarks

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

DoEvents Method (AzureRelayReceiver Component)

Processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

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

Interrupt Method (AzureRelayReceiver Component)

Interrupts a synchronous send to the remote host.

Syntax

• C#
• VB.NET

public void Interrupt(string connectionId);

Async Version
public async Task Interrupt(string connectionId);
public async Task Interrupt(string connectionId, CancellationToken cancellationToken);

Public Sub Interrupt(ByVal ConnectionId As String)

Async Version
Public Sub Interrupt(ByVal ConnectionId As String) As Task
Public Sub Interrupt(ByVal ConnectionId As String, cancellationToken As CancellationToken) As Task

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 component. If you use SendFile to upload a file, the component will run synchronously on that Connection ID until it is completed.

PauseData Method (AzureRelayReceiver Component)

This method pauses data reception.

Syntax

• C#
• VB.NET

public void PauseData(string connectionId);

Async Version
public async Task PauseData(string connectionId);
public async Task PauseData(string connectionId, CancellationToken cancellationToken);

Public Sub PauseData(ByVal ConnectionId As String)

Async Version
Public Sub PauseData(ByVal ConnectionId As String) As Task
Public Sub PauseData(ByVal ConnectionId As String, cancellationToken As CancellationToken) As Task

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

This method reenables data reception after a call to PauseData

Syntax

• C#
• VB.NET

public void ProcessData(string connectionId);

Async Version
public async Task ProcessData(string connectionId);
public async Task ProcessData(string connectionId, CancellationToken cancellationToken);

Public Sub ProcessData(ByVal ConnectionId As String)

Async Version
Public Sub ProcessData(ByVal ConnectionId As String) As Task
Public Sub ProcessData(ByVal ConnectionId As String, cancellationToken As CancellationToken) As Task

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

Sends binary data to the client.

Syntax

• C#
• VB.NET

public void Send(string connectionId, byte[] data);

Async Version
public async Task Send(string connectionId, byte[] data);
public async Task Send(string connectionId, byte[] data, CancellationToken cancellationToken);

Public Sub Send(ByVal ConnectionId As String, ByVal Data As String)

Async Version
Public Sub Send(ByVal ConnectionId As String, ByVal Data As String) As Task
Public Sub Send(ByVal ConnectionId As String, ByVal Data As String, cancellationToken As CancellationToken) As Task

Remarks

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

SendBytes Method (AzureRelayReceiver Component)

This method sends binary data to the specified client.

Syntax

• C#
• VB.NET

public void SendBytes(string connectionId, byte[] data);

Async Version
public async Task SendBytes(string connectionId, byte[] data);
public async Task SendBytes(string connectionId, byte[] data, CancellationToken cancellationToken);

Public Sub SendBytes(ByVal ConnectionId As String, ByVal Data As String)

Async Version
Public Sub SendBytes(ByVal ConnectionId As String, ByVal Data As String) As Task
Public Sub SendBytes(ByVal ConnectionId As String, ByVal Data As String, cancellationToken As CancellationToken) As Task

Remarks

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

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

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

When SSLEnabled is True or Timeout is set to a positive value, the component behaves synchronously.

SendFile Method (AzureRelayReceiver Component)

This method sends the file to the remote host.

Syntax

• C#
• VB.NET

public void SendFile(string connectionId, string fileName);

Async Version
public async Task SendFile(string connectionId, string fileName);
public async Task SendFile(string connectionId, string fileName, CancellationToken cancellationToken);

Public Sub SendFile(ByVal ConnectionId As String, ByVal FileName As String)

Async Version
Public Sub SendFile(ByVal ConnectionId As String, ByVal FileName As String) As Task
Public Sub SendFile(ByVal ConnectionId As String, ByVal FileName As String, cancellationToken As CancellationToken) As Task

Remarks

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

Note: This method operate synchronously. DefaultTimeout or Timeout must be set to a positive value before calling this method.

SendHTTPResponse Method (AzureRelayReceiver Component)

Send the HTTP response.

Syntax

• C#
• VB.NET

public void SendHTTPResponse(string connectionId, int statusCode, string statusDescription, byte[] responseData);

Async Version
public async Task SendHTTPResponse(string connectionId, int statusCode, string statusDescription, byte[] responseData);
public async Task SendHTTPResponse(string connectionId, int statusCode, string statusDescription, byte[] responseData, CancellationToken cancellationToken);

Public Sub SendHTTPResponse(ByVal ConnectionId As String, ByVal StatusCode As Integer, ByVal StatusDescription As String, ByVal ResponseData As String)

Async Version
Public Sub SendHTTPResponse(ByVal ConnectionId As String, ByVal StatusCode As Integer, ByVal StatusDescription As String, ByVal ResponseData As String) As Task
Public Sub SendHTTPResponse(ByVal ConnectionId As String, ByVal StatusCode As Integer, ByVal StatusDescription As String, ByVal ResponseData As String, cancellationToken As CancellationToken) As Task

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

Sends text data to the client.

Syntax

• C#
• VB.NET

public void SendText(string connectionId, string text);

Async Version
public async Task SendText(string connectionId, string text);
public async Task SendText(string connectionId, string text, CancellationToken cancellationToken);

Public Sub SendText(ByVal ConnectionId As String, ByVal Text As String)

Async Version
Public Sub SendText(ByVal ConnectionId As String, ByVal Text As String) As Task
Public Sub SendText(ByVal ConnectionId As String, ByVal Text As String, cancellationToken As CancellationToken) As Task

Remarks

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

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

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

When SSLEnabled is True or Timeout is set to a positive value, the component behaves synchronously.

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

SetUploadStream Method (AzureRelayReceiver Component)

This method uploads the data in the specified stream.

Syntax

• C#
• VB.NET

public void SetUploadStream(string connectionId, System.IO.Stream stream);

Async Version
public async Task SetUploadStream(string connectionId, System.IO.Stream stream);
public async Task SetUploadStream(string connectionId, System.IO.Stream stream, CancellationToken cancellationToken);

Public Sub SetUploadStream(ByVal ConnectionId As String, ByVal Stream As System.IO.Stream)

Async Version
Public Sub SetUploadStream(ByVal ConnectionId As String, ByVal Stream As System.IO.Stream) As Task
Public Sub SetUploadStream(ByVal ConnectionId As String, ByVal Stream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method uploads the data in the specified stream to the connection identified by ConnectionId. The component will automatically close this stream if CloseStreamAfterTransfer is true (default).

Shutdown Method (AzureRelayReceiver Component)

This method shuts down the server.

Syntax

• C#
• VB.NET

public void Shutdown();

Async Version
public async Task Shutdown();
public async Task Shutdown(CancellationToken cancellationToken);

Public Sub Shutdown()

Async Version
Public Sub Shutdown() As Task
Public Sub Shutdown(cancellationToken As CancellationToken) As Task

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

Starts listening for incoming connections.

Syntax

• C#
• VB.NET

public void StartListening();

Async Version
public async Task StartListening();
public async Task StartListening(CancellationToken cancellationToken);

Public Sub StartListening()

Async Version
Public Sub StartListening() As Task
Public Sub StartListening(cancellationToken As CancellationToken) As Task

Remarks

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

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

The following properties are applicable when calling this method:

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

StopListening Method (AzureRelayReceiver Component)

This method stops listening for new connections.

Syntax

• C#
• VB.NET

public void StopListening();

Async Version
public async Task StopListening();
public async Task StopListening(CancellationToken cancellationToken);

Public Sub StopListening()

Async Version
Public Sub StopListening() As Task
Public Sub StopListening(cancellationToken As CancellationToken) As Task

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

Fired immediately after the WebSocket handshake completes (or fails).

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, AzurerelayreceiverConnectedEventArgs e);

public class AzurerelayreceiverConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As AzurerelayreceiverConnectedEventArgs)

Public Class AzurerelayreceiverConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

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

Please refer to the Error Codes section for more information.

ConnectionConnected Event (AzureRelayReceiver Component)

Fired when a client has connected.

Syntax

• C#
• VB.NET

public event OnConnectionConnectedHandler OnConnectionConnected;

public delegate void OnConnectionConnectedHandler(object sender, AzurerelayreceiverConnectionConnectedEventArgs e);

public class AzurerelayreceiverConnectionConnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
}

Public Event OnConnectionConnected As OnConnectionConnectedHandler

Public Delegate Sub OnConnectionConnectedHandler(sender As Object, e As AzurerelayreceiverConnectionConnectedEventArgs)

Public Class AzurerelayreceiverConnectionConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
End Class

Remarks

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

ConnectionId identifies the connection.

ConnectionDataIn Event (AzureRelayReceiver Component)

Fired when data is received.

Syntax

• C#
• VB.NET

public event OnConnectionDataInHandler OnConnectionDataIn;

public delegate void OnConnectionDataInHandler(object sender, AzurerelayreceiverConnectionDataInEventArgs e);

public class AzurerelayreceiverConnectionDataInEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int DataFormat { get; }
  public string Text { get; }
  public byte[] TextB { get; }
  public bool EOM { get; }
}

Public Event OnConnectionDataIn As OnConnectionDataInHandler

Public Delegate Sub OnConnectionDataInHandler(sender As Object, e As AzurerelayreceiverConnectionDataInEventArgs)

Public Class AzurerelayreceiverConnectionDataInEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property DataFormat As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
  Public ReadOnly Property EOM As Boolean
End Class

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:

The EOM parameter stands for End Of Message. By default the component 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 component 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 Component)

Fired when a WebSocket connection is disconnected.

Syntax

• C#
• VB.NET

public event OnConnectionDisconnectedHandler OnConnectionDisconnected;

public delegate void OnConnectionDisconnectedHandler(object sender, AzurerelayreceiverConnectionDisconnectedEventArgs e);

public class AzurerelayreceiverConnectionDisconnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionDisconnected As OnConnectionDisconnectedHandler

Public Delegate Sub OnConnectionDisconnectedHandler(sender As Object, e As AzurerelayreceiverConnectionDisconnectedEventArgs)

Public Class AzurerelayreceiverConnectionDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

ConnectionError Event (AzureRelayReceiver Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnConnectionErrorHandler OnConnectionError;

public delegate void OnConnectionErrorHandler(object sender, AzurerelayreceiverConnectionErrorEventArgs e);

public class AzurerelayreceiverConnectionErrorEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnConnectionError As OnConnectionErrorHandler

Public Delegate Sub OnConnectionErrorHandler(sender As Object, e As AzurerelayreceiverConnectionErrorEventArgs)

Public Class AzurerelayreceiverConnectionErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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

Fired when the component is ready to send data.

Syntax

• C#
• VB.NET

public event OnConnectionReadyToSendHandler OnConnectionReadyToSend;

public delegate void OnConnectionReadyToSendHandler(object sender, AzurerelayreceiverConnectionReadyToSendEventArgs e);

public class AzurerelayreceiverConnectionReadyToSendEventArgs : EventArgs {
  public string ConnectionId { get; }
}

Public Event OnConnectionReadyToSend As OnConnectionReadyToSendHandler

Public Delegate Sub OnConnectionReadyToSendHandler(sender As Object, e As AzurerelayreceiverConnectionReadyToSendEventArgs)

Public Class AzurerelayreceiverConnectionReadyToSendEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
End Class

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

Fires when a WebSocket connection is requested.

Syntax

• C#
• VB.NET

public event OnConnectionRequestHandler OnConnectionRequest;

public delegate void OnConnectionRequestHandler(object sender, AzurerelayreceiverConnectionRequestEventArgs e);

public class AzurerelayreceiverConnectionRequestEventArgs : EventArgs {
  public bool Accept { get; set; }
  public string RendezvousAddress { get; }
  public string Id { get; }
  public string ConnectHeaders { get; }
  public string SubProtocols { get; }
  public string Extensions { get; }
  public string Host { get; }
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public int StatusCode { get; set; }
  public string StatusDescription { get; set; }
}

Public Event OnConnectionRequest As OnConnectionRequestHandler

Public Delegate Sub OnConnectionRequestHandler(sender As Object, e As AzurerelayreceiverConnectionRequestEventArgs)

Public Class AzurerelayreceiverConnectionRequestEventArgs Inherits EventArgs
  Public Property Accept As Boolean
  Public ReadOnly Property RendezvousAddress As String
  Public ReadOnly Property Id As String
  Public ReadOnly Property ConnectHeaders As String
  Public ReadOnly Property SubProtocols As String
  Public ReadOnly Property Extensions As String
  Public ReadOnly Property Host As String
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public Property StatusCode As Integer
  Public Property StatusDescription As String
End Class

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

Fired to indicate changes in connection state.

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, AzurerelayreceiverConnectionStatusEventArgs e);

public class AzurerelayreceiverConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As AzurerelayreceiverConnectionStatusEventArgs)

Public Class AzurerelayreceiverConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

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:

Disconnected Event (AzureRelayReceiver Component)

This event is fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, AzurerelayreceiverDisconnectedEventArgs e);

public class AzurerelayreceiverDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As AzurerelayreceiverDisconnectedEventArgs)

Public Class AzurerelayreceiverDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (AzureRelayReceiver Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, AzurerelayreceiverErrorEventArgs e);

public class AzurerelayreceiverErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As AzurerelayreceiverErrorEventArgs)

Public Class AzurerelayreceiverErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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

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

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, AzurerelayreceiverHeaderEventArgs e);

public class AzurerelayreceiverHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As AzurerelayreceiverHeaderEventArgs)

Public Class AzurerelayreceiverHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

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

Fires when an HTTP request is received.

Syntax

• C#
• VB.NET

public event OnHTTPRequestHandler OnHTTPRequest;

public delegate void OnHTTPRequestHandler(object sender, AzurerelayreceiverHTTPRequestEventArgs e);

public class AzurerelayreceiverHTTPRequestEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string RendezvousAddress { get; }
  public string Id { get; }
  public string RequestHeaders { get; }
  public string RequestTarget { get; }
  public string RequestMethod { get; }
  public string Host { get; }
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public string RequestData { get; }
  public byte[] RequestDataB { get; }
}

Public Event OnHTTPRequest As OnHTTPRequestHandler

Public Delegate Sub OnHTTPRequestHandler(sender As Object, e As AzurerelayreceiverHTTPRequestEventArgs)

Public Class AzurerelayreceiverHTTPRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property RendezvousAddress As String
  Public ReadOnly Property Id As String
  Public ReadOnly Property RequestHeaders As String
  Public ReadOnly Property RequestTarget As String
  Public ReadOnly Property RequestMethod As String
  Public ReadOnly Property Host As String
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public ReadOnly Property RequestData As String
  Public ReadOnly Property RequestDataB As Byte()
End Class

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 component 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 Component)

Fires once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, AzurerelayreceiverLogEventArgs e);

public class AzurerelayreceiverLogEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As AzurerelayreceiverLogEventArgs)

Public Class AzurerelayreceiverLogEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

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

LogLevel indicates the level of message. Possible values are:

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"

Redirect Event (AzureRelayReceiver Component)

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

Syntax

• C#
• VB.NET

public event OnRedirectHandler OnRedirect;

public delegate void OnRedirectHandler(object sender, AzurerelayreceiverRedirectEventArgs e);

public class AzurerelayreceiverRedirectEventArgs : EventArgs {
  public string Location { get; }
  public bool Accept { get; set; }
}

Public Event OnRedirect As OnRedirectHandler

Public Delegate Sub OnRedirectHandler(sender As Object, e As AzurerelayreceiverRedirectEventArgs)

Public Class AzurerelayreceiverRedirectEventArgs Inherits EventArgs
  Public ReadOnly Property Location As String
  Public Property Accept As Boolean
End Class

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 component throws an exception. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SSLServerAuthentication Event (AzureRelayReceiver Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, AzurerelayreceiverSSLServerAuthenticationEventArgs e);

public class AzurerelayreceiverSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As AzurerelayreceiverSSLServerAuthenticationEventArgs)

Public Class AzurerelayreceiverSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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

Shows the progress of the secure connection.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, AzurerelayreceiverSSLStatusEventArgs e);

public class AzurerelayreceiverSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As AzurerelayreceiverSSLStatusEventArgs)

Public Class AzurerelayreceiverSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

AzureRelayConnection Type

A currently connected client.

Remarks

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

Fields

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

Constructors

• C#
• VB.NET

public AzureRelayConnection();

Public AzureRelayConnection()

Certificate Type

This is the digital certificate being used.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Firewall Type

This is the firewall the component will connect through.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

Proxy Type

This is the proxy the component will connect to.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

Config Settings (AzureRelayReceiver Component)

AzureRelayReceiver Config Settings

WebSocketServer Config Settings

TCPServer Config Settings

SSL Config Settings

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

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

Trappable Errors (AzureRelayReceiver Component)

WebSocketServer Errors

TCPServer Errors

SSL Errors

TCP/IP Errors