AzureRelayReceiver Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class ipworksmq.AzureRelayReceiver

Remarks

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

Authenticating and Listening

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

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

• access_key (required)
• access_key_name (required)
• hybrid_connection (required)
• namespace_address (required)
• default_timeout
• forwarding_host
• forwarding_port

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

Handling Connections

When a connection is made the on_connection_request 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 on_connection_connected and on_connection_ready_to_send events fire when the connection completes and is ready to send and receive data.

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

To send data to the client set azure_relay_connection_data_to_send or call send, send_file, or send_text.

When the client disconnects the on_connection_disconnected 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 on_http_request event fires with information about the request including the request body. Save the ConnectionId value obtained within on_http_request for use with send_http_response.

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

Forwarding Connections

The class supports forwarding incoming connection to a separate destination. This functionality allows AzureRelayReceiver to act as a proxy for incoming requests. When forwarding_host and forwarding_port are set anytime a connection is made the class will establish a separate connection to the forwarding_host and forward all incoming traffic. Responses from the forwarding_host 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 forwarding_host.

Note: Forwarding is not supported for HTTP requests.

Code Example (WebSockets)

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

Code Example (HTTP)

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

Property List

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

Method List

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

Event List

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

Config Settings

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

access_key Property

The Shared Access Key.

Syntax

def get_access_key() -> str: ...
def set_access_key(value: str) -> None: ...

access_key = property(get_access_key, set_access_key)

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

access_key_name Property

The Shared Access Key Name.

Syntax

def get_access_key_name() -> str: ...
def set_access_key_name(value: str) -> None: ...

access_key_name = property(get_access_key_name, set_access_key_name)

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

This shows whether the class is connected.

Syntax

def get_connected() -> bool: ...
def set_connected(value: bool) -> None: ...

connected = property(get_connected, set_connected)

Default Value

FALSE

Remarks

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

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

azure_relay_connection_count Property

The number of records in the AzureRelayConnection arrays.

Syntax

def get_azure_relay_connection_count() -> int: ...

