Class for handling SLIP encoding and decoding of HCI messages.
More...
#include <utils/ComSLIP.h>
|
| | TComSlip (Stream &s) |
| | Constructor. More...
|
| |
|
void | begin () |
| | Init function that must be called once prior to any other function of this object.
|
| |
|
void | end (void) |
| | De-Init function.
|
| |
| void | RegisterClient (TComSlipClient *client) |
| | register a client for processing More...
|
| |
| bool | SendMessage (UINT8 *msg, UINT16 msgLength) |
| | Generic function to transfer a message from the host to the module. More...
|
| |
| bool | SetRxBuffer (UINT8 *rxBuffer, UINT16 rxbufferSize) |
| | configure a rx-buffer and enable receiver/decoder More...
|
| |
| void | DecodeData (UINT8 *rxData, UINT16 length) |
| | process received byte stream More...
|
| |
| void | SendWakeUpSequence (UINT8 nbr) |
| | : Send a sequence of dummy chars to give the WiMOD some time to wake up More...
|
| |
Class for handling SLIP encoding and decoding of HCI messages.
| TComSlip::TComSlip |
( |
Stream & |
s | ) |
|
Constructor.
- Parameters
-
| s | Reference to the serial interface to use for communication |
| void TComSlip::DecodeData |
( |
UINT8 * |
rxData, |
|
|
UINT16 |
length |
|
) |
| |
process received byte stream
- Parameters
-
| rxData | pointer to received bytes |
| length | number of bytes received |
register a client for processing
- Parameters
-
| client | pointer to client that should handle a received SLIP frame |
| bool TComSlip::SendMessage |
( |
UINT8 * |
msg, |
|
|
UINT16 |
msgLength |
|
) |
| |
Generic function to transfer a message from the host to the module.
This is a generic function to send out a stream of bytes. The bytes are encoded into the SLIP format before transmission. Therefore a complete message has to be given.
- Parameters
-
| msg | pointer to the bytes to encoded and send via serial interface |
| msgLength | number of bytes |
| void TComSlip::SendWakeUpSequence |
( |
UINT8 |
nbr | ) |
|
: Send a sequence of dummy chars to give the WiMOD some time to wake up
- Parameters
-
| nbr | number of dummy bytes to send |
| bool TComSlip::SetRxBuffer |
( |
UINT8 * |
rxBuffer, |
|
|
UINT16 |
rxBufferSize |
|
) |
| |
configure a rx-buffer and enable receiver/decoder
- Parameters
-
| rxBuffer | pointer to plain buffer |
| rxBufferSize | size of buffer in bytes |
The documentation for this class was generated from the following files: