IPWorks MQ 2020 Node.js Edition

Questions / Feedback?

AzureRelayProxyConnectionUserData Property

The UserData property holds connection specific user specified data.

Syntax

 azurerelayproxy.getAzureRelayProxyConnectionUserData(index, [callback])
 azurerelayproxy.setAzureRelayProxyConnectionUserData(index,  azureRelayProxyConnectionUserData_Buffer, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAzureRelayProxyConnectionUserData([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setAzureRelayProxyConnectionUserData([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The AzureRelayProxyConnectionUserData property holds connection specific user specified data.

User specified data may be set or retrieved at any point while the connection is valid. This provides a simple way to associate arbitrary data with a specific connection.

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

This property is not available at design time.

Data Type

Buffer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks MQ 2020 Node.js Edition - Version 20.0 [Build 8155]