2.2.3.4 BringUpFailureResponse Message
The BringUpFailureResponse message is sent by the server to the client in response to a BringUpStartRequest message (section 2.2.3.1) when the request for tethering fails. If the reason for the failure cannot be adequately described in the statusCode field, the message SHOULD only contain an error string.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
header |
statusCode |
||||||||||||||||||||||||||||||
|
... |
Error (variable) |
||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
header (3 bytes): The header field contains the CommonHeader structure (section 2.2.2.2), where the value of the Id field is set to 3 (BringUpFailureResponse), as specified in MessageId (section 2.2.1.1), the length of the Length field is variable, and the value MUST be set to the combined size of all structures contained within the message.
statusCode (4 bytes): The statusCode field specifies the status code, as defined in the StatusCodeEnum enumeration (section 2.2.1.2), that represents the outcome of the attempt to start tethering on the server. For the BringUpFailureResponse message, the value of the statusCode field MUST NOT be set to 0 (Success).
Error (variable): (optional) When the Error field is present in the message, it contains an error message, as defined in the ErrorString structure (section 2.2.2.5), that corresponds to the result of the tethering attempt to the server. If the error message is an empty string, this field SHOULD NOT be included in the message.