These message are used for general purpose in the BCC protocol.
•bccAck, General acknowledge •bccNack, General NOT acknowledge •bccData, Binary data •bccAbort, Abort command •bccAborted, Abort event •bccEndData, End of data •bccNoData, No data |
•bccIBlock, Software inter-block •bccCheck, Check-point command •bccBusy, System busy event •bccCompleted, Completation event •bccWait, Wait more •bccReady, Ready |
General acknowledge
Code: |
1 |
Symbolic: |
bccAck |
General acknowledge message, usually used as reply message of another request message: some time can contain data.
General NOT acknowledge
Code: |
2 |
Symbolic: |
bccNack |
General not acknowledge message, usually used as negative reply message of another request message. Data area is the following:
Off |
Type |
Description |
|---|---|---|
0 |
U16 |
Original request message code, to wich the error is referred |
2 |
U16 |
|
4 |
U16 |
Nack extra data (optional, not for all messages) |
NOTE: to validate a NACK message, you should even consider area data greater/equal to 4 bytes. If a NACK provide extra information and they are not received (but a least four initial bytes) the message is valid too, but extra information are declared 'not provided' (for example from old BCC implementation).
Some common NACK error codes:
NACK code |
Description |
Extra data |
|---|---|---|
nackWrongCommand |
The command in not implemented |
|
nackMissingArgs |
One or more parameter missing |
|
nackNotAuthorized |
The command could be valid but current authentication does not allow it (see network interfaces). |
|
nackIllegalMode |
The command is valid and authorized, but current mode/status does not permit it to be processed. |
|
nackResourceBusy |
Required resource is not available at this moment. |
|
Binary data
Code: |
3 |
Symbolic: |
bccData |
General message to transport binary / general purpose data.
Abort command
Code: |
AS+4 |
Symbolic: |
bccAbort |
General command to request abort of current operation, in a specific usage context. If while waiting bccAck/bccNack for the command, you received the bccAborted notification you should even wait for bccAck or bccNack, but result o abort will be bccAck.
Request data area is the following:
Off |
Type |
Description |
|---|---|---|
0 |
U16 |
Abort code, usually a standard nack error code |
2 |
U16 |
Nack extra data: value depends on context usage. |
4 |
STRZ |
Optional error string (0 termined) |
Abort event
Code: |
5 |
Symbolic: |
bccAborted |
General information about an abort event: data area is the following, but can have additional information depending the usage context:
Off |
Type |
Description |
|---|---|---|
0 |
U16 |
Abort code, usually a standard nack error code |
2 |
U16 |
Nack extra data: value depends on context usage. |
4 |
STRZ |
Optional error string (0 termined) |
End of data
Code: |
6 |
Symbolic: |
bccEndData |
When this message is used instead of bccData, it mean that there are no more data that can be received.
No data
Code: |
7 |
Symbolic: |
bccEndData |
When this message is used instead of bccData, it mean that there is not data to be received.
Software inter-block
Code: |
8 |
Symbolic: |
bccIBlock |
This message is usually used as software inter-block during data transfer to specifying how many bccData can be sent to the receiver in a single shoot. It's data area depend on usage context.
Check-point command
Code: |
AS+9 |
Symbolic: |
bccCheck |
This command is used as general purpose check command, to verify something.
Optional data area on command, answer data and nack codes , depend on context usage.
System busy event
Code: |
10 |
Symbolic: |
bccBusy |
This message is usually used instead of bccNack, indicating that the receiver cannot handle the command because is busy to do something else: user can way an amount of time and retry the command or operation.
Completation event
Code: |
11 |
Symbolic: |
bccCompleted |
This message is usually used to indicate that an operation or request has been completed: it's data area depend on usage context.
Wait more
Code: |
12 |
Symbolic: |
bccWait |
This message is usually used to indicate that an operation or request need more time in order to completed: it's data area depend on usage context.
Ready
Code: |
13 |
Symbolic: |
bccReady |
This message is usually used to indicate that something is ready in an operation: it's data area depend on usage context.
