Socket Class Reference
Tekkotsu wireless Socket class. More...
#include <Socket.h>
Detailed Description
Tekkotsu wireless Socket class.
For more information on using wireless, please read the following tutorials:
The networking interface needs more documentation. It also needs a cleanup. In the mean time, take a look at the TekkotsuMon objects in Tekkotsu/Behaviors/Mon. They all listen for new connections. Unfortunately, at the momement there are no examples of outgoing connections, but it should give you a pretty good idea how to start moving.
Definition at line 72 of file Socket.h.
Public Types | |
| enum | TransportType_t { SOCK_STREAM = ::SOCK_STREAM, SOCK_DGRAM = ::SOCK_DGRAM } |
Specifies transport type. TCP is usually a good idea. More... | |
| enum | ConnectionState { CONNECTION_CLOSED, CONNECTION_CONNECTING, CONNECTION_CONNECTED, CONNECTION_LISTENING, CONNECTION_CLOSING, CONNECTION_ERROR } |
Internal TCP/UDP Connection State. More... | |
| enum | FlushType_t { FLUSH_NONBLOCKING = 0, FLUSH_BLOCKING } |
Chooses between blocking and non-blocking Wireless Input, Output. Blocking wireless output from the main process will affect the performance of the Aibo, and should only be used for debugging purposes. More... | |
Public Member Functions | |
| Socket (int sockn) | |
| constructor | |
| virtual | ~Socket () |
| destructor | |
| byte * | getWriteBuffer (int bytesreq) |
| void | write (int size) |
| writes the specified number of bytes starting at the pointer returned. | |
| int | read () |
| Blocking read. NOT IMPLEMENTED. | |
| byte * | getReadBuffer () |
| getReadBuffer is used with blocking read's NOT IMPLEMENTED | |
| unsigned int | getMaxSendSize () const |
| returns the maximum buffer size for a send | |
| unsigned int | getMaxReceiveSize () const |
| returns the maximum buffer size for a receive | |
| unsigned int | getAvailableSendSize () const |
| returns the maximum *currently available* buffer size for a send | |
| unsigned int | getAvailableReceiveSize () const |
| returns the maximum *currently available* buffer size for a receive | |
| void | init () |
| initialize socket member variables. This is different from the constructor since sockets are reused | |
| int | setFlushType (FlushType_t fType) |
| Chooses between blocking and non-blocking input, output. | |
| FlushType_t | getFlushType () const |
| returns flush mode | |
| int | setTransport (TransportType_t tr) |
| can choose between different transports; will reset the socket | |
| TransportType_t | getTransport () const |
| returns the transport in use | |
| void | setTextForward () |
| causes this socket to forward output to stdout if it is not connected, call setForward(NULL) to unset | |
| void | setForward (Socket *forsock) |
| causes this socket to forward output to sock if it is not connected, pass NULL to unset | |
| void | setVerbosity (int verbose) |
| Picks a level of verbosity for filtering pprintf commands. | |
| int | write (const byte *buf, int size) |
| int | read (byte *buf, int size) |
| Blocking read (NOT IMPLEMENTED). | |
| int | printf (const char *fmt,...) __attribute__((format(printf |
| int int | vprintf (const char *fmt, va_list al) __attribute__((format(printf |
| int int int | pprintf (int vlevel, const char *fmt,...) __attribute__((format(printf |
| Similar to printf, except it takes an extra first argument. | |
| int int int void | flush () |
| bool | getDaemon () const |
| returns daemon | |
| int | getPeerAddress () const |
| returns the address of the remote host in local host byte order | |
| std::string | getPeerAddressAsString () const |
| returns the address of the remote host as a human-readable string | |
| int | getPeerPort () const |
| returns the port number that the remote host's socket is on | |
Public Attributes | |
| int | sock |
| unique non-negative integer representing socket. Serves as index into socket Objects array | |
Protected Types | |
| typedef char * | buf_t |
| a general buffer | |
| typedef int | endp_t |
| a unix socket descriptor | |
Protected Member Functions | |
| Socket (const Socket &) | |
| copy constructor, don't call | |
| Socket & | operator= (const Socket &) |
| assignment operator, don't call | |
Protected Attributes | |
| TransportType_t | trType |
| stores choice between transports (UDP or TCP (aka Datagram or Stream)) | |
| FlushType_t | flType |
| blocking or non-blocking flushes... note that blocking flushes only block on the handoff to the system, not actual transmission (at least under aperios) | |
| int | verbosity |
| can be used to filter calls to pprintf | |
| endp_t | endpoint |
| holds the endpoint data structure for the host OS | |
| ConnectionState | state |
| an enum representing the current state of the socket | |
| int | sendBufSize |
| the size of the buffer for sendData and writeData | |
| int | recvBufSize |
| the size of the buffer for readData and recvData | |
| int | sendSize |
| the size of sendData (total amount of data from last flush) | |
| int | sentSize |
| the sent portion of sendData (amount of data which has been sent to system so far) | |
| int | recvSize |
| the size of recvData (total amount of data returned by system) | |
| int | writeSize |
| the size of writeData (amount of data so far ready to be flushed) | |
| int | readSize |
| the size of readData (not used) | |
| bool | tx |
| a flag set when sendData is in the process of being sent to the system | |
| bool | rx |
| not used, see readData | |
| buf_t | sendBuffer |
| under aperios, a pointer to a shared region with the ip stack; under other OS, a pointer to a normal char * buffer | |
| byte * | sendData |
| a region within sendBuffer, holding data in the process of being sent | |
| byte * | writeData |
| a region within sendBuffer, holds data still being filled in by user code, not yet flushed | |
| buf_t | recvBuffer |
| under aperios, a pointer to a shared region with the ip stack; under other OS, a pointer to a normal char * buffer | |
| byte * | recvData |
| a region within recvBuffer, holding data either just filled in by ip stack (during call to rcvcbckfn), or in the process of being filled in (any other time) | |
| byte * | readData |
| not used (available for double buffering, but not implemented) | |
| int | server_port |
| if the socket is a server socket, this is the port it is listening on | |
| int(* | rcvcbckfn )(char *, int) |
| pointer to callback function, called after recvData has been filled in | |
| int | peer_addr |
| inet address of peer (if connected) or last message sender (if udp and bound); -1 otherwise (in host byte-order, not network byte-order!) | |
| int | peer_port |
| port of peer (if connected) or last message sender (if udp and bound); -1 otherwise | |
| bool | textForward |
| if true, when data is sent to the socket and the socket is not current connected, the data will be sent to stdout (overridden by forwardSock) | |
| char * | textForwardBuf |
| temporary buffer allocated in getWriteBuffer() and freed in write(), if the output is destined for stdout (textForward) | |
| Socket * | forwardSock |
| if non-NULL, output will be sent to this socket if the current socket is not otherwise connected (overrides textForward) | |
| bool | daemon |
| if true, the socket will automatically be reopened after any closure (manual or otherwise) | |
| SocketListener * | sckListener |
| if non-null, class based callback interface to provide notification when new data is available for reading | |
Friends | |
| class | Wireless |
Member Typedef Documentation
typedef char* Socket::buf_t [protected] |
typedef int Socket::endp_t [protected] |
Member Enumeration Documentation
| enum Socket::FlushType_t |
Chooses between blocking and non-blocking Wireless Input, Output. Blocking wireless output from the main process will affect the performance of the Aibo, and should only be used for debugging purposes.
- Enumerator:
Constructor & Destructor Documentation
| Socket::Socket | ( | const Socket & | ) | [protected] |
copy constructor, don't call
Member Function Documentation
| void Socket::flush | ( | ) |
Initiate blocking or nonblocking write transfer depending on the type of socket.
All write commands on the socket will implicity call this. You don't need to call it, unless you're implementing your own write
Reimplemented in DummySocket.
Definition at line 156 of file Socket.cc.
Referenced by Wireless::close(), flush(), Wireless::pollProcess(), Wireless::send(), vprintf(), and write().
| unsigned int Socket::getAvailableReceiveSize | ( | ) | const |
| unsigned int Socket::getAvailableSendSize | ( | ) | const |
| FlushType_t Socket::getFlushType | ( | ) | const |
| unsigned int Socket::getMaxReceiveSize | ( | ) | const |
| unsigned int Socket::getMaxSendSize | ( | ) | const |
| int Socket::getPeerAddress | ( | ) | const |
returns the address of the remote host in local host byte order
Definition at line 238 of file Socket.h.
Referenced by EventRouter::processData(), and RemoteEvents::remoteIPInt().
| std::string Socket::getPeerAddressAsString | ( | ) | const |
| int Socket::getPeerPort | ( | ) | const |
| byte * Socket::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 in DummySocket.
| TransportType_t Socket::getTransport | ( | ) | const |
returns the transport in use
Definition at line 174 of file Socket.h.
Referenced by SegCam::doEvent(), RegionCam::doEvent(), RawCam::doEvent(), and DepthCam::doEvent().
| byte * Socket::getWriteBuffer | ( | int | bytesreq | ) |
use getWriteBuffer to get a memory address to write bytes to, for subsequent writing to a connection.
The getWriteBuffer-write(int) combo eliminates one buffer copy. You don't need to use getWriteBuffer with write(byte*, int)
- Returns:
- pointer to the current position in the current write buffer for this socket or NULL on error
- Parameters:
-
bytesreq maximum number of bytes the caller intends to set before the write method is called
Reimplemented in DummySocket.
Definition at line 45 of file Socket.cc.
Referenced by LGmixin::displayHtmlText(), WorldStateSerializerBehavior::doEvent(), EventLogger::dumpNode(), getWriteBuffer(), SegCam::openPacket(), RegionCam::openPacket(), RawCam::openPacket(), DepthCam::openPacket(), EventLogger::processEvent(), WMMonitorBehavior::report(), DumpFileControl::selectedFile(), SegCam::sendCloseConnectionPacket(), RawCam::sendCloseConnectionPacket(), DepthCam::sendCloseConnectionPacket(), CameraStreamBehavior::sendSensors(), LGmixin::uploadCameraImage(), LGmixin::uploadFile(), LGmixin::uploadSketch(), and write().
| void Socket::init | ( | ) |
initialize socket member variables. This is different from the constructor since sockets are reused
Reimplemented in DummySocket.
Definition at line 109 of file Socket.cc.
Referenced by Wireless::close(), Wireless::connect(), Wireless::listen(), and setTransport().
| int Socket::pprintf | ( | int | vlevel, | |
| const char * | fmt, | |||
| ... | ||||
| ) |
Similar to printf, except it takes an extra first argument.
If vlevel is than or equal to the current verbosity level, the string will be printed else it will be ignored.
- Parameters:
-
vlevel if (vlevel<=verbosity) print, else ignore fmt same as the standard printf's format string
Reimplemented in DummySocket.
| int Socket::printf | ( | const char * | fmt, | |
| ... | ||||
| ) |
It's standard stuff. man 3 printf on most systems should give you more information
Reimplemented in DummySocket.
Definition at line 199 of file Socket.cc.
Referenced by HelpControl::activate(), WalkCalibration::addSample(), ArmMC::armJointValue(), PNGGenerator::calcImage(), JPEGGenerator::calcImage(), SensorObserverControl::checkLogFile(), EventLogger::checkLogFile(), ControlBase::clearMenu(), Controller::closeGUI(), ArmController::connect(), LGmixin::displayHtmlFile(), LGmixin::displayHtmlText(), LGmixin::displayImageFile(), SegCam::doEvent(), RegionGenerator::doEvent(), RawCameraGenerator::doEvent(), RawCam::doEvent(), FreeMemReportControl::doEvent(), FlashIPAddrBehavior::doEvent(), FilterBankGenerator::doEvent(), EStopController::doEvent(), EchoBehavior::doEvent(), DepthCam::doEvent(), CDTGenerator::doEvent(), CameraBehavior::doEvent(), BufferedImageGenerator::doEvent(), BallDetectionGenerator::doEvent(), ArmController::doEvent(), Transition::doFire(), ControlBase::doReadStdIn(), WalkCalibration::doSelect(), ValueEditControl< T >::doSelect(), ControlBase::doSelect(), Controller::doStop(), Controller::dumpStack(), HeadPointerMC::ensureValidJoint(), ArmMC::ensureValidJoint(), WalkCalibration::err(), FreeMemReportControl::freeMem(), PNGGenerator::getBinSize(), JPEGGenerator::getBinSize(), CameraBehavior::getNextName(), ArmController::gripper(), EventLogger::indent(), CameraBehavior::initIndex(), ControlBase::invalidInput(), PostureMC::isAlive(), HeadPointerMC::isAlive(), ArmMC::isAlive(), SegmentedColorGenerator::loadBuffer(), RLEGenerator::loadBuffer(), RegionGenerator::loadBuffer(), RawCameraGenerator::loadBuffer(), PNGGenerator::loadBuffer(), JPEGGenerator::loadBuffer(), InterleavedYUVGenerator::loadBuffer(), CDTGenerator::loadBuffer(), BufferedImageGenerator::loadBuffer(), SegmentedColorGenerator::loadColorInfo(), WalkCalibration::loadData(), SegmentedColorGenerator::loadThresholdMap(), CameraBehavior::openNextFile(), ArmController::pointPicked(), Controller::pop(), pprintf(), EchoBehavior::processCallback(), WalkCalibration::processEvent(), ValueEditControl< T >::processEvent(), SensorObserverControl::processEvent(), PostureEditor::processEvent(), EventLogger::processEvent(), EventLogger::processStateMachineEvent(), Controller::push(), LoadCalibration::readData(), LoadCalibration::readMaxs(), CameraStreamBehavior::receiveData(), TorqueCalibrate::record(), WaypointWalkControl::refresh(), WalkCalibration::refresh(), ValueEditControl< T >::refresh(), TorqueCalibrate::refresh(), FilterBankGenerator::refresh(), ControlBase::refresh(), ConfigurationEditor::NamedEnumerationEditor::refresh(), Controller::refreshSketchCamera(), Controller::refreshSketchLocal(), Controller::refreshSketchWorld(), RegionGenerator::RegionGenerator(), WMMonitorBehavior::registerData(), WMMonitorBehavior::report(), WalkCalibration::report(), HelpControl::report(), FreeMemReportControl::report(), EventLogger::runCommand(), EStopController::runCommand(), SegmentedColorGenerator::saveBuffer(), RLEGenerator::saveBuffer(), RegionGenerator::saveBuffer(), RawCameraGenerator::saveBuffer(), PNGGenerator::saveBuffer(), JPEGGenerator::saveBuffer(), InterleavedYUVGenerator::saveBuffer(), CDTGenerator::saveBuffer(), BufferedImageGenerator::saveBuffer(), WalkCalibration::saveData(), RawCameraGenerator::saveFileStream(), BufferedImageGenerator::saveFileStream(), LoadWalkControl::selectedFile(), DumpFileControl::selectedFile(), LGmixin::sendCommand(), ArmController::sendCoords(), ArmController::sendReachablePoints(), CameraStreamBehavior::sendSensors(), ArmController::setJoint(), WalkCalibration::setupMoving(), SegCam::setupServer(), RegionCam::setupServer(), RawCam::setupServer(), DepthCam::setupServer(), StateNode::start(), BatteryMonitorBehavior::startWarning(), StateNode::stop(), BatteryMonitorBehavior::stopWarning(), SaveWalkControl::takeInput(), ControlBase::takeInput(), Controller::takeLine(), LGmixin::uploadCameraImage(), LGmixin::uploadFile(), LGmixin::uploadSketch(), write(), and StateNode::~StateNode().
| int Socket::read | ( | byte * | buf, | |
| int | size | |||
| ) |
Blocking read (NOT IMPLEMENTED).
You might want to consider the read(void) and getReadBuffer combo if you call this often
Blocking read is currently broken - it will be fixed in the next release
- Parameters:
-
buf buffer to write from size number of bytes to write
- Returns:
- number of bytes actually read
Reimplemented in DummySocket.
| int Socket::read | ( | void | ) |
Blocking read. NOT IMPLEMENTED.
Tries to read upto receive buffer size worth of data from this socket.
Blocking read is currently broken - it will be fixed in the next release
- Returns:
- number of bytes read or -1 on error
Reimplemented in DummySocket.
| int Socket::setFlushType | ( | FlushType_t | fType | ) |
Chooses between blocking and non-blocking input, output.
This function can only be called when a socket is disconnected, since it is a bad idea to mix blocking and non-blocking input, output. The default for a socket is non-blocking
- Returns:
- 0 on success
Reimplemented in DummySocket.
| void Socket::setForward | ( | Socket * | forsock | ) |
| void Socket::setTextForward | ( | ) |
causes this socket to forward output to stdout if it is not connected, call setForward(NULL) to unset
Reimplemented in DummySocket.
| int Socket::setTransport | ( | TransportType_t | tr | ) |
| void Socket::setVerbosity | ( | int | verbose | ) |
Picks a level of verbosity for filtering pprintf commands.
The higher the verbosity, the more the number of messages printed. This is useful for filtering out non-important messages with very little processor cost. Default is 0.
- Parameters:
-
verbose the higher the value of verbose, the more the output
Reimplemented in DummySocket.
| int Socket::vprintf | ( | const char * | fmt, | |
| va_list | al | |||
| ) |
It's standard stuff. man 3 printf on most systems should give you more information
Reimplemented in DummySocket.
| int Socket::write | ( | const byte * | buf, | |
| int | size | |||
| ) |
Standard write - writes specified amount of data from a buffer to a connection
You might want to consider the getWriteBuffer-write(int) combo if you call this often
- Parameters:
-
buf buffer to write from size number of bytes to write
- Returns:
- the number of bytes actually written or -1 on error
Reimplemented in DummySocket.
| void Socket::write | ( | int | size | ) |
writes the specified number of bytes starting at the pointer returned.
in a (prior) call to getWriteBufer
- Parameters:
-
size number of bytes to be sent from the current write buffer
Reimplemented in DummySocket.
Definition at line 70 of file Socket.cc.
Referenced by SegCam::closePacket(), RegionCam::closePacket(), RawCam::closePacket(), DepthCam::closePacket(), LGmixin::displayHtmlText(), WorldStateSerializerBehavior::doEvent(), StringInputControl::doReadStdIn(), EventLogger::dumpNode(), Controller::loadGUI(), EventRouter::processData(), RemoteRouter::processEvent(), KoduDiscover::processEvent(), EventLogger::processEvent(), ControlBase::refresh(), WMMonitorBehavior::report(), DumpFileControl::selectedFile(), NetworkBuffer::send(), SegCam::sendCloseConnectionPacket(), RawCam::sendCloseConnectionPacket(), DepthCam::sendCloseConnectionPacket(), CameraStreamBehavior::sendSensors(), LGmixin::uploadCameraImage(), LGmixin::uploadFile(), LGmixin::uploadSketch(), and write().
Friends And Related Function Documentation
friend class Wireless [friend] |
Reimplemented in DummySocket.
Member Data Documentation
bool Socket::daemon [protected] |
if true, the socket will automatically be reopened after any closure (manual or otherwise)
Definition at line 287 of file Socket.h.
Referenced by Wireless::getDaemon(), getDaemon(), and Wireless::setDaemon().
endp_t Socket::endpoint [protected] |
holds the endpoint data structure for the host OS
Definition at line 256 of file Socket.h.
Referenced by Wireless::blockingSend(), Wireless::connect(), init(), Wireless::listen(), Wireless::pollProcess(), Wireless::pollSetup(), Wireless::send(), setTransport(), Socket(), and ~Socket().
FlushType_t Socket::flType [protected] |
blocking or non-blocking flushes... note that blocking flushes only block on the handoff to the system, not actual transmission (at least under aperios)
Definition at line 244 of file Socket.h.
Referenced by flush(), getFlushType(), and setFlushType().
Socket* Socket::forwardSock [protected] |
if non-NULL, output will be sent to this socket if the current socket is not otherwise connected (overrides textForward)
Definition at line 285 of file Socket.h.
Referenced by flush(), getWriteBuffer(), setForward(), setTextForward(), vprintf(), and write().
int Socket::peer_addr [protected] |
inet address of peer (if connected) or last message sender (if udp and bound); -1 otherwise (in host byte-order, not network byte-order!)
Definition at line 280 of file Socket.h.
Referenced by Wireless::close(), Wireless::connect(), getPeerAddress(), getPeerAddressAsString(), init(), and Wireless::pollProcess().
int Socket::peer_port [protected] |
port of peer (if connected) or last message sender (if udp and bound); -1 otherwise
Definition at line 281 of file Socket.h.
Referenced by Wireless::close(), Wireless::connect(), getPeerPort(), init(), and Wireless::pollProcess().
int(* Socket::rcvcbckfn)(char *, int) [protected] |
pointer to callback function, called after recvData has been filled in
Definition at line 278 of file Socket.h.
Referenced by Wireless::pollProcess(), and Wireless::setReceiver().
byte* Socket::readData [protected] |
int Socket::readSize [protected] |
buf_t Socket::recvBuffer [protected] |
int Socket::recvBufSize [protected] |
the size of the buffer for readData and recvData
Definition at line 260 of file Socket.h.
Referenced by getAvailableReceiveSize(), and getMaxReceiveSize().
byte* Socket::recvData [protected] |
a region within recvBuffer, holding data either just filled in by ip stack (during call to rcvcbckfn), or in the process of being filled in (any other time)
int Socket::recvSize [protected] |
the size of recvData (total amount of data returned by system)
Definition at line 263 of file Socket.h.
Referenced by Wireless::pollProcess().
bool Socket::rx [protected] |
SocketListener* Socket::sckListener [protected] |
if non-null, class based callback interface to provide notification when new data is available for reading
Definition at line 289 of file Socket.h.
Referenced by Wireless::pollProcess(), and Wireless::setReceiver().
buf_t Socket::sendBuffer [protected] |
under aperios, a pointer to a shared region with the ip stack; under other OS, a pointer to a normal char * buffer
Definition at line 269 of file Socket.h.
Referenced by Wireless::socket(), and ~Socket().
int Socket::sendBufSize [protected] |
the size of the buffer for sendData and writeData
Definition at line 259 of file Socket.h.
Referenced by getAvailableSendSize(), getMaxSendSize(), getWriteBuffer(), Wireless::socket(), and vprintf().
byte* Socket::sendData [protected] |
a region within sendBuffer, holding data in the process of being sent
Definition at line 270 of file Socket.h.
Referenced by Wireless::blockingSend(), flush(), Wireless::pollProcess(), and Wireless::send().
int Socket::sendSize [protected] |
the size of sendData (total amount of data from last flush)
Definition at line 261 of file Socket.h.
Referenced by Wireless::blockingSend(), flush(), init(), Wireless::pollProcess(), and Wireless::send().
int Socket::sentSize [protected] |
the sent portion of sendData (amount of data which has been sent to system so far)
Definition at line 262 of file Socket.h.
Referenced by Wireless::blockingSend(), Wireless::pollProcess(), and Wireless::send().
int Socket::server_port [protected] |
if the socket is a server socket, this is the port it is listening on
Definition at line 277 of file Socket.h.
Referenced by Wireless::listen().
| int Socket::sock |
unique non-negative integer representing socket. Serves as index into socket Objects array
Definition at line 76 of file Socket.h.
Referenced by Wireless::close(), SegCam::closeServer(), RegionCam::closeServer(), RawCam::closeServer(), DepthCam::closeServer(), Wireless::connect(), Controller::console_callback(), WorldStateSerializerBehavior::doEvent(), SegCam::doEvent(), RegionCam::doEvent(), RawCam::doEvent(), EchoBehavior::doEvent(), DepthCam::doEvent(), ConnectionMadeTrans::doEvent(), StringInputControl::doReadStdIn(), ControlBase::doReadStdIn(), WMMonitorBehavior::doStart(), HeadController::doStart(), EStopController::doStart(), Controller::doStart(), ArmController::doStart(), flush(), Wireless::getDaemon(), RemoteEvents::isConnected(), KoduDiscover::KoduDiscover(), Wireless::listen(), EventLogger::logImage(), EventLogger::logMessage(), EventLogger::logWebcam(), KoduDiscover::processEvent(), EventLogger::processEvent(), EventLogger::processStateMachineEvent(), WalkCalibration::refresh(), ValueEditControl< T >::refresh(), ControlBase::refresh(), ConfigurationEditor::NamedEnumerationEditor::refresh(), Wireless::setDaemon(), Wireless::setReceiver(), EchoBehavior::setupNetwork(), GamepadController::start(), LGmixin::uploadFile(), KoduDiscover::~KoduDiscover(), and LGmixin::~LGmixin().
ConnectionState Socket::state [protected] |
an enum representing the current state of the socket
Definition at line 257 of file Socket.h.
Referenced by Wireless::connect(), flush(), getWriteBuffer(), init(), Wireless::isConnected(), Wireless::isError(), Wireless::listen(), Wireless::pollProcess(), setFlushType(), vprintf(), and write().
bool Socket::textForward [protected] |
if true, when data is sent to the socket and the socket is not current connected, the data will be sent to stdout (overridden by forwardSock)
Definition at line 283 of file Socket.h.
Referenced by getWriteBuffer(), setForward(), setTextForward(), vprintf(), and write().
char* Socket::textForwardBuf [protected] |
temporary buffer allocated in getWriteBuffer() and freed in write(), if the output is destined for stdout (textForward)
Definition at line 284 of file Socket.h.
Referenced by getWriteBuffer(), and write().
TransportType_t Socket::trType [protected] |
stores choice between transports (UDP or TCP (aka Datagram or Stream))
Definition at line 243 of file Socket.h.
Referenced by getTransport(), init(), and setTransport().
bool Socket::tx [protected] |
a flag set when sendData is in the process of being sent to the system
Definition at line 266 of file Socket.h.
Referenced by Wireless::blockingSend(), flush(), Wireless::isReady(), Wireless::pollProcess(), and Wireless::send().
int Socket::verbosity [protected] |
can be used to filter calls to pprintf
Definition at line 246 of file Socket.h.
Referenced by pprintf(), and setVerbosity().
byte* Socket::writeData [protected] |
a region within sendBuffer, holds data still being filled in by user code, not yet flushed
Definition at line 271 of file Socket.h.
Referenced by flush(), getWriteBuffer(), and vprintf().
int Socket::writeSize [protected] |
the size of writeData (amount of data so far ready to be flushed)
Definition at line 264 of file Socket.h.
Referenced by flush(), getAvailableSendSize(), getWriteBuffer(), init(), vprintf(), and write().
The documentation for this class was generated from the following files:
