OpenJAUS SAE SDK  6.0.0
Public Member Functions | Protected Attributes | Friends | List of all members
openjaus::system::Packet Class Reference

This is a brief description. More...

#include <Packet.h>

Inherits openjaus::system::Buffer.

Inherited by openjaus::transport::AS5669::JtcpPacket, and openjaus::transport::AS5669::JudpPacket.

Public Member Functions

 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...
 
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 ()
 
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 ()
 

Protected Attributes

uint16_t port
 
InetAddress address
 

Friends

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

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

◆ Packet()

openjaus::system::Packet::Packet ( uint64  size)

◆ ~Packet()

openjaus::system::Packet::~Packet ( )
virtual

Member Function Documentation

◆ addressHash()

uint64_t openjaus::system::Packet::addressHash ( )

◆ getAddress()

const InetAddress & openjaus::system::Packet::getAddress ( ) const

◆ getPort()

uint16_t openjaus::system::Packet::getPort ( ) const

◆ setAddress()

bool openjaus::system::Packet::setAddress ( const InetAddress address)
Parameters
addressThe value of the new address.

◆ setPort()

bool openjaus::system::Packet::setPort ( uint16_t  port)
Parameters
portThe value of the new port.

◆ toString()

std::string openjaus::system::Packet::toString ( ) const
virtual

Friends And Related Function Documentation

◆ operator<< [1/2]

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

◆ operator<< [2/2]

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

Member Data Documentation

◆ address

InetAddress openjaus::system::Packet::address
protected

◆ port

uint16_t openjaus::system::Packet::port
protected

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