openjaus::transport::AS5669::JtcpStream Class Reference

This is a brief description. More...

#include <JtcpStream.h>

Inherits openjaus::system::Buffer.

Public Member Functions
	JtcpStream ()
virtual	~JtcpStream ()
unsigned char	getVersion () const
	Accessor to get the value of version. More...
bool	isVersionSent () const
	Accessor to get the value of versionSent. More...
const system::Packet &	getPacket () const
	Accessor to get the value of packet. More...
const TCPAddress &	getAddress () const
	Accessor to get the value of address. More...
bool	setAddress (const TCPAddress &address)
	Accessor to set value of address. More...
transport::WrapperType	nextWrapperType ()
	Serializes object to internal transport buffer. More...
transport::Wrapper *	popWrapper ()
system::Packet &	packetize (transport::Wrapper &wrapper)
virtual std::string	toString () const
Public Member Functions inherited from openjaus::system::Buffer
	Buffer (uint64 size)
	Creates a Buffer of size bytes. More...
	Buffer (const Buffer &other)
	Copies the incoming Buffer into a new a Buffer. More...
virtual	~Buffer ()
BufferReader &	getReader ()
	Get a reference to the BufferReader. More...
BufferWriter &	getWriter ()
	Get a reference to the BufferWriter. More...
uint64	getMaxSize () const
uint64	setMaxSize (uint64 size)
uint64	bytesContained () const
virtual uint64	to (BufferWriter &dst) const
	Copy data from this Buffer starting at the current position 0 to the Buffer connected to the provided BufferWriter. More...
virtual uint64	from (BufferReader &src)
	Copy data from the Buffer connected to the provided BufferReader into this Buffer. More...
virtual uint64	length () const
	Gets the serialized length of this object. More...
virtual uint64	to (BufferWriter &dst, uint64 length) const
	Copy data from this Buffer starting at the current position 0 to the Buffer connected to the provided BufferWriter. More...
virtual uint64	from (BufferReader &src, uint64 length)
	Copy data from the Buffer connected to the provided BufferReader into this Buffer. More...
std::string	toString (int byteCount) const
Buffer &	operator= (const Buffer &rhs)
bool	operator== (const Buffer &other) const
Public Member Functions inherited from openjaus::system::Transportable
	Transportable ()
virtual	~Transportable ()

Protected Attributes
unsigned char	version
bool	versionSent
system::Packet	packet
TCPAddress	address

Static Protected Attributes
static const int	MAX_PAYLOAD_SIZE = 4084
static const int	MAX_PACKET_SIZE = 4101
static const unsigned char	STANDARD_VERSION = 2

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const JtcpStream &object)
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const JtcpStream *object)

Detailed Description

Detailed description.

Author

Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

JtcpStream()

openjaus::transport::AS5669::JtcpStream::JtcpStream

(

)

~JtcpStream()

openjaus::transport::AS5669::JtcpStream::~JtcpStream ( )

virtual

Member Function Documentation

getAddress()

const TCPAddress & openjaus::transport::AS5669::JtcpStream::getAddress

(

)

const

getPacket()

const system::Packet & openjaus::transport::AS5669::JtcpStream::getPacket

(

)

const

getVersion()

unsigned char openjaus::transport::AS5669::JtcpStream::getVersion

(

)

const

isVersionSent()

bool openjaus::transport::AS5669::JtcpStream::isVersionSent

(

)

const

nextWrapperType()

transport::WrapperType openjaus::transport::AS5669::JtcpStream::nextWrapperType

(

)

packetize()

system::Packet & openjaus::transport::AS5669::JtcpStream::packetize

(

transport::Wrapper &

wrapper

)

Parameters

wrapper

popWrapper()

transport::Wrapper * openjaus::transport::AS5669::JtcpStream::popWrapper

(

)

setAddress()

bool openjaus::transport::AS5669::JtcpStream::setAddress

(

const TCPAddress &

address

)

Parameters

address

The value of the new address.

toString()

std::string openjaus::transport::AS5669::JtcpStream::toString ( ) const

virtual

Reimplemented from openjaus::system::Buffer.

Friends And Related Function Documentation

operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const JtcpStream &  object  )

friend

operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const JtcpStream *  object  )

friend

Member Data Documentation

address

TCPAddress openjaus::transport::AS5669::JtcpStream::address

protected

MAX_PACKET_SIZE

const int openjaus::transport::AS5669::JtcpStream::MAX_PACKET_SIZE = 4101

staticprotected

MAX_PAYLOAD_SIZE

const int openjaus::transport::AS5669::JtcpStream::MAX_PAYLOAD_SIZE = 4084

staticprotected

packet

system::Packet openjaus::transport::AS5669::JtcpStream::packet

protected

STANDARD_VERSION

const unsigned char openjaus::transport::AS5669::JtcpStream::STANDARD_VERSION = 2

staticprotected

version

unsigned char openjaus::transport::AS5669::JtcpStream::version

protected

versionSent

bool openjaus::transport::AS5669::JtcpStream::versionSent

protected

---

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

• include/openjaus/transport/AS5669/JtcpStream.h
• src/openjaus/transport/AS5669/JtcpStream.cpp