Homepage

Demos

Overview

Downloads

Tutorials

Reference

Credits

Socket Class Reference

#include <Socket.h>

Inheritance diagram for Socket:

[legend]List of all members.

---

Detailed Description

Tekkotsu wireless Socket class.

For more information on using wireless, please read the following tutorials:

• TekkotsuMon
• TCP/IP
• Remote Processing OPENR Tekkotsu Wireless and Remote Processing OPENR provide different interfaces to comparable wireless functionality.

Definition at line 47 of file Socket.h.

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.
byte *	getReadBuffer ()
	getReadBuffer is used with blocking read's
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.
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.
int	printf (const char *fmt,...)
int	vprintf (const char *fmt, va_list al)
int	pprintf (int vlevel, const char *fmt,...)
	Similar to printf, except it takes an extra first argument.
void	flush ()
Public Attributes
int	sock
	unique non-negative integer representing socket. Serves as index into socket Objects array
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
	private ALOKL_TODO
FlushType_t	flType
	private ALOKL_TODO
int	verbosity
	private ALOKL_TODO
antModuleRef	endpoint
	private ALOKL_TODO
ConnectionState	state
	private ALOKL_TODO
int	sendBufSize
	private ALOKL_TODO
int	recvBufSize
	private ALOKL_TODO
int	sendSize
	private ALOKL_TODO
int	recvSize
	private ALOKL_TODO
int	writeSize
	private ALOKL_TODO
int	readSize
	private ALOKL_TODO
bool	tx
	private ALOKL_TODO
bool	rx
	private ALOKL_TODO
antSharedBuffer	sendBuffer
	private ALOKL_TODO
antSharedBuffer	recvBuffer
	private ALOKL_TODO
byte *	sendData
	private ALOKL_TODO
byte *	recvData
	private ALOKL_TODO
byte *	readData
	private ALOKL_TODO
byte *	writeData
	private ALOKL_TODO
int	server_port
	private ALOKL_TODO
int(*	rcvcbckfn )(char *, int)
	private ALOKL_TODO
bool	textForward
	private ALOKL_TODO
char *	textForwardBuf
	private ALOKL_TODO
Socket *	forwardSock
	private ALOKL_TODO
bool	daemon
	private ALOKL_TODO
Friends
class	Wireless

---

Constructor & Destructor Documentation

Socket::Socket (  int  sockn  )  [inline]

constructor Definition at line 55 of file Socket.h. References SocketNS::CONNECTION_CLOSED, daemon, endpoint, flType, SocketNS::FLUSH_NONBLOCKING, forwardSock, rcvcbckfn, readData, readSize, recvBuffer, recvBufSize, recvData, recvSize, rx, sendBuffer, sendBufSize, sendData, sendSize, server_port, sock, state, textForward, textForwardBuf, trType, tx, verbosity, writeData, and writeSize.

virtual Socket::~Socket (   )  [inline, virtual]

destructor Definition at line 64 of file Socket.h.

Socket::Socket (  const Socket &   )  [protected]

copy constructor, don't call

---

Member Function Documentation

void Socket::flush (   )

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 66 of file Socket.cc. References Wireless::blockingSend(), SocketNS::CONNECTION_CONNECTED, flType, SocketNS::FLUSH_NONBLOCKING, forwardSock, Wireless::send(), sendData, sendSize, sock, state, tx, wireless, writeData, and writeSize.

Here is the call graph for this function:

byte * Socket::getReadBuffer (   )

getReadBuffer is used with blocking read's 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. Definition at line 44 of file Socket.cc.

byte * Socket::getWriteBuffer (  int  bytesreq  )

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 11 of file Socket.cc. References SocketNS::CONNECTION_CONNECTED, forwardSock, sendBufSize, state, state, textForward, textForwardBuf, writeData, and writeSize.

void Socket::init (   )

initialize socket member variables. This is different from the constructor since sockets are reused Reimplemented in DummySocket. Definition at line 51 of file Socket.cc. References sendSize, and writeSize.

Socket& Socket::operator= (  const Socket &   )  [protected]

assignment operator, don't call

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. Definition at line 92 of file Socket.cc. References printf(), and verbosity.

Here is the call graph for this function:

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 106 of file Socket.cc. References vprintf().

Here is the call graph for this function:

int Socket::read (  byte *  buf, int  size )

Blocking read. 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. Definition at line 157 of file Socket.cc.

int Socket::read (   )

