DummySocket Class Reference
Tekkotsu wireless DummySocket class. More...
#include <DummySocket.h>
Detailed Description
Tekkotsu wireless DummySocket class.
This class provides a DummySocket that doesn't really do anything It exists to maintain code readability; while supporting dogs without wireless Of course, since it does nothing, it doesn't need documentation provides a no-op implementation of Socket for disabled operation
Definition at line 17 of file DummySocket.h.
Public Member Functions | |
| DummySocket (int sockn) | |
| constructor | |
| virtual | ~DummySocket () |
| destructor | |
| byte * | getWriteBuffer (int) |
| returns NULL | |
| void | write (int) |
| no-op | |
| int | read () |
| no-op (returns -1) | |
| byte * | getReadBuffer () |
| getReadBuffer is used with blocking read's NOT IMPLEMENTED | |
| void | init () |
| no-op (returns NULL) | |
| int | setFlushType (FlushType_t) |
| no-op | |
| void | setTextForward () |
| no-op | |
| void | setForward (DummySocket *) |
| sets another socket to send data to if this one is not connected | |
| void | setVerbosity (int) |
| no-op | |
| int | write (const byte *, int) |
| no-op (returns -1) | |
| int | read (byte *, int) |
| no-ip (returns -1) | |
| int | printf (const char *,...) |
| no-op | |
| int | vprintf (const char *, va_list) |
| no-op | |
| int | pprintf (int, const char *,...) |
| no-op | |
| void | flush () |
| no-op | |
Friends | |
| class | Wireless |
Constructor & Destructor Documentation
| DummySocket::DummySocket | ( | int | sockn | ) |
constructor
Definition at line 22 of file DummySocket.h.
| virtual DummySocket::~DummySocket | ( | ) | [virtual] |
destructor
Definition at line 24 of file DummySocket.h.
Member Function Documentation
| void DummySocket::flush | ( | ) |
| byte* DummySocket::getReadBuffer | ( | ) |
getReadBuffer is used with blocking read's NOT IMPLEMENTED
The read(void) and getReadBuffer combo eliminates one buffer copy. You don't need to use getReadBuffer with read(byte*, int)
Blocking read is currently broken - it will be fixed in the next release
- Returns:
- pointer to the buffer the previous call to blocking read wrote into or NULL if no data was read
Reimplemented from Socket.
Definition at line 29 of file DummySocket.h.
| byte* DummySocket::getWriteBuffer | ( | int | ) |
| void DummySocket::init | ( | ) |
| int DummySocket::pprintf | ( | int | , | |
| const char * | , | |||
| ... | ||||
| ) |
| int DummySocket::printf | ( | const char * | , | |
| ... | ||||
| ) |
| int DummySocket::read | ( | byte * | , | |
| int | ||||
| ) |
| int DummySocket::read | ( | void | ) |
| int DummySocket::setFlushType | ( | FlushType_t | ) |
| void DummySocket::setForward | ( | DummySocket * | ) |
sets another socket to send data to if this one is not connected
Definition at line 33 of file DummySocket.h.
| void DummySocket::setTextForward | ( | ) |
| void DummySocket::setVerbosity | ( | int | ) |
| int DummySocket::vprintf | ( | const char * | , | |
| va_list | ||||
| ) |
| int DummySocket::write | ( | const byte * | , | |
| int | ||||
| ) |
| void DummySocket::write | ( | int | ) |
Friends And Related Function Documentation
friend class Wireless [friend] |
Reimplemented from Socket.
Definition at line 18 of file DummySocket.h.
The documentation for this class was generated from the following file:
