AzureRelayReceiver Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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:

• 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 ConnectionsDataToSend or call Send, SendFile, or SendText.

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

Handling HTTP Connections

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

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

Forwarding Connections

The class supports forwarding incoming connection to a separate destination. This functionality allows AzureRelayReceiver to act as a proxy for incoming requests. When ForwardingHost and ForwardingPort are set anytime a connection is made the class will establish a separate connection to the ForwardingHost and forward all incoming traffic. Responses from the ForwardingHost are then automatically sent back over the connection.

When connection forwarding is used no special steps are needed to send or receive data. Data flows freely between the connected client and the ForwardingHost.

Note: Forwarding is not supported for HTTP requests.

Code Example (WebSockets)

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

Code Example (HTTP)

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

Property List

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

Method List

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

Event List

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

Config Settings

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

AccessKey Property (AzureRelayReceiver Module)

The Shared Access Key.

Syntax

• Swift
• Objective-C

public var accessKey: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=accessKey,setter=setAccessKey:) NSString* accessKey;

- (NSString*)accessKey;
- (void)setAccessKey :(NSString*)newAccessKey;

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

The Shared Access Key Name.

Syntax

• Swift
• Objective-C

public var accessKeyName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=accessKeyName,setter=setAccessKeyName:) NSString* accessKeyName;

- (NSString*)accessKeyName;
- (void)setAccessKeyName :(NSString*)newAccessKeyName;

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

Whether the module is connected.

Syntax

• Swift
• Objective-C

public var connected: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=connected) BOOL connected;

- (BOOL)connected;

Default Value

False

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only.

Connections Property (AzureRelayReceiver Module)

A collection of currently connected clients.

Syntax

• Swift
• Objective-C

public var connections: [String: AzureRelayConnection] {
  get {...}
}

@property (nonatomic,readonly,assign,getter=azureRelayConnectionCount) int azureRelayConnectionCount;

- (int)azureRelayConnectionCount;

- (BOOL)azureRelayConnectionAcceptData:(int)connectionId;
- (void)setAzureRelayConnectionAcceptData:(int)connectionId :(BOOL)newAzureRelayConnectionAcceptData;

- (NSString*)azureRelayConnectionAddress:(int)connectionId;

- (int)azureRelayConnectionBytesSent:(int)connectionId;

- (BOOL)azureRelayConnectionConnected:(int)connectionId;

- (NSString*)azureRelayConnectionConnectHeaders:(int)connectionId;

- (int)azureRelayConnectionConnectionId:(int)connectionId;

- (int)azureRelayConnectionDataFormat:(int)connectionId;
- (void)setAzureRelayConnectionDataFormat:(int)connectionId :(int)newAzureRelayConnectionDataFormat;

- (NSString*)azureRelayConnectionDataToSend:(int)connectionId;
- (void)setAzureRelayConnectionDataToSend:(int)connectionId :(NSString*)newAzureRelayConnectionDataToSend;

- (NSData*)azureRelayConnectionDataToSendB:(int)connectionId;
- (void)setAzureRelayConnectionDataToSendB:(int)connectionId :(NSData*)newAzureRelayConnectionDataToSend;
- (NSString*)azureRelayConnectionExtensions:(int)connectionId;

- (NSString*)azureRelayConnectionHost:(int)connectionId;

- (NSString*)azureRelayConnectionId:(int)connectionId;

- (BOOL)azureRelayConnectionReadyToSend:(int)connectionId;

- (NSString*)azureRelayConnectionRemoteAddress:(int)connectionId;

- (int)azureRelayConnectionRemotePort:(int)connectionId;

- (NSString*)azureRelayConnectionSubProtocols:(int)connectionId;

- (int)azureRelayConnectionTimeout:(int)connectionId;
- (void)setAzureRelayConnectionTimeout:(int)connectionId :(int)newAzureRelayConnectionTimeout;

Default Value

""

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setConnectionsB(connections: Data) throws
public func setConnections(connections: String) throws

DefaultTimeout Property (AzureRelayReceiver Module)

An initial timeout value to be used by incoming connections.

Syntax

• Swift
• Objective-C

public var defaultTimeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultTimeout,setter=setDefaultTimeout:) int defaultTimeout;