Blocking read. 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. Definition at line 38 of file Socket.cc.

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. Definition at line 58 of file Socket.cc. References SocketNS::CONNECTION_CLOSED, flType, and state.

void Socket::setForward (  Socket *  forsock  )  [inline]

causes this socket to forward output to sock if it is not connected, pass NULL to unset Definition at line 117 of file Socket.h. References forwardSock, and textForward.

void Socket::setTextForward (   )  [inline]

causes this socket to forward output to stdout if it is not connected, call setForward(NULL) to unset Reimplemented in DummySocket. Definition at line 114 of file Socket.h. References forwardSock, and textForward.

void Socket::setVerbosity (  int  verbose  )  [inline]

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. Definition at line 126 of file Socket.h. References verbosity.

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. Definition at line 116 of file Socket.cc. References SocketNS::CONNECTION_CONNECTED, flush(), forwardSock, sendBufSize, state, textForward, writeData, and writeSize.

Here is the call graph for this function:

int Socket::write (  const byte *  buf, int  size )

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. Definition at line 139 of file Socket.cc. References SocketNS::CONNECTION_CONNECTED, forwardSock, getWriteBuffer(), state, textForward, and write().

Here is the call graph for this function:

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 26 of file Socket.cc. References flush(), textForwardBuf, and writeSize.

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class Wireless [friend]

Reimplemented in DummySocket. Definition at line 48 of file Socket.h.

---

Member Data Documentation

bool Socket::daemon [protected]

private ALOKL_TODO Definition at line 198 of file Socket.h.

antModuleRef Socket::endpoint [protected]

private ALOKL_TODO Definition at line 182 of file Socket.h.

FlushType_t Socket::flType [protected]

private ALOKL_TODO Definition at line 178 of file Socket.h.

Socket* Socket::forwardSock [protected]

private ALOKL_TODO Definition at line 196 of file Socket.h.

int(* Socket::rcvcbckfn)(char*, int) [protected]

private ALOKL_TODO

byte* Socket::readData [protected]

private ALOKL_TODO Definition at line 190 of file Socket.h.

int Socket::readSize [protected]

private ALOKL_TODO Definition at line 185 of file Socket.h.

antSharedBuffer Socket::recvBuffer [protected]

private ALOKL_TODO Definition at line 188 of file Socket.h.

int Socket::recvBufSize [protected]

private ALOKL_TODO Definition at line 185 of file Socket.h.

byte * Socket::recvData [protected]

private ALOKL_TODO Definition at line 189 of file Socket.h.

int Socket::recvSize [protected]

private ALOKL_TODO Definition at line 185 of file Socket.h.

bool Socket::rx [protected]

private ALOKL_TODO Definition at line 186 of file Socket.h.

antSharedBuffer Socket::sendBuffer [protected]

private ALOKL_TODO Definition at line 188 of file Socket.h.

int Socket::sendBufSize [protected]

private ALOKL_TODO Definition at line 185 of file Socket.h.

byte* Socket::sendData [protected]

private ALOKL_TODO Definition at line 189 of file Socket.h.

int Socket::sendSize [protected]

private ALOKL_TODO Definition at line 185 of file Socket.h.

int Socket::server_port [protected]

private ALOKL_TODO Definition at line 191 of file Socket.h.

int Socket::sock

unique non-negative integer representing socket. Serves as index into socket Objects array Definition at line 51 of file Socket.h.

ConnectionState Socket::state [protected]

private ALOKL_TODO Definition at line 183 of file Socket.h.

bool Socket::textForward [protected]

private ALOKL_TODO Definition at line 194 of file Socket.h.

char* Socket::textForwardBuf [protected]

private ALOKL_TODO Definition at line 195 of file Socket.h.

TransportType_t Socket::trType [protected]

private ALOKL_TODO Definition at line 177 of file Socket.h.

bool Socket::tx [protected]

private ALOKL_TODO Definition at line 186 of file Socket.h.

int Socket::verbosity [protected]

private ALOKL_TODO Definition at line 180 of file Socket.h.

byte * Socket::writeData [protected]

private ALOKL_TODO Definition at line 190 of file Socket.h.

int Socket::writeSize [protected]

private ALOKL_TODO Definition at line 185 of file Socket.h.

---

The documentation for this class was generated from the following files:

• Socket.h
• Socket.cc

Tekkotsu v1.5

Generated Fri Oct 10 15:57:31 2003 by Doxygen 1.3.4