azure_relay_connection_count = property(get_azure_relay_connection_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• azure_relay_connection_accept_data
• azure_relay_connection_address
• azure_relay_connection_bytes_sent
• azure_relay_connection_connected
• azure_relay_connection_connect_headers
• azure_relay_connection_connection_id
• azure_relay_connection_data_format
• azure_relay_connection_data_to_send
• azure_relay_connection_extensions
• azure_relay_connection_host
• azure_relay_connection_id
• azure_relay_connection_ready_to_send
• azure_relay_connection_remote_address
• azure_relay_connection_remote_port
• azure_relay_connection_sub_protocols
• azure_relay_connection_timeout

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

This property is read-only.

azure_relay_connection_accept_data Property

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

Syntax

def get_azure_relay_connection_accept_data(connection_id: int) -> bool: ...
def set_azure_relay_connection_accept_data(connection_id: int, value: bool) -> None: ...

Default Value

TRUE

Remarks

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

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

azure_relay_connection_address Property

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

Syntax

def get_azure_relay_connection_address(connection_id: int) -> str: ...

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 connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is read-only.

azure_relay_connection_bytes_sent Property

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

Syntax

def get_azure_relay_connection_bytes_sent(connection_id: int) -> int: ...

Default Value

0

Remarks

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

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

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is read-only.

azure_relay_connection_connected Property

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

Syntax

def get_azure_relay_connection_connected(connection_id: int) -> bool: ...
def set_azure_relay_connection_connected(connection_id: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

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

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

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

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

azure_relay_connection_connect_headers Property

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

Syntax

def get_azure_relay_connection_connect_headers(connection_id: int) -> str: ...

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 connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is read-only.

azure_relay_connection_connection_id Property

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

Syntax

def get_azure_relay_connection_connection_id(connection_id: int) -> str: ...

Default Value

""

Remarks

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

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is read-only.

azure_relay_connection_data_format Property

The format of the data being sent.

Syntax

def get_azure_relay_connection_data_format(connection_id: int) -> int: ...
def set_azure_relay_connection_data_format(connection_id: int, value: int) -> None: ...

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:

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

azure_relay_connection_data_to_send Property

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

Syntax

def set_azure_relay_connection_data_to_send(connection_id: int, value: bytes) -> None: ...

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 azure_relay_connection_data_to_send makes the class send the string to the remote host. The send method provides similar functionality.

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

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

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is write-only.

azure_relay_connection_extensions Property

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

Syntax

def get_azure_relay_connection_extensions(connection_id: int) -> str: ...

Default Value

""

Remarks

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

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is read-only.

azure_relay_connection_host Property

The Host header value of the connected client.

Syntax

def get_azure_relay_connection_host(connection_id: int) -> str: ...

Default Value

""

Remarks

The Host header value of the connected client.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is read-only.

azure_relay_connection_id Property

This property holds the Id of the connection.

Syntax

def get_azure_relay_connection_id(connection_id: int) -> str: ...

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 connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is read-only.

azure_relay_connection_ready_to_send Property

This indicates whether the class is ready to send data.

Syntax

def get_azure_relay_connection_ready_to_send(connection_id: int) -> bool: ...

Default Value

FALSE

Remarks

This indicates whether the class 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 azure_relay_connection_data_to_send.

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

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is read-only.

azure_relay_connection_remote_address Property

This property holds the IP address of the connecting client.

Syntax

def get_azure_relay_connection_remote_address(connection_id: int) -> str: ...

Default Value

""

Remarks

This property holds the IP address of the connecting client.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is read-only.

azure_relay_connection_remote_port Property

This property holds the port of the connecting client.

Syntax

def get_azure_relay_connection_remote_port(connection_id: int) -> int: ...

Default Value

0

Remarks

This property holds the port of the connecting client.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is read-only.

azure_relay_connection_sub_protocols Property

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

Syntax

def get_azure_relay_connection_sub_protocols(connection_id: int) -> str: ...

Default Value

""

Remarks

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

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

This property is read-only.

azure_relay_connection_timeout Property

This property specifies a timeout for the class.

Syntax

def get_azure_relay_connection_timeout(connection_id: int) -> int: ...
def set_azure_relay_connection_timeout(connection_id: int, value: int) -> None: ...

Default Value

0

Remarks

This property specifies a timeout for the class.

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

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

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

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

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the azure_relay_connection_count property.

default_timeout Property

An initial timeout value to be used by incoming connections.

Syntax

def get_default_timeout() -> int: ...
def set_default_timeout(value: int) -> None: ...

default_timeout = property(get_default_timeout, set_default_timeout)

Default Value

0

Remarks

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

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

firewall_auto_detect Property

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

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

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

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

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

firewall_host Property

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

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

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

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

firewall_password Property

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

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

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

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

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

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

firewall_user Property

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

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

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

forwarding_host Property

The address to which traffic will automatically be forwarded.

Syntax

def get_forwarding_host() -> str: ...
def set_forwarding_host(value: str) -> None: ...

forwarding_host = property(get_forwarding_host, set_forwarding_host)

Default Value

""

Remarks

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

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

Note: This functionality is not applicable to HTTP requests.

forwarding_port Property

The port to which traffic will automatically be forwarded.

Syntax

def get_forwarding_port() -> int: ...
def set_forwarding_port(value: int) -> None: ...

forwarding_port = property(get_forwarding_port, set_forwarding_port)

Default Value

0

Remarks

forwarding_port is used together with forwarding_host to define a location where traffic is automatically forwarded.

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

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

Note: This functionality is not applicable to HTTP requests.

hybrid_connection Property

The hybrid connection name.

Syntax

def get_hybrid_connection() -> str: ...
def set_hybrid_connection(value: str) -> None: ...

hybrid_connection = property(get_hybrid_connection, set_hybrid_connection)

Default Value

""

Remarks

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

listening Property

If , the class is listening for incoming connections.

Syntax

def get_listening() -> bool: ...
def set_listening(value: bool) -> None: ...

listening = property(get_listening, set_listening)

Default Value

FALSE

Remarks

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

Note: Use the start_listening and stop_listening methods to control whether the class is listening.

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host 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 class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

namespace_address Property

The namespace address of the relay.

Syntax

def get_namespace_address() -> str: ...
def set_namespace_address(value: str) -> None: ...

namespace_address = property(get_namespace_address, set_namespace_address)

Default Value

""

Remarks

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

proxy_auth_scheme Property

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

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

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

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

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

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

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

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

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

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

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

proxy_password Property

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

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

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

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

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

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

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:

proxy_user Property

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

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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., PKCS#12 certificate store).

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

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

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

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

disconnect Method

This method disconnects the specified client.

Syntax

def disconnect(connection_id: int) -> None: ...

Remarks

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

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

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

interrupt Method

Interrupts a synchronous send to the remote host.

Syntax

def interrupt(connection_id: int) -> None: ...

Remarks

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

pause_data Method

This method pauses data reception.

Syntax

def pause_data(connection_id: int) -> None: ...

Remarks

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

process_data Method

This method reenables data reception after a call to PauseData .

Syntax

def process_data(connection_id: int) -> None: ...

Remarks

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

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

send Method

Sends binary data to the client.

Syntax

def send(connection_id: int, data: bytes) -> None: ...

Remarks

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

send_bytes Method

This method sends binary data to the specified client.

Syntax

def send_bytes(connection_id: int, data: bytes) -> None: ...

Remarks

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

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

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

send_file Method

This method sends the file to the remote host.

Syntax

def send_file(connection_id: int, file_name: str) -> None: ...

Remarks

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

send_http_response Method

Send the HTTP response.

Syntax

def send_http_response(connection_id: int, status_code: int, status_description: str, response_data: bytes) -> None: ...

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

send_text Method

Sends text data to the client.

Syntax

def send_text(connection_id: int, text: str) -> None: ...

Remarks

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

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

Note: The on_ready_to_send 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 azure_relay_connection_data_format. The class will UTF-8 encode the supplied text.

shutdown Method

This method shuts down the server.

Syntax

def shutdown() -> None: ...

Remarks

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

start_listening Method

Starts listening for incoming connections.

Syntax

def start_listening() -> None: ...

Remarks

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

To stop listening for new connections call stop_listening. To stop listening for new connections and disconnect all existing clients call shutdown.

The following properties are applicable when calling this method:

• access_key (required)
• access_key_name (required)
• hybrid_connection (required)
• namespace_address (required)
• default_timeout
• forwarding_host
• forwarding_port

stop_listening Method

This method stops listening for new connections.

Syntax

def stop_listening() -> None: ...

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.

on_connected Event

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

Syntax

class AzureRelayReceiverConnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class AzureRelayReceiver:
@property
def on_connected() -> Callable[[AzureRelayReceiverConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[AzureRelayReceiverConnectedEventParams], None]) -> None: ...

Remarks

The on_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.

on_connection_connected Event

Fired when a client has connected.

Syntax

class AzureRelayReceiverConnectionConnectedEventParams(object):
  @property
  def connection_id() -> int: ...

# In class AzureRelayReceiver:
@property
def on_connection_connected() -> Callable[[AzureRelayReceiverConnectionConnectedEventParams], None]: ...
@on_connection_connected.setter
def on_connection_connected(event_hook: Callable[[AzureRelayReceiverConnectionConnectedEventParams], None]) -> None: ...

Remarks

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

ConnectionId identifies the connection.

on_connection_data_in Event

Fired when data is received.

Syntax

class AzureRelayReceiverConnectionDataInEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def data_format() -> int: ...

  @property
  def text() -> bytes: ...

  @property
  def eom() -> bool: ...

# In class AzureRelayReceiver:
@property
def on_connection_data_in() -> Callable[[AzureRelayReceiverConnectionDataInEventParams], None]: ...
@on_connection_data_in.setter
def on_connection_data_in(event_hook: Callable[[AzureRelayReceiverConnectionDataInEventParams], None]) -> None: ...

Remarks

The on_data_in 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 class will fire the on_data_in 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 class may also be configured to buffer the message internally until the complete message is received. To enable this set BufferMessage to true.

The EOL parameter stands for End of Line. When line_mode is false, EOL will always be false. When line_mode is true, EOL will be True if the on_data_in event fired because an EOL was received, and false if the on_data_in event fired because MaxLineLength was reached.

on_connection_disconnected Event

Fired when a WebSocket connection is disconnected.

Syntax

class AzureRelayReceiverConnectionDisconnectedEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class AzureRelayReceiver:
@property
def on_connection_disconnected() -> Callable[[AzureRelayReceiverConnectionDisconnectedEventParams], None]: ...
@on_connection_disconnected.setter
def on_connection_disconnected(event_hook: Callable[[AzureRelayReceiverConnectionDisconnectedEventParams], None]) -> None: ...

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:

on_connection_error Event

Information about errors during data delivery.

Syntax

class AzureRelayReceiverConnectionErrorEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class AzureRelayReceiver:
@property
def on_connection_error() -> Callable[[AzureRelayReceiverConnectionErrorEventParams], None]: ...
@on_connection_error.setter
def on_connection_error(event_hook: Callable[[AzureRelayReceiverConnectionErrorEventParams], None]) -> None: ...

Remarks

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

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

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

on_connection_ready_to_send Event

Fired when the class is ready to send data.

Syntax

class AzureRelayReceiverConnectionReadyToSendEventParams(object):
  @property
  def connection_id() -> int: ...

# In class AzureRelayReceiver:
@property
def on_connection_ready_to_send() -> Callable[[AzureRelayReceiverConnectionReadyToSendEventParams], None]: ...
@on_connection_ready_to_send.setter
def on_connection_ready_to_send(event_hook: Callable[[AzureRelayReceiverConnectionReadyToSendEventParams], None]) -> None: ...

Remarks

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

on_connection_request Event

Fires when a WebSocket connection is requested.

Syntax

class AzureRelayReceiverConnectionRequestEventParams(object):
  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

  @property
  def rendezvous_address() -> str: ...

  @property
  def id() -> str: ...

  @property
  def connect_headers() -> str: ...

  @property
  def sub_protocols() -> str: ...

  @property
  def extensions() -> str: ...

  @property
  def host() -> str: ...

  @property
  def remote_address() -> str: ...

  @property
  def remote_port() -> int: ...

  @property
  def status_code() -> int: ...
  @status_code.setter
  def status_code(value) -> None: ...

  @property
  def status_description() -> str: ...
  @status_description.setter
  def status_description(value) -> None: ...

# In class AzureRelayReceiver:
@property
def on_connection_request() -> Callable[[AzureRelayReceiverConnectionRequestEventParams], None]: ...
@on_connection_request.setter
def on_connection_request(event_hook: Callable[[AzureRelayReceiverConnectionRequestEventParams], None]) -> None: ...

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.

on_connection_status Event

Fired to indicate changes in connection state.

Syntax

class AzureRelayReceiverConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class AzureRelayReceiver:
@property
def on_connection_status() -> Callable[[AzureRelayReceiverConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[AzureRelayReceiverConnectionStatusEventParams], None]) -> None: ...

Remarks

The on_connection_status 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:

on_disconnected Event

This event is fired when a connection is closed.

Syntax

class AzureRelayReceiverDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class AzureRelayReceiver:
@property
def on_disconnected() -> Callable[[AzureRelayReceiverDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[AzureRelayReceiverDisconnectedEventParams], None]) -> None: ...

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.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class AzureRelayReceiverErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class AzureRelayReceiver:
@property
def on_error() -> Callable[[AzureRelayReceiverErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[AzureRelayReceiverErrorEventParams], None]) -> None: ...

Remarks

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

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

on_header Event

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

Syntax

class AzureRelayReceiverHeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class AzureRelayReceiver:
@property
def on_header() -> Callable[[AzureRelayReceiverHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[AzureRelayReceiverHeaderEventParams], None]) -> None: ...

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

on_http_request Event

Fires when an HTTP request is received.

Syntax

class AzureRelayReceiverHTTPRequestEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def rendezvous_address() -> str: ...

  @property
  def id() -> str: ...

  @property
  def request_headers() -> str: ...

  @property
  def request_target() -> str: ...

  @property
  def request_method() -> str: ...

  @property
  def host() -> str: ...

  @property
  def remote_address() -> str: ...

  @property
  def remote_port() -> int: ...

  @property
  def request_data() -> bytes: ...

# In class AzureRelayReceiver:
@property
def on_http_request() -> Callable[[AzureRelayReceiverHTTPRequestEventParams], None]: ...
@on_http_request.setter
def on_http_request(event_hook: Callable[[AzureRelayReceiverHTTPRequestEventParams], None]) -> None: ...

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

Parameter Descriptions

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

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

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

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

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

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

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

Hostholds the Host header value of the connected client.

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

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

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

on_log Event

Fires once for each log message.

Syntax

class AzureRelayReceiverLogEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class AzureRelayReceiver:
@property
def on_log() -> Callable[[AzureRelayReceiverLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[AzureRelayReceiverLogEventParams], None]) -> None: ...

Remarks

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

LogLevel indicates the level of message. Possible values are:

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"

on_redirect Event

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

Syntax

class AzureRelayReceiverRedirectEventParams(object):
  @property
  def location() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class AzureRelayReceiver:
@property
def on_redirect() -> Callable[[AzureRelayReceiverRedirectEventParams], None]: ...
@on_redirect.setter
def on_redirect(event_hook: Callable[[AzureRelayReceiverRedirectEventParams], None]) -> None: ...

Remarks

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

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class AzureRelayReceiverSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class AzureRelayReceiver:
@property
def on_ssl_server_authentication() -> Callable[[AzureRelayReceiverSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[AzureRelayReceiverSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

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

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

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class AzureRelayReceiverSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class AzureRelayReceiver:
@property
def on_ssl_status() -> Callable[[AzureRelayReceiverSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[AzureRelayReceiverSSLStatusEventParams], None]) -> None: ...

Remarks

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

AzureRelayReceiver Config Settings

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

AzureRelayReceiver Errors

WebSocketServer Errors

TCPServer Errors

SSL Errors

TCP/IP Errors