Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: rover_car rover_pc supervisor watering_unit ... more
ssWiChannel Class Reference
Abstract class for a communication channel. More...
#include <ssWiChannel.hpp>
Inherited by XBeeModule.
Public Member Functions | |
| virtual bool | init (int TXRate, int RXRate)=0 |
| Initialize ssWi on this channel. | |
| virtual int | read (char *msg)=0 |
| read from the socket | |
| virtual void | write (const char *msg, int n)=0 |
| write to the socket | |
Protected Member Functions | |
| bool | _init (ssWiChannel *c, int TXRate, int RXRate) |
| Initialize the protocol. | |
Detailed Description
Abstract class for a communication channel.
Definition at line 16 of file ssWiChannel.hpp.
Member Function Documentation
| bool _init | ( | ssWiChannel * | c, |
| int | TXRate, | ||
| int | RXRate | ||
| ) | [protected] |
Initialize the protocol.
- Parameters:
-
c ssWi channel TXRate how may times trans every second RXRate how may time rx every second
- Returns:
- true if the channel is ready, false otherwise
Definition at line 28 of file ssWiChannel.hpp.
| virtual bool init | ( | int | TXRate, |
| int | RXRate | ||
| ) | [pure virtual] |
Initialize ssWi on this channel.
- Parameters:
-
TXRate number of transmissions per second RXRate number of receptions per second
- Returns:
- true if ssWi has been initialized succefully, false otherwise
| virtual int read | ( | char * | msg ) | [pure virtual] |
read from the socket
- Parameters:
-
msg buffer where to write the read message
- Returns:
- the number of read bytes
| virtual void write | ( | const char * | msg, |
| int | n | ||
| ) | [pure virtual] |
write to the socket
- Parameters:
-
msg buffer with the message to send n number of bytes to send
Generated on Tue Jul 12 2022 15:15:30 by
1.7.2