- (int)defaultTimeout;
- (void)setDefaultTimeout :(int)newDefaultTimeout;

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 Property (AzureRelayReceiver Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

""

Remarks

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setFirewallB(firewall: Data) throws
public func setFirewall(firewall: String) throws

ForwardingHost Property (AzureRelayReceiver Module)

The address to which traffic will automatically be forwarded.

Syntax

• Swift
• Objective-C

public var forwardingHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=forwardingHost,setter=setForwardingHost:) NSString* forwardingHost;

- (NSString*)forwardingHost;
- (void)setForwardingHost :(NSString*)newForwardingHost;

Default Value

""

Remarks

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

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

Note: This functionality is not applicable to HTTP requests.

ForwardingPort Property (AzureRelayReceiver Module)

The port to which traffic will automatically be forwarded.

Syntax

• Swift
• Objective-C

public var forwardingPort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=forwardingPort,setter=setForwardingPort:) int forwardingPort;

- (int)forwardingPort;
- (void)setForwardingPort :(int)newForwardingPort;

Default Value

0

Remarks

ForwardingPort is used together with ForwardingHost to define a location where traffic is automatically forwarded.

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

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

Note: This functionality is not applicable to HTTP requests.

HybridConnection Property (AzureRelayReceiver Module)

The hybrid connection name.

Syntax

• Swift
• Objective-C

public var hybridConnection: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=hybridConnection,setter=setHybridConnection:) NSString* hybridConnection;

- (NSString*)hybridConnection;
- (void)setHybridConnection :(NSString*)newHybridConnection;

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

If , the module is listening for incoming connections.

Syntax

• Swift
• Objective-C

public var listening: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=listening,setter=setListening:) BOOL listening;

- (BOOL)listening;
- (void)setListening :(BOOL)newListening;

Default Value

False

Remarks

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

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

LocalHost Property (AzureRelayReceiver Module)

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

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

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

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

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

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

NamespaceAddress Property (AzureRelayReceiver Module)

The namespace address of the relay.

Syntax

• Swift
• Objective-C

public var namespaceAddress: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=namespaceAddress,setter=setNamespaceAddress:) NSString* namespaceAddress;

- (NSString*)namespaceAddress;
- (void)setNamespaceAddress :(NSString*)newNamespaceAddress;

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

A set of properties related to proxy access.

Syntax

• Swift
• Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

""

Remarks

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setProxyB(proxy: Data) throws
public func setProxy(proxy: String) throws

SSLAcceptServerCert Property (AzureRelayReceiver Module)

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

Syntax

• Swift
• Objective-C

public var sslAcceptServerCert: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertEffectiveDate) NSString* SSLAcceptServerCertEffectiveDate;

- (NSString*)SSLAcceptServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExpirationDate) NSString* SSLAcceptServerCertExpirationDate;

- (NSString*)SSLAcceptServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExtendedKeyUsage) NSString* SSLAcceptServerCertExtendedKeyUsage;

- (NSString*)SSLAcceptServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprint) NSString* SSLAcceptServerCertFingerprint;

- (NSString*)SSLAcceptServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA1) NSString* SSLAcceptServerCertFingerprintSHA1;

- (NSString*)SSLAcceptServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA256) NSString* SSLAcceptServerCertFingerprintSHA256;

- (NSString*)SSLAcceptServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertIssuer) NSString* SSLAcceptServerCertIssuer;

- (NSString*)SSLAcceptServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKey) NSString* SSLAcceptServerCertPrivateKey;

- (NSString*)SSLAcceptServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyAvailable) BOOL SSLAcceptServerCertPrivateKeyAvailable;

- (BOOL)SSLAcceptServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyContainer) NSString* SSLAcceptServerCertPrivateKeyContainer;

- (NSString*)SSLAcceptServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKey) NSString* SSLAcceptServerCertPublicKey;

- (NSString*)SSLAcceptServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyAlgorithm) NSString* SSLAcceptServerCertPublicKeyAlgorithm;

- (NSString*)SSLAcceptServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyLength) int SSLAcceptServerCertPublicKeyLength;

- (int)SSLAcceptServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSerialNumber) NSString* SSLAcceptServerCertSerialNumber;

- (NSString*)SSLAcceptServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSignatureAlgorithm) NSString* SSLAcceptServerCertSignatureAlgorithm;

- (NSString*)SSLAcceptServerCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStore,setter=setSSLAcceptServerCertStore:) NSString* SSLAcceptServerCertStore;

