sza::util::NetStr Class Reference

Class for managing a read buffer and a send buffer both attached to the same file descriptor. More...

#include <carma/szautil/NetStr.h>

Public Member Functions
void	attach (int fd)
	Attach our network buffers to a file descriptor. More...
int	getFd ()
	Return the fd to which we are currently attached. More...
NetReadStr *	getReadStr ()
	Get a reference to our NetReadStr object. More...
NetSendStr *	getSendStr ()
	Get a reference to our NetSendStr object. More...
	NetStr ()
	Constructor. More...
	NetStr (int fd, unsigned long readSize, unsigned long sendSize)
	Constructor. More...
NetReadStr::NetReadId	read ()
	Read a message. More...
NetSendStr::NetSendId	send ()
	Send a message. More...
void	setReadBuffer (unsigned int *buffer, unsigned int size)
	Attach this network read buffer to a file descriptor. More...
void	setSendBuffer (unsigned int *buffer, unsigned int size)
	Attach this network send buffer to a file descriptor. More...
virtual	~NetStr ()
	Destructor. More...

Detailed Description

Class for managing a read buffer and a send buffer both attached to the same file descriptor.

Definition at line 21 of file NetStr.h.

Constructor & Destructor Documentation

sza::util::NetStr::NetStr

(

)

Constructor.

sza::util::NetStr::NetStr	(	int	fd,
		unsigned long	readSize,
		unsigned long	sendSize
	)

Constructor.

virtual sza::util::NetStr::~NetStr ( )

virtual

Destructor.

Member Function Documentation

void sza::util::NetStr::attach

(

int

fd

)

Attach our network buffers to a file descriptor.

int sza::util::NetStr::getFd

(

)

Return the fd to which we are currently attached.

NetReadStr* sza::util::NetStr::getReadStr

(

)

Get a reference to our NetReadStr object.

NetSendStr* sza::util::NetStr::getSendStr

(

)

Get a reference to our NetSendStr object.

NetReadStr::NetReadId sza::util::NetStr::read

(

)

Read a message.

NetSendStr::NetSendId sza::util::NetStr::send

(

)

Send a message.

void sza::util::NetStr::setReadBuffer	(	unsigned int *	buffer,
		unsigned int	size
	)

Attach this network read buffer to a file descriptor.

void sza::util::NetStr::setSendBuffer	(	unsigned int *	buffer,
		unsigned int	size
	)

Attach this network send buffer to a file descriptor.

---

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

• carma/szautil/NetStr.h