Cpl::Io::Tcp::InputOutput Class Reference

This concrete class defines a platform independent implementation of an InputOutput stream used by the Listener and Connector interfaces. More...

Detailed Description

This concrete class defines a platform independent implementation of an InputOutput stream used by the Listener and Connector interfaces.

Note: Platform independent is this context is that application can instantiate an instance of this class without any platform specific #include statements. However, the actual implementation IS platform specific.

#include <InputOutput.h>

Inheritance diagram for Cpl::Io::Tcp::InputOutput:

Collaboration diagram for Cpl::Io::Tcp::InputOutput:

Public Member Functions
	InputOutput ()
	Constructor.
	InputOutput (Cpl::Io::Descriptor fd)
	Constructor.
	~InputOutput (void)
	Destructor.
void	activate (Cpl::Io::Descriptor fd)
	Activates the stream, i.e.
bool	read (void *buffer, int numBytes, int &bytesRead)
	See Cpl::Io::Input.
bool	available ()
	See Cpl::Io::Input.
bool	write (const void *buffer, int maxBytes, int &bytesWritten)
	See Cpl::Io::Output.
void	flush ()
	See Cpl::Io::Output.
bool	isEos ()
	See Cpl::Io::IsEos.
void	close ()
	See Cpl::Io::Output.
Cpl::Io::Descriptor	getDescriptor ()
	USE THIS METHOD WITH CAUTION.
Public Member Functions inherited from Cpl::Io::Input
virtual bool	read (char &c)
	Reads a single byte from the stream.
virtual bool	read (Cpl::Text::String &destString)
	Reads N bytes into the String's internal buffer.
virtual	~Input ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Io::Close
virtual	~Close ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.
Public Member Functions inherited from Cpl::Io::IsEos
virtual	~IsEos ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Io::Output
virtual bool	write (char c)
	Writes a single byte to the stream.
virtual bool	write (const char *string)
	Writes a string to the stream.
virtual bool	write (const Cpl::Text::String &string)
	Writes a string to the stream.
virtual bool	write (Cpl::Text::String &formatBuffer, const char *format,...)
	Formatted write to the stream.
virtual bool	vwrite (Cpl::Text::String &formatBuffer, const char *format, va_list ap)
	Same as write( String& formatBuffer, const char* format,...), except that it is called with a va_list instead of a variable number of arguments.
virtual bool	write (const void *buffer, int numBytes)
	Writes the content of the buffer to the stream.
virtual	~Output ()
	Lets the make the destructor virtual.

Protected Attributes
Cpl::Io::Descriptor	m_fd
	Protocol Control Block.
bool	m_eos
	End-of-Stream status.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

InputOutput() [1/2]

Cpl::Io::Tcp::InputOutput::InputOutput

(

)

Constructor.

No 'fd' provided -->the instance MUST be activated prior to use.

InputOutput() [2/2]

Cpl::Io::Tcp::InputOutput::InputOutput

(

Cpl::Io::Descriptor

fd

)

Constructor.

'fd' is a PCB of a existing/opened TCP connection

~InputOutput()

Cpl::Io::Tcp::InputOutput::~InputOutput

(

void

)

Destructor.

Member Function Documentation

activate()

void Cpl::Io::Tcp::InputOutput::activate

(

Cpl::Io::Descriptor

fd

)

Activates the stream, i.e.

initializes the instance's underlying PCB. If the instance's 'fd' is not in the closed state when this method is called a fatal error is generated.

available()

bool Cpl::Io::Tcp::InputOutput::available ( )

virtual

See Cpl::Io::Input.

Implements Cpl::Io::Input.

close()

void Cpl::Io::Tcp::InputOutput::close ( )

virtual

See Cpl::Io::Output.

Implements Cpl::Io::Close.

flush()

void Cpl::Io::Tcp::InputOutput::flush ( )

virtual

See Cpl::Io::Output.

Implements Cpl::Io::Output.

getDescriptor()

Cpl::Io::Descriptor Cpl::Io::Tcp::InputOutput::getDescriptor ( )

inline

USE THIS METHOD WITH CAUTION.

This method returns the Stream's internal 'file descriptor'

isEos()

bool Cpl::Io::Tcp::InputOutput::isEos ( )

virtual

See Cpl::Io::IsEos.

Implements Cpl::Io::IsEos.

read()

bool Cpl::Io::Tcp::InputOutput::read ( void *  buffer, int  numBytes, int &  bytesRead  )

virtual

See Cpl::Io::Input.

Implements Cpl::Io::Input.

write()

bool Cpl::Io::Tcp::InputOutput::write ( const void *  buffer, int  maxBytes, int &  bytesWritten  )

virtual

See Cpl::Io::Output.

Implements Cpl::Io::Output.

Member Data Documentation

m_eos

bool Cpl::Io::Tcp::InputOutput::m_eos

protected

End-of-Stream status.

m_fd

Cpl::Io::Descriptor Cpl::Io::Tcp::InputOutput::m_fd

protected

Protocol Control Block.

---

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

• Cpl/Io/Tcp/InputOutput.h