- (NSString*)SSLAcceptServerCertStore;
- (void)setSSLAcceptServerCertStore :(NSString*)newSSLAcceptServerCertStore;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreB,setter=setSSLAcceptServerCertStoreB:) NSData* SSLAcceptServerCertStoreB;

- (NSData*)SSLAcceptServerCertStoreB;
- (void)setSSLAcceptServerCertStoreB :(NSData*)newSSLAcceptServerCertStore;
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStorePassword,setter=setSSLAcceptServerCertStorePassword:) NSString* SSLAcceptServerCertStorePassword;

- (NSString*)SSLAcceptServerCertStorePassword;
- (void)setSSLAcceptServerCertStorePassword :(NSString*)newSSLAcceptServerCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreType,setter=setSSLAcceptServerCertStoreType:) int SSLAcceptServerCertStoreType;

- (int)SSLAcceptServerCertStoreType;
- (void)setSSLAcceptServerCertStoreType :(int)newSSLAcceptServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSubjectAltNames) NSString* SSLAcceptServerCertSubjectAltNames;

- (NSString*)SSLAcceptServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintMD5) NSString* SSLAcceptServerCertThumbprintMD5;

- (NSString*)SSLAcceptServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA1) NSString* SSLAcceptServerCertThumbprintSHA1;

- (NSString*)SSLAcceptServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA256) NSString* SSLAcceptServerCertThumbprintSHA256;

- (NSString*)SSLAcceptServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsage) NSString* SSLAcceptServerCertUsage;

- (NSString*)SSLAcceptServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsageFlags) int SSLAcceptServerCertUsageFlags;

- (int)SSLAcceptServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertVersion) NSString* SSLAcceptServerCertVersion;

- (NSString*)SSLAcceptServerCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertSubject,setter=setSSLAcceptServerCertSubject:) NSString* SSLAcceptServerCertSubject;

- (NSString*)SSLAcceptServerCertSubject;
- (void)setSSLAcceptServerCertSubject :(NSString*)newSSLAcceptServerCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;
 

Default Value

""

Remarks

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

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

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertB(sslAcceptServerCert: Data) throws
public func setSSLAcceptServerCert(sslAcceptServerCert: String) throws

SSLCert Property (AzureRelayReceiver Module)

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

Syntax

• Swift
• Objective-C

public var sslCert: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=SSLCertEffectiveDate) NSString* SSLCertEffectiveDate;

- (NSString*)SSLCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLCertExpirationDate) NSString* SSLCertExpirationDate;

- (NSString*)SSLCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLCertExtendedKeyUsage) NSString* SSLCertExtendedKeyUsage;

- (NSString*)SSLCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprint) NSString* SSLCertFingerprint;

- (NSString*)SSLCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA1) NSString* SSLCertFingerprintSHA1;

- (NSString*)SSLCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA256) NSString* SSLCertFingerprintSHA256;

- (NSString*)SSLCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertIssuer) NSString* SSLCertIssuer;

- (NSString*)SSLCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKey) NSString* SSLCertPrivateKey;

- (NSString*)SSLCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyAvailable) BOOL SSLCertPrivateKeyAvailable;

- (BOOL)SSLCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyContainer) NSString* SSLCertPrivateKeyContainer;

- (NSString*)SSLCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKey) NSString* SSLCertPublicKey;

- (NSString*)SSLCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyAlgorithm) NSString* SSLCertPublicKeyAlgorithm;

- (NSString*)SSLCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyLength) int SSLCertPublicKeyLength;

- (int)SSLCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLCertSerialNumber) NSString* SSLCertSerialNumber;

- (NSString*)SSLCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLCertSignatureAlgorithm) NSString* SSLCertSignatureAlgorithm;

- (NSString*)SSLCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLCertSubjectAltNames) NSString* SSLCertSubjectAltNames;

- (NSString*)SSLCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintMD5) NSString* SSLCertThumbprintMD5;

- (NSString*)SSLCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA1) NSString* SSLCertThumbprintSHA1;

- (NSString*)SSLCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA256) NSString* SSLCertThumbprintSHA256;

- (NSString*)SSLCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertUsage) NSString* SSLCertUsage;

- (NSString*)SSLCertUsage;

@property (nonatomic,readonly,assign,getter=SSLCertUsageFlags) int SSLCertUsageFlags;

- (int)SSLCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLCertVersion) NSString* SSLCertVersion;

