AzureRelayConnectionConnectHeaders Property
A JSON object containing the HTTP headers that have been supplied by the sender to the Azure Relay service.
Syntax
azurerelayreceiver.getAzureRelayConnectionConnectHeaders(index, [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 getAzureRelayConnectionConnectHeaders([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setAzureRelayConnectionConnectHeaders([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
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 index parameter specifies the index of the item in the array. The size of the array is controlled by the AzureRelayConnectionCount property.
This property is read-only and not available at design time.
Data Type
String