My Project
 All Classes Files Functions Variables Enumerations Enumerator Friends Macros Pages
gcp::util::NetReadStr Class Reference

Public Types

enum  NetReadId {
  NET_READ_SIZE = gcp::control::NetReadStr::NET_READ_SIZE, NET_READ_DATA = gcp::control::NetReadStr::NET_READ_DATA, NET_READ_DONE = gcp::control::NetReadStr::NET_READ_DONE, NET_READ_CLOSED = gcp::control::NetReadStr::NET_READ_CLOSED,
  NET_READ_ERROR = gcp::control::NetReadStr::NET_READ_ERROR
}
 

Public Member Functions

 NetReadStr ()
 
 NetReadStr (int fd, unsigned int size)
 
virtual ~NetReadStr ()
 
void attach (int fd)
 
void setBuffer (void *buffer, unsigned int size)
 
NetReadId read ()
 
NetReadId read (int fd)
 
NetReadId state ()
 
int getFd ()
 
void startGet (int *opcode)
 
void endGet ()
 
void getChar (int ndata, unsigned char *data)
 
void getShort (int ndata, unsigned short *data)
 
void getInt (int ndata, unsigned int *data)
 
void getFloat (int ndata, float *data)
 
void getDouble (int ndata, double *data)
 
void getObj (const NetObjTable *types, int id, void *obj)
 
void incNget (int nbytes)
 
void installReadHandler (NET_READ_HANDLER(*handler), void *arg)
 
void installErrorHandler (NET_ERROR_HANDLER(*handler), void *arg)
 

Constructor & Destructor Documentation

NetReadStr::NetReadStr ( )

Constructor.

....................................................................... Constructor.

NetReadStr::NetReadStr ( int  fd,
unsigned int  size 
)

Constructor with file descriptor and size.

....................................................................... Constructor with file descriptor and size.

NetReadStr::~NetReadStr ( )
virtual

Destructor.

....................................................................... Destructor.

Member Function Documentation

void NetReadStr::attach ( int  fd)

Attach this network buffer to a file descriptor.

....................................................................... Attach this network buffer to a file descriptor.

void NetReadStr::endGet ( )

Finish unpacking a message from a network buffer.

....................................................................... Finish unpacking a message from a network buffer.

void NetReadStr::getChar ( int  ndata,
unsigned char *  data 
)

Get a char from a network buffer.

....................................................................... Get a char from a network buffer.

void NetReadStr::getDouble ( int  ndata,
double *  data 
)

Get a double from a network buffer.

....................................................................... Get a double from a network buffer.

int NetReadStr::getFd ( )

Return the file descriptor to which we're currently attached.

....................................................................... Return the file descriptor to which we're currently attached.

void NetReadStr::getFloat ( int  ndata,
float *  data 
)

Get a float from a network buffer.

....................................................................... Get a float from a network buffer.

void NetReadStr::getInt ( int  ndata,
unsigned int *  data 
)

Get a int from a network buffer.

....................................................................... Get a int from a network buffer.

void NetReadStr::getObj ( const NetObjTable types,
int  id,
void *  obj 
)

Read an object from a network buffer.

....................................................................... Pack an object to a network buffer.

void NetReadStr::getShort ( int  ndata,
unsigned short *  data 
)

Get a short from a network buffer.

....................................................................... Get a short from a network buffer.

void NetReadStr::incNget ( int  nbytes)

Incrementally read bytes from a network buffer.

....................................................................... Incrementally read bytes from a network buffer.

void NetReadStr::installErrorHandler ( NET_ERROR_HANDLER *  handler,
void *  arg 
)

Install an error handler.

....................................................................... Install a error handler

void NetReadStr::installReadHandler ( NET_READ_HANDLER *  handler,
void *  arg 
)

Install a read handler.

....................................................................... Install a read handler

NetReadStr::NetReadId NetReadStr::read ( )

Read a message into our network buffer from a socket described by a previously attached fd.

....................................................................... Read a message into our network buffer from a socket.

NetReadStr::NetReadId NetReadStr::read ( int  fd)

Read a message into our network buffer from the specified socket.

....................................................................... Read a message into our network buffer from a socket.

void NetReadStr::setBuffer ( void *  buffer,
unsigned int  size 
)

Set the network buffer pointing to an external buffer, or pass buffer=NULL to dynamically allocate it.

....................................................................... Attach this network buffer to a file descriptor.

void NetReadStr::startGet ( int *  opcode)

Start unpacking a message from a network buffer.

....................................................................... Start unpacking a message from a network buffer.

NetReadStr::NetReadId NetReadStr::state ( )

Return the last read state

....................................................................... Public method to return the state.


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