- (NSString*)SSLCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;
 

Default Value

""

Remarks

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertB(sslCert: Data) throws
public func setSSLCert(sslCert: String) throws

SSLProvider Property (AzureRelayReceiver Module)

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

Syntax

• Swift
• Objective-C

public var sslProvider: AzureRelayReceiverSSLProviders {
  get {...}
  set {...}
}

public enum AzureRelayReceiverSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

Default Value

0

Remarks

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

Possible values are as follows:

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

When Automatic is selected, the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCert Property (AzureRelayReceiver Module)

The server certificate for the last established connection.

Syntax

• Swift
• Objective-C

public var sslServerCert: Certificate {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEffectiveDate) NSString* SSLServerCertEffectiveDate;

- (NSString*)SSLServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExpirationDate) NSString* SSLServerCertExpirationDate;

- (NSString*)SSLServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExtendedKeyUsage) NSString* SSLServerCertExtendedKeyUsage;

- (NSString*)SSLServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprint) NSString* SSLServerCertFingerprint;

- (NSString*)SSLServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA1) NSString* SSLServerCertFingerprintSHA1;

- (NSString*)SSLServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA256) NSString* SSLServerCertFingerprintSHA256;

- (NSString*)SSLServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertIssuer) NSString* SSLServerCertIssuer;

- (NSString*)SSLServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKey) NSString* SSLServerCertPrivateKey;

- (NSString*)SSLServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyAvailable) BOOL SSLServerCertPrivateKeyAvailable;

- (BOOL)SSLServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyContainer) NSString* SSLServerCertPrivateKeyContainer;

- (NSString*)SSLServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKey) NSString* SSLServerCertPublicKey;

- (NSString*)SSLServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyAlgorithm) NSString* SSLServerCertPublicKeyAlgorithm;

- (NSString*)SSLServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyLength) int SSLServerCertPublicKeyLength;

- (int)SSLServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLServerCertSerialNumber) NSString* SSLServerCertSerialNumber;

- (NSString*)SSLServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLServerCertSignatureAlgorithm) NSString* SSLServerCertSignatureAlgorithm;

- (NSString*)SSLServerCertSignatureAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertStore) NSString* SSLServerCertStore;

- (NSString*)SSLServerCertStore;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreB) NSData* SSLServerCertStoreB;

- (NSData*)SSLServerCertStoreB;
@property (nonatomic,readonly,assign,getter=SSLServerCertStorePassword) NSString* SSLServerCertStorePassword;

- (NSString*)SSLServerCertStorePassword;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreType) int SSLServerCertStoreType;

- (int)SSLServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubjectAltNames) NSString* SSLServerCertSubjectAltNames;

- (NSString*)SSLServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintMD5) NSString* SSLServerCertThumbprintMD5;

- (NSString*)SSLServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA1) NSString* SSLServerCertThumbprintSHA1;

- (NSString*)SSLServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA256) NSString* SSLServerCertThumbprintSHA256;

- (NSString*)SSLServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsage) NSString* SSLServerCertUsage;

- (NSString*)SSLServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsageFlags) int SSLServerCertUsageFlags;

- (int)SSLServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLServerCertVersion) NSString* SSLServerCertVersion;

- (NSString*)SSLServerCertVersion;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubject) NSString* SSLServerCertSubject;

- (NSString*)SSLServerCertSubject;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;
 

Default Value

""

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertB(sslServerCert: Data) throws
public func setSSLServerCert(sslServerCert: String) throws

