OpenJAUS SAE SDK  6.0.0
Public Member Functions | Static Public Attributes | Protected Attributes | Friends | List of all members
openjaus::transport::AS5669::JudpPacket Class Reference

This is a brief description. More...

#include <JudpPacket.h>

Inherits openjaus::system::Packet.

Public Member Functions

 JudpPacket ()
 
virtual ~JudpPacket ()
 
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 (system::BufferReader &reader)
 Serializes object to internal transport buffer. More...
 
transport::WrapperpopWrapper ()
 
bool pushWrapper (transport::Wrapper *newWrapper)
 Operation pushWrapper. More...
 
void reset ()
 Operation reset. More...
 
virtual std::string toString () const
 
- Public Member Functions inherited from openjaus::system::Packet
 Packet (uint64 size)
 
virtual ~Packet ()
 
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 (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 ()
 
BufferReadergetReader ()
 Get a reference to the BufferReader. More...
 
BufferWritergetWriter ()
 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
 
Bufferoperator= (const Buffer &rhs)
 
bool operator== (const Buffer &other) const
 
- Public Member Functions inherited from openjaus::system::Transportable
 Transportable ()
 
virtual ~Transportable ()
 

Static Public Attributes

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

Protected Attributes

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

Friends

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

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

◆ JudpPacket()

openjaus::transport::AS5669::JudpPacket::JudpPacket ( )

◆ ~JudpPacket()

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

Member Function Documentation

◆ getVersion()

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

◆ getWrappers()

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

◆ nextWrapperType()

transport::WrapperType openjaus::transport::AS5669::JudpPacket::nextWrapperType ( system::BufferReader reader)

◆ popWrapper()

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

◆ pushWrapper()

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

◆ reset()

void openjaus::transport::AS5669::JudpPacket::reset ( )

◆ setWrappers()

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

◆ toString()

std::string openjaus::transport::AS5669::JudpPacket::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 JudpPacket object 
)
friend

◆ operator<< [2/2]

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

Member Data Documentation

◆ MAX_PACKET_SIZE

const int openjaus::transport::AS5669::JudpPacket::MAX_PACKET_SIZE = 4101
static

◆ MAX_PAYLOAD_SIZE

const int openjaus::transport::AS5669::JudpPacket::MAX_PAYLOAD_SIZE = 4084
static

◆ STANDARD_VERSION

const unsigned char openjaus::transport::AS5669::JudpPacket::STANDARD_VERSION = 2
static

◆ version

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

◆ wrappers

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

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