CigiIO Class Reference

#include <CigiIO.h>

List of all members.

Public Member Functions
	CigiIO (CigiIncomingMsg &InMsg, CigiOutgoingMsg &OutMsg)
virtual	~CigiIO ()
int	Send (void)
int	Receive (void)
int	Recv (void)
Protected Member Functions
virtual int	Write (Cigi_uint8 *Buffer, int Length)=0
virtual int	Read (Cigi_uint8 *Buffer, int MaxLength)=0
Protected Attributes
CigiIncomingMsg &	MsgIn
CigiOutgoingMsg &	MsgOut

---

Detailed Description

The base class for Cigi IO.
This class must be inherited.

Definition at line 58 of file CigiIO.h.

---

Constructor & Destructor Documentation

CigiIO::CigiIO	(	CigiIncomingMsg &	InMsg,
		CigiOutgoingMsg &	OutMsg
	)

General Constructor

Definition at line 68 of file CigiIO.cpp.

References CigiOutgoingMsg::BeginMsg(), CIGI_SUCCESS, and MsgOut.

       : MsgIn(InMsg), MsgOut(OutMsg)
{
   int stat = CIGI_SUCCESS;

   stat = MsgOut.BeginMsg();

}

CigiIO::~CigiIO

(

)

[virtual]

General Destructor

Definition at line 80 of file CigiIO.cpp.

{

}

---

Member Function Documentation

virtual int CigiIO::Read	(	Cigi_uint8 *	Buffer,
		int	MaxLength
	)			[protected, pure virtual]

A pure virtual function to input the data.
This function is not implemented by this class.

Parameters:

	Buffer	- A pointer to the buffer to fill.
	MaxLength	- The maximum length allowed for the message in bytes.

Returns:

This returns the number of bytes in the message

Referenced by Receive(), and Recv().

int CigiIO::Receive

(

void

)

Receive and processes a message

Returns:

This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 118 of file CigiIO.cpp.

References CigiIncomingMsg::AdvanceCrntBuffer(), CIGI_ERROR_MISCELLANEOUS, CIGI_SUCCESS, CigiIncomingMsg::GetMsgBuffer(), CigiIncomingMsg::GetMsgBufSize(), MsgIn, CigiIncomingMsg::ProcessIncomingMsg(), Read(), and CigiIncomingMsg::SetCrntMsgSize().

{
   int stat = CIGI_SUCCESS;

   MsgIn.AdvanceCrntBuffer();

   Cigi_uint8 *NextBuf = MsgIn.GetMsgBuffer();

   int size = Read(NextBuf,MsgIn.GetMsgBufSize());

   if(size > 0)
   {
      MsgIn.SetCrntMsgSize(size);

      MsgIn.ProcessIncomingMsg();

   }
   else
   {
      size = 0;
      stat = CIGI_ERROR_MISCELLANEOUS;
      MsgIn.SetCrntMsgSize(size);
   }

   return(stat);

}

int CigiIO::Recv

(

void

)

Receive a message and store it for later processing

Returns:

This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 150 of file CigiIO.cpp.

References CigiIncomingMsg::AdvanceCrntBuffer(), CIGI_ERROR_MISCELLANEOUS, CIGI_SUCCESS, CigiIncomingMsg::GetMsgBuffer(), CigiIncomingMsg::GetMsgBufSize(), MsgIn, Read(), and CigiIncomingMsg::SetCrntMsgSize().

{
   int stat = CIGI_SUCCESS;

   MsgIn.AdvanceCrntBuffer();

   Cigi_uint8 *NextBuf = MsgIn.GetMsgBuffer();

   int size = Read(NextBuf,MsgIn.GetMsgBufSize());

   if(size > 0)
   {
      MsgIn.SetCrntMsgSize(size);

      MsgIn.AdvanceCrntBuffer();

   }
   else
   {
      size = 0;
      stat = CIGI_ERROR_MISCELLANEOUS;
      MsgIn.SetCrntMsgSize(size);
   }

   return(stat);

}

int CigiIO::Send

(

void

)

Processes and send a message.

Returns:

This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 92 of file CigiIO.cpp.

References CigiOutgoingMsg::BeginMsg(), CIGI_SUCCESS, CigiOutgoingMsg::GetMsg(), CigiOutgoingMsg::LockMsg(), MsgOut, CigiOutgoingMsg::UnlockMsg(), CigiOutgoingMsg::UpdateFrameCntr(), and Write().

{
   Cigi_uint8 *buff;
   int len;

   int stat = CIGI_SUCCESS;

   stat = MsgOut.UpdateFrameCntr();

   stat = MsgOut.LockMsg();

        buff = MsgOut.GetMsg(len);

   Write(buff,len);

   stat = MsgOut.UnlockMsg();

   stat = MsgOut.BeginMsg();  // prep for next message

   return(stat);

}

virtual int CigiIO::Write	(	Cigi_uint8 *	Buffer,
		int	Length
	)			[protected, pure virtual]

A pure virtual function to output the data.
This function is not implemented by this class.

Parameters:

	Buffer	- A pointer to the buffer to write
	Length	- The length of the message in bytes.

Returns:

This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Referenced by Send().

---

Member Data Documentation

CigiIncomingMsg& CigiIO::MsgIn [protected]

Message In
A referance to a Cigi incoming message object.

Definition at line 109 of file CigiIO.h.

Referenced by Receive(), and Recv().

CigiOutgoingMsg& CigiIO::MsgOut [protected]

Message Out
A referance to a Cigi outgoing message object.

Definition at line 115 of file CigiIO.h.

Referenced by CigiIO(), and Send().

---

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

• ccl/include/CigiIO.h
• ccl/source/CigiIO.cpp

---