gcp::util::NetCommHandler Class Reference

Public Member Functions
	NetCommHandler ()
virtual	~NetCommHandler ()
void	attachReadStream (int fd)
void	attachSendStream (int fd)
void	attach (int fd)
void	packNetMsg (NetMsg *msg)
bool	packNewRtcNetMsg (NetMsg *msg)
void	packNetCmd (NetCmd *cmd)
void	packRtcNetCmd (gcp::control::RtcNetCmd *cmd, gcp::control::NetCmdId opcode)
gcp::util::NetReadStr::NetReadId	readNetMsg ()
gcp::util::NetSendStr::NetSendId	sendNetMsg ()
gcp::util::NetReadStr::NetReadId	readNetCmd ()
gcp::util::NetSendStr::NetSendId	sendNetCmd ()
gcp::util::NetCmd *	getLastReadNetCmd ()
gcp::util::NetCmd *	getLastSentNetCmd ()
gcp::util::NetMsg *	getLastReadNetMsg ()
gcp::util::NetMsg *	getLastSentNetMsg ()
int	getReadFd ()
int	getSendFd ()
int	getFd ()
NetMsgHandler *	getNetMsgHandler ()
NetCmdHandler *	getNetCmdHandler ()
AntNum::Id	getId ()
unsigned	getIntId ()
void	setId (AntNum::Id id)

Constructor & Destructor Documentation

NetCommHandler::NetCommHandler

(

)

Constructor.

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

NetCommHandler::~NetCommHandler ( )

virtual

Destructor.

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

Member Function Documentation

void NetCommHandler::attach

(

int

fd

)

Attach all streams to an fd

....................................................................... Attach all network I/O streams to the same socket.

void NetCommHandler::attachReadStream

(

int

fd

)

Attach the read network I/O streams to a socket.

....................................................................... Attach the network I/O streams to a socket.

void NetCommHandler::attachSendStream

(

int

fd

)

Attach the send network I/O streams to a socket.

....................................................................... Attach the network I/O streams to a socket.

int NetCommHandler::getFd

(

)

Return the single fd that both streams are attached to.

....................................................................... Return a single fd. It is assumed that all streams in this handler are attached to the same socket.

AntNum::Id gcp::util::NetCommHandler::getId ( )

inline

Return the antenna id of this handler

gcp::util::NetCmd * NetCommHandler::getLastReadNetCmd

(

)

Return the last read command

....................................................................... Return the last read command

gcp::util::NetMsg * NetCommHandler::getLastReadNetMsg

(

)

Return the last read message

....................................................................... Return the last read message

gcp::util::NetCmd * NetCommHandler::getLastSentNetCmd

(

)

Return the last sent command

....................................................................... Return the last sent command

gcp::util::NetMsg * NetCommHandler::getLastSentNetMsg

(

)

Return the last sent message

....................................................................... Return the last sent message

NetCmdHandler * NetCommHandler::getNetCmdHandler

(

)

Return a pointer to our NetCmd handler

....................................................................... Return a pointer to our NetCmd handler

NetMsgHandler * NetCommHandler::getNetMsgHandler

(

)

Return a pointer to our NetMsg handler.

....................................................................... Return a pointer to our NetMsg handler.

int NetCommHandler::getReadFd

(

)

Return the fd that our read streams are attached to.

....................................................................... Return read fd.

int NetCommHandler::getSendFd

(

)

....................................................................... Return send fd.

void NetCommHandler::packNetCmd

(

NetCmd *

cmd

)

Pack a network command into our send buffer

....................................................................... Pack a network command into our send buffer

void NetCommHandler::packNetMsg

(

NetMsg *

msg

)

Pack a network message into our send buffer

....................................................................... Pack a network message into our send buffer

bool NetCommHandler::packNewRtcNetMsg

(

NetMsg *

msg

)

Pack a network message into our send buffer

....................................................................... Pack a network message into our send buffer

void NetCommHandler::packRtcNetCmd	(	gcp::control::RtcNetCmd *	rtc,
		gcp::control::NetCmdId	opcode
	)

Pack a network command into our send buffer

....................................................................... Pack a network command into our send buffer

NetReadStr::NetReadId NetCommHandler::readNetCmd

(

)

Read a command into our read buffer.

....................................................................... Read all or part of a control-program command from the network. If the command is completely received, interpret it and prepare for the next command. Otherwise postpone interpreting the message until a future call to this function receives its completion.

NetReadStr::NetReadId NetCommHandler::readNetMsg

(

)

Read a message into our read buffer.

....................................................................... Read all or part of a control-program message from the network. If the message is completely received, interpret it and prepare for the next command. Otherwise postpone interpreting the message until a future call to this function receives its completion.

NetSendStr::NetSendId NetCommHandler::sendNetCmd

(

)

Send a command in our send buffer.

....................................................................... Send a command previously packed into our network buffer to a socket described by a previously attached fd.

NetSendStr::NetSendId NetCommHandler::sendNetMsg

(

)

Send a message in our read buffer.

....................................................................... Send a message previously packed into our network buffer to a socket described by a previously attached fd.

void gcp::util::NetCommHandler::setId ( AntNum::Id  id )

inline

Setthe antenna id of this handler

---

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

• gcpCbass/util/common/NetCommHandler.h
• gcpCbass/util/common/NetCommHandler.cc