OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
openjaus::transport::AS5669::JtcpPacket Class Reference

This is a brief description. More...

#include <JtcpPacket.h>

Inherits openjaus::system::Packet.

Public Member Functions

 JtcpPacket ()
 
virtual ~JtcpPacket ()
 
unsigned char getVersion () const
 Accessor to get the value of version. More...
 
const std::vector< transport::Wrapper *> & getWrappers () const
 Accessor to get the value of wrappers. More...
 
bool setWrappers (const transport::Wrapper &wrappers)
 Accessor to set value of wrappers. More...
 
transport::WrapperType nextWrapperType ()
 Serializes object to internal transport buffer. More...
 
transport::WrapperpopWrapper ()
 
bool pushWrapper (transport::Wrapper *newWrapper)
 Operation pushWrapper. More...
 
unsigned char * reset ()
 Operation reset. More...
 
virtual std::string toString () const
 
- Public Member Functions inherited from openjaus::system::Packet
 Packet ()
 
virtual ~Packet ()
 
 Packet (int size)
 
uint16_t getPort () const
 Accessor to get the value of port. More...
 
bool setPort (uint16_t port)
 Accessor to set value of port. More...
 
const InetAddressgetAddress () const
 Accessor to get the value of address. More...
 
bool setAddress (const InetAddress &address)
 Accessor to set value of address. More...
 
uint64_t addressHash ()
 Operation addressHash. More...
 
- Public Member Functions inherited from openjaus::system::Buffer
 Buffer ()
 
virtual ~Buffer ()
 
 Buffer (int maxSize)
 
 Buffer (const Buffer &buffer)
 
unsigned char * getPointer () const
 Accessor to get the value of pointer. More...
 
int getMaxSize () const
 Accessor to get the value of maxSize. More...
 
bool setMaxSize (int maxSize)
 Accessor to set value of maxSize. More...
 
unsigned char * getBuffer () const
 Accessor to get the value of buffer. More...
 
int append (Buffer &newBuffer)
 Operation append. More...
 
void free ()
 Operation free. More...
 
void increment (int byteCount)
 Operation increment. More...
 
int remainingBytes () const
 
int containedBytes () const
 
int clear ()
 Operation clear. More...
 
unsigned char * reset ()
 Operation reset. More...
 
int to (Buffer *dst, int byteCount)
 Operation to. More...
 
int from (Buffer *src, int byteCount)
 Operation from. More...
 
int setAllTo (unsigned char newValue)
 Operation setAllTo. More...
 
int set (unsigned char value, int count)
 Operation set. More...
 
virtual int to (Buffer *dst)
 Operation to. More...
 
virtual int from (Buffer *src)
 Operation from. More...
 
virtual int length ()
 Serializes object to internal transport buffer. More...
 
Bufferoperator= (const Buffer &rhs)
 
bool operator== (const Buffer &other) const
 
template<typename Type >
int peekTemplate (Type &value)
 
int peek (int8_t &value)
 
int peek (int16_t &value)
 
int peek (int32_t &value)
 
int peek (int64_t &value)
 
int peek (uint8_t &value)
 
int peek (uint16_t &value)
 
int peek (uint32_t &value)
 
int peek (uint64_t &value)
 
int peek (float &value)
 
int peek (double &value)
 
int peek (unsigned char *const buffer, int size)
 
template<typename Type >
int unpackTemplate (Type &value)
 
int unpack (int8_t &value)
 
int unpack (int16_t &value)
 
int unpack (int32_t &value)
 
int unpack (int64_t &value)
 
int unpack (uint8_t &value)
 
int unpack (uint16_t &value)
 
int unpack (uint32_t &value)
 
int unpack (uint64_t &value)
 
int unpack (float &value)
 
int unpack (double &value)
 
int unpack (Transportable &value)
 
int unpack (std::string &dst, unsigned long length)
 
int unpack (unsigned char *const buffer, int size)
 
template<typename Type >
int packTemplate (const Type &value)
 
int pack (const int8_t &value)
 
int pack (const int16_t &value)
 
int pack (const int32_t &value)
 
int pack (const int64_t &value)
 
int pack (const uint8_t &value)
 
int pack (const uint16_t &value)
 
int pack (const uint32_t &value)
 
int pack (const uint64_t &value)
 
int pack (const float &value)
 
int pack (const double &value)
 
int pack (Transportable &value)
 
int pack (std::string &source)
 
int pack (std::string &source, unsigned int length)
 
int pack (const unsigned char *const buffer, unsigned int size)
 
std::string toString (int byteCount) const
 
- Public Member Functions inherited from openjaus::system::Transportable
virtual ~Transportable ()
 
 Transportable ()
 

Protected Attributes

unsigned char version
 
std::vector< transport::Wrapper *> wrappers
 
- Protected Attributes inherited from openjaus::system::Packet
uint16_t port
 
InetAddress address
 
- Protected Attributes inherited from openjaus::system::Buffer
unsigned char * pointer
 
int maxSize
 
unsigned char * buffer
 

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 JtcpPacket &object)
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const JtcpPacket *object)
 

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

§ JtcpPacket()

openjaus::transport::AS5669::JtcpPacket::JtcpPacket ( )

§ ~JtcpPacket()

openjaus::transport::AS5669::JtcpPacket::~JtcpPacket ( )
virtual

Member Function Documentation

§ getVersion()

unsigned char openjaus::transport::AS5669::JtcpPacket::getVersion ( ) const

§ getWrappers()

const std::vector< transport::Wrapper *> & openjaus::transport::AS5669::JtcpPacket::getWrappers ( ) const

§ nextWrapperType()

transport::WrapperType openjaus::transport::AS5669::JtcpPacket::nextWrapperType ( )

§ popWrapper()

transport::Wrapper * openjaus::transport::AS5669::JtcpPacket::popWrapper ( )

§ pushWrapper()

bool openjaus::transport::AS5669::JtcpPacket::pushWrapper ( transport::Wrapper newWrapper)
Parameters
newWrapper

§ reset()

unsigned char * openjaus::transport::AS5669::JtcpPacket::reset ( )

§ setWrappers()

bool openjaus::transport::AS5669::JtcpPacket::setWrappers ( const transport::Wrapper wrappers)
Parameters
wrappersThe value of the new wrappers.

§ toString()

std::string openjaus::transport::AS5669::JtcpPacket::toString ( ) const
virtual

Reimplemented from openjaus::system::Packet.

Friends And Related Function Documentation

§ operator<< [1/2]

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

§ operator<< [2/2]

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

Member Data Documentation

§ MAX_PACKET_SIZE

const int openjaus::transport::AS5669::JtcpPacket::MAX_PACKET_SIZE = 4101
staticprotected

§ MAX_PAYLOAD_SIZE

const int openjaus::transport::AS5669::JtcpPacket::MAX_PAYLOAD_SIZE = 4084
staticprotected

§ STANDARD_VERSION

const unsigned char openjaus::transport::AS5669::JtcpPacket::STANDARD_VERSION = 2
staticprotected

§ version

unsigned char openjaus::transport::AS5669::JtcpPacket::version
protected

§ wrappers

std::vector< transport::Wrapper* > openjaus::transport::AS5669::JtcpPacket::wrappers
protected

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