Config Method (AzureRelayReceiver Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

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

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

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

Disconnect Method (AzureRelayReceiver Module)

This method disconnects the specified client.

Syntax

• Swift
• Objective-C

public func disconnect(connectionId: Int32) throws -> Void

- (void)disconnect:(int)connectionId;

Remarks

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

DoEvents Method (AzureRelayReceiver Module)

This method processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

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

Interrupt Method (AzureRelayReceiver Module)

Interrupts a synchronous send to the remote host.

Syntax

• Swift
• Objective-C

public func interrupt(connectionId: Int32) throws -> Void

- (void)interrupt:(int)connectionId;

Remarks

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

PauseData Method (AzureRelayReceiver Module)

This method pauses data reception.

Syntax

• Swift
• Objective-C

public func pauseData(connectionId: Int32) throws -> Void

- (void)pauseData:(int)connectionId;

Remarks

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

ProcessData Method (AzureRelayReceiver Module)

This method reenables data reception after a call to PauseData .

Syntax

• Swift
• Objective-C

public func processData(connectionId: Int32) throws -> Void

- (void)processData:(int)connectionId;

Remarks

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

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

Send Method (AzureRelayReceiver Module)

This method sends binary data to the client.

Syntax

• Swift
• Objective-C

public func send(connectionId: Int32, data: Data) throws -> Void

- (void)send:(int)connectionId :(NSData*)data;

Remarks

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

SendBytes Method (AzureRelayReceiver Module)

This method sends binary data to the specified client.

Syntax

• Swift
• Objective-C

public func sendBytes(connectionId: Int32, data: Data) throws -> Void

- (void)sendBytes:(int)connectionId :(NSData*)data;

Remarks

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

When ConnectionsTimeout 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 . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

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

SendFile Method (AzureRelayReceiver Module)

This method sends the file to the remote host.

Syntax

• Swift
• Objective-C

public func sendFile(connectionId: Int32, fileName: String) throws -> Void

- (void)sendFile:(int)connectionId :(NSString*)fileName;

Remarks

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

SendHTTPResponse Method (AzureRelayReceiver Module)

Send the HTTP response.

Syntax

• Swift
• Objective-C

public func sendHTTPResponse(connectionId: Int32, statusCode: Int32, statusDescription: String, responseData: Data) throws -> Void

- (void)sendHTTPResponse:(int)connectionId :(int)statusCode :(NSString*)statusDescription :(NSData*)responseData;

Remarks

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

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

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

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

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

Code Example (HTTP)

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

SendText Method (AzureRelayReceiver Module)

This method sends text data to the client.

Syntax

• Swift
• Objective-C

public func sendText(connectionId: Int32, text: String) throws -> Void

- (void)sendText:(int)connectionId :(NSString*)text;

Remarks

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

When ConnectionsTimeout 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 . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

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

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

Shutdown Method (AzureRelayReceiver Module)

This method shuts down the server.

Syntax

• Swift
• Objective-C

public func shutdown() throws -> Void

- (void)shutdown;

Remarks

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

StartListening Method (AzureRelayReceiver Module)

Starts listening for incoming connections.

Syntax

• Swift
• Objective-C

public func startListening() throws -> Void

- (void)startListening;

Remarks

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

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

The following properties are applicable when calling this method:

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

StopListening Method (AzureRelayReceiver Module)

This method stops listening for new connections.

Syntax

• Swift
• Objective-C

public func stopListening() throws -> Void

- (void)stopListening;

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

Connected Event (AzureRelayReceiver Module)

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

Syntax

• Swift
• Objective-C

func onConnected(statusCode: Int32, description: String)

- (void)onConnected:(int)statusCode :(NSString*)description;

Remarks

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

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

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

Note: Please refer to the Error Codes section for more information.

ConnectionConnected Event (AzureRelayReceiver Module)

Fired when a client has connected.

Syntax

• Swift
• Objective-C

func onConnectionConnected(connectionId: Int32)

- (void)onConnectionConnected:(int)connectionId;

Remarks

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

ConnectionId identifies the connection.

ConnectionDataIn Event (AzureRelayReceiver Module)

Fired when data is received.

Syntax

• Swift
• Objective-C

func onConnectionDataIn(connectionId: Int32, dataFormat: Int32, text: Data, eom: Bool)

- (void)onConnectionDataIn:(int)connectionId :(int)dataFormat :(NSData*)text :(BOOL)EOM;

Remarks

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

The incoming data are provided through the Text parameter.

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

The EOM parameter stands for End of Message. By default, the class will fire the DataIn event as data are received. Larger messages will be fragmented and will cause the event to fire multiple times. When EOM is True within the event, this indicates the current fragment is also the final fragment of the message. The class may also be configured to buffer the message internally until the complete message is received. To enable this, set BufferMessage to True.

The EOL parameter stands for End of Line. When LineMode is False, EOL will always be False. When LineMode is True, EOL will be True if the DataIn event fired because an EOL was received and will be False if the DataIn event fired because MaxLineLength was reached.

ConnectionDisconnected Event (AzureRelayReceiver Module)

Fired when a WebSocket connection is disconnected.

Syntax

• Swift
• Objective-C

func onConnectionDisconnected(connectionId: Int32, statusCode: Int32, description: String)

- (void)onConnectionDisconnected:(int)connectionId :(int)statusCode :(NSString*)description;

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

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onConnectionError(connectionId: Int32, errorCode: Int32, description: String)

- (void)onConnectionError:(int)connectionId :(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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

Fired when the component is ready to send data.

Syntax

• Swift
• Objective-C

func onConnectionReadyToSend(connectionId: Int32)

- (void)onConnectionReadyToSend:(int)connectionId;

Remarks

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

ConnectionRequest Event (AzureRelayReceiver Module)

Fires when a WebSocket connection is requested.

Syntax

• Swift
• Objective-C

func onConnectionRequest(accept: inout Bool, rendezvousAddress: String, id: String, connectHeaders: String, subProtocols: String, extensions: String, host: String, remoteAddress: String, remotePort: Int32, statusCode: inout Int32, statusDescription: inout String)

- (void)onConnectionRequest:(int*)accept :(NSString*)rendezvousAddress :(NSString*)id :(NSString*)connectHeaders :(NSString*)subProtocols :(NSString*)extensions :(NSString*)host :(NSString*)remoteAddress :(int)remotePort :(int*)statusCode :(NSString**)statusDescription;

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

This event is fired to indicate changes in connection state.

Syntax

• Swift
• Objective-C

func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String)

- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;

Remarks

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

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

Disconnected Event (AzureRelayReceiver Module)

Fired when a connection is closed.

Syntax

• Swift
• Objective-C

func onDisconnected(statusCode: Int32, description: String)

- (void)onDisconnected:(int)statusCode :(NSString*)description;

Remarks

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

If the connection is broken for any other reason, StatusCode has the error code returned by the 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 Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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

Header Event (AzureRelayReceiver Module)

Fired every time a header line comes in.

Syntax

• Swift
• Objective-C

func onHeader(field: String, value: String)

- (void)onHeader:(NSString*)field :(NSString*)value;

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

Fires when an HTTP request is received.

Syntax

• Swift
• Objective-C

func onHTTPRequest(connectionId: Int32, rendezvousAddress: String, id: String, requestHeaders: String, requestTarget: String, requestMethod: String, host: String, remoteAddress: String, remotePort: Int32, requestData: Data)

- (void)onHTTPRequest:(int)connectionId :(NSString*)rendezvousAddress :(NSString*)id :(NSString*)requestHeaders :(NSString*)requestTarget :(NSString*)requestMethod :(NSString*)host :(NSString*)remoteAddress :(int)remotePort :(NSData*)requestData;

Remarks

This event fires when an HTTP request is received. The parameters of this event describe the details of the HTTP request.

The ConnectionId value must be saved and used when calling SendHTTPResponse.

Parameter Descriptions

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

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

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

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

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

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

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

Hostholds the Host header value of the connected client.

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

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

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

Log Event (AzureRelayReceiver Module)

This event fires once for each log message.

Syntax

• Swift
• Objective-C

func onLog(connectionId: Int32, logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)connectionId :(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

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

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information including the URL, HTTP version, and connection status details.

The value 2 (Verbose) logs additional information about the initial HTTP request.

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

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "Error"
• "Verbose"
• "Debug"

Redirect Event (AzureRelayReceiver Module)

Fired when a redirection is received from the server.

Syntax

• Swift
• Objective-C

func onRedirect(location: String, accept: inout Bool)

- (void)onRedirect:(NSString*)location :(int*)accept;

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

SSLServerAuthentication Event (AzureRelayReceiver Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

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

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

SSLStatus Event (AzureRelayReceiver Module)

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

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

AzureRelayConnection Type

A currently connected client.

Remarks

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

Fields

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

Constructors

public init()

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

public init()

public init(encoded: )

public init(storeType: , store: , storePassword: , subject: )

public init(storeType: , store: , storePassword: , subject: )

Firewall Type

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 and the .

Fields

Constructors

public init()

Proxy Type

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 and the .

Fields

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

Config Settings (AzureRelayReceiver Module)

AzureRelayReceiver Config Settings

WebSocketServer Config Settings

TCPServer Config Settings

SSL Config Settings

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

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

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

Trappable Errors (AzureRelayReceiver Module)

WebSocketServer Errors

TCPServer Errors

SSL Errors

TCP/IP Errors