inet::serializer::Buffer Class Reference

Buffer for serializer/deserializer. More...

#include <Buffer.h>

Public Member Functions
	Buffer (const Buffer &base, unsigned int maxLength)
	Buffer (void *buf, unsigned int bufLen)
void	seek (unsigned int newpos) const
unsigned int	getPos () const
unsigned int	getRemainingSize () const
unsigned int	getRemainingSize (unsigned int reservedSize) const
bool	hasError () const
void	setError () const
unsigned char	readByte () const
void	readNBytes (unsigned int length, void *dest) const
uint16_t	readUint16 () const
uint32_t	readUint32 () const
uint64_t	readUint64 () const
MACAddress	readMACAddress () const
IPv4Address	readIPv4Address () const
IPv6Address	readIPv6Address () const
void	writeByte (unsigned char data)
void	writeByteTo (unsigned int position, unsigned char data)
void	writeNBytes (unsigned int length, const void *src)
void	writeNBytes (Buffer &inputBuffer, unsigned int length)
void	fillNBytes (unsigned int length, unsigned char data)
void	writeUint16 (uint16_t data)
void	writeUint16To (unsigned int position, uint16_t data)
void	writeUint32 (uint32_t data)
void	writeUint64 (uint64_t data)
void	writeMACAddress (const MACAddress &addr)
void	writeIPv4Address (IPv4Address addr)
void	writeIPv6Address (const IPv6Address &addr)
void *	accessNBytes (unsigned int length)
const void *	accessNBytes (unsigned int length) const
unsigned char *	_getBuf () const
unsigned int	_getBufSize () const

Protected Attributes
unsigned char *	buf = nullptr
unsigned int	bufsize = 0
unsigned int	pos = 0
bool	errorFound = false

Detailed Description

Buffer for serializer/deserializer.

Constructor & Destructor Documentation

inet::serializer::Buffer::Buffer	(	const Buffer &	base,
		unsigned int	maxLength
	)

{
    buf = base.buf + base.pos;
    bufsize = std::min(base.bufsize - base.pos, maxLength);
}

inet::serializer::Buffer::Buffer ( void *  buf, unsigned int  bufLen  )

inline

: buf(static_cast<unsigned char *>(buf)), bufsize(bufLen) {}

Member Function Documentation

unsigned char* inet::serializer::Buffer::_getBuf ( ) const

inline

Referenced by inet::serializer::ICMPSerializer::deserialize(), inet::serializer::ICMPv6Serializer::deserialize(), inet::serializer::UDPSerializer::deserialize(), inet::serializer::Ieee80211Serializer::deserialize(), inet::serializer::EthernetSerializer::deserialize(), inet::serializer::TCPSerializer::deserialize(), inet::serializer::ICMPv6Serializer::serialize(), inet::serializer::ICMPSerializer::serialize(), inet::serializer::UDPSerializer::serialize(), inet::serializer::EthernetSerializer::serialize(), inet::serializer::Ieee80211Serializer::serialize(), and inet::serializer::TCPSerializer::serialize().

{ return buf; }

unsigned int inet::serializer::Buffer::_getBufSize ( ) const

inline

Referenced by inet::serializer::IPv6Serializer::deserialize(), inet::serializer::ICMPv6Serializer::deserialize(), inet::serializer::IGMPSerializer::deserialize(), inet::serializer::TCPSerializer::deserialize(), and inet::serializer::IPv4Serializer::deserialize().

{ return bufsize; }

void * inet::serializer::Buffer::accessNBytes

(

unsigned int

length

)

Referenced by inet::serializer::IPv6Serializer::deserialize(), inet::serializer::ICMPSerializer::deserialize(), inet::serializer::UDPSerializer::deserialize(), inet::serializer::IGMPSerializer::deserialize(), inet::serializer::SCTPSerializer::deserialize(), inet::serializer::Ieee80211Serializer::deserialize(), inet::serializer::TCPSerializer::deserialize(), inet::serializer::EthernetSerializer::deserialize(), inet::serializer::IPv4Serializer::deserialize(), inet::serializer::DefaultSerializer::deserialize(), inet::serializer::ByteArraySerializer::deserialize(), inet::serializer::SerializerBase::lookupAndDeserialize(), inet::serializer::SerializerBase::lookupAndSerialize(), inet::serializer::IPv6Serializer::serialize(), inet::serializer::Ieee80211PhySerializer::serialize(), inet::serializer::IGMPSerializer::serialize(), inet::serializer::ICMPSerializer::serialize(), inet::serializer::SCTPSerializer::serialize(), inet::serializer::TCPSerializer::serialize(), inet::serializer::IPv4Serializer::serialize(), and inet::serializer::ByteArraySerializer::serialize().

{
    if (pos + length <= bufsize) {
        void *ret = buf + pos;
        pos += length;
        return ret;
    }
    pos = bufsize;
    errorFound = true;
    return nullptr;
}

const void* inet::serializer::Buffer::accessNBytes ( unsigned int  length ) const

inline

Referenced by accessNBytes().

{ return const_cast<Buffer *>(this)->accessNBytes(length); }    // returns nullptr when haven't got enough space

void inet::serializer::Buffer::fillNBytes	(	unsigned int	length,
		unsigned char	data
	)

Referenced by inet::serializer::IPv6Serializer::serialize(), inet::serializer::ICMPv6Serializer::serialize(), inet::serializer::UDPSerializer::serialize(), inet::serializer::ICMPSerializer::serialize(), inet::serializer::EthernetSerializer::serialize(), inet::serializer::TCPSerializer::serialize(), inet::serializer::EtherPhySerializer::serialize(), inet::serializer::IPv4Serializer::serialize(), inet::serializer::DefaultSerializer::serialize(), inet::serializer::ByteArraySerializer::serialize(), and inet::serializer::IPv4Serializer::serializeOptions().

{
    while (pos < bufsize && length > 0) {
        buf[pos++] = data;
        length--;
    }
    if (length)
        errorFound = true;
}

unsigned int inet::serializer::Buffer::getPos ( ) const

inline

Referenced by inet::serializer::IPv6Serializer::deserialize(), inet::serializer::IGMPSerializer::deserialize(), inet::serializer::UDPSerializer::deserialize(), inet::serializer::ICMPSerializer::deserialize(), inet::serializer::ICMPv6Serializer::deserialize(), inet::serializer::Ieee80211Serializer::deserialize(), inet::serializer::EthernetSerializer::deserialize(), inet::serializer::ARPSerializer::deserialize(), inet::serializer::EtherPhySerializer::deserialize(), inet::serializer::IPv4Serializer::deserialize(), inet::serializer::IPv4OptionDefaultSerializer::deserializeOption(), inet::serializer::IPv4Serializer::deserializeOptions(), inet::serializer::SerializerBase::deserializePacket(), inet::tcp::TCP_NSC::handleIpInputMessage(), inet::tcp::TCP_lwIP::handleIpInputMessage(), inet::serializer::SerializerBase::lookupAndDeserialize(), inet::serializer::SerializerBase::lookupAndSerialize(), inet::serializer::ARPSerializer::readIPv4Address(), inet::serializer::ARPSerializer::readMACAddress(), inet::sctp::SCTP::send_to_ip(), inet::serializer::Ieee80211PhySerializer::serialize(), inet::serializer::IPv6Serializer::serialize(), inet::serializer::IGMPSerializer::serialize(), inet::serializer::UDPSerializer::serialize(), inet::serializer::ICMPv6Serializer::serialize(), inet::serializer::ICMPSerializer::serialize(), inet::physicallayer::APSKPhyFrameSerializer::serialize(), inet::serializer::EthernetSerializer::serialize(), inet::serializer::Ieee80211Serializer::serialize(), inet::serializer::TCPSerializer::serialize(), inet::serializer::ARPSerializer::serialize(), inet::serializer::EtherPhySerializer::serialize(), inet::serializer::IPv4Serializer::serialize(), inet::serializer::SerializerBase::serializePacket(), inet::PcapDump::writeFrame(), and inet::PcapDump::writeIPv6Frame().

{ return pos; }

unsigned int inet::serializer::Buffer::getRemainingSize ( ) const

inline

Referenced by inet::serializer::ICMPSerializer::deserialize(), inet::serializer::ICMPv6Serializer::deserialize(), inet::serializer::SCTPSerializer::deserialize(), inet::serializer::Ieee80211Serializer::deserialize(), inet::serializer::TCPSerializer::deserialize(), inet::serializer::EthernetSerializer::deserialize(), inet::serializer::EtherPhySerializer::deserialize(), inet::serializer::IPv4Serializer::deserialize(), inet::serializer::DefaultSerializer::deserialize(), inet::serializer::ByteArraySerializer::deserialize(), inet::serializer::IPv4Serializer::deserializeOptions(), inet::serializer::SerializerBase::deserializePacket(), inet::serializer::Ieee80211PhySerializer::serialize(), inet::serializer::ICMPSerializer::serialize(), inet::serializer::SCTPSerializer::serialize(), inet::serializer::EthernetSerializer::serialize(), inet::serializer::Ieee80211Serializer::serialize(), inet::serializer::TCPSerializer::serialize(), inet::serializer::EtherPhySerializer::serialize(), inet::serializer::ByteArraySerializer::serialize(), and inet::serializer::IPv4Serializer::serializeOptions().

{ return bufsize - pos; }

unsigned int inet::serializer::Buffer::getRemainingSize ( unsigned int  reservedSize ) const

inline

{ return bufsize - pos > reservedSize ? (bufsize - pos) - reservedSize : 0; }

bool inet::serializer::Buffer::hasError ( ) const

inline

Referenced by inet::serializer::IGMPSerializer::deserialize(), inet::serializer::TCPSerializer::deserialize(), inet::serializer::IPv4Serializer::deserialize(), inet::serializer::SerializerBase::deserializePacket(), inet::serializer::SerializerBase::lookupAndSerialize(), inet::serializer::IPv4Serializer::serialize(), and inet::serializer::SerializerBase::serializePacket().

{ return errorFound; }

unsigned char inet::serializer::Buffer::readByte

(

)

const

Referenced by inet::serializer::ICMPSerializer::deserialize(), inet::serializer::IGMPSerializer::deserialize(), inet::serializer::ICMPv6Serializer::deserialize(), inet::serializer::Ieee80211Serializer::deserialize(), inet::serializer::EthernetSerializer::deserialize(), inet::serializer::ARPSerializer::deserialize(), inet::serializer::IPv4OptionDefaultSerializer::deserializeOption(), inet::serializer::TCPSerializer::deserializeOption(), inet::serializer::IPv4Serializer::deserializeOptions(), inet::serializer::Ieee80211Serializer::parseDataOrMgmtFrame(), readMACAddress(), and writeNBytes().

{
    if (pos >= bufsize) {
        errorFound = true;
        return 0;
    }
    return buf[pos++];
}

IPv4Address inet::serializer::Buffer::readIPv4Address ( ) const

inline

Referenced by inet::serializer::IGMPSerializer::deserialize(), inet::serializer::IPv4OptionDefaultSerializer::deserializeOption(), and inet::serializer::ARPSerializer::readIPv4Address().

{ return IPv4Address(readUint32()); }

IPv6Address inet::serializer::Buffer::readIPv6Address

(

)

const

Referenced by inet::serializer::ICMPv6Serializer::deserialize().

{
    uint32_t d[4];
    for (auto & elem : d)
        elem = readUint32();
    return IPv6Address(d[0], d[1], d[2], d[3]);
}

MACAddress inet::serializer::Buffer::readMACAddress

(

)

const

Referenced by inet::serializer::ICMPv6Serializer::deserialize(), inet::serializer::Ieee80211Serializer::deserialize(), inet::serializer::EthernetSerializer::deserialize(), inet::serializer::Ieee80211Serializer::parseDataOrMgmtFrame(), and inet::serializer::ARPSerializer::readMACAddress().

{
    MACAddress addr;
    for (int i = 0; i < MAC_ADDRESS_SIZE; i++)
        addr.setAddressByte(i, readByte());
    return addr;
}

void inet::serializer::Buffer::readNBytes	(	unsigned int	length,
		void *	dest
	)		const

Referenced by inet::serializer::Ieee80211Serializer::deserialize(), inet::serializer::TCPSerializer::deserialize(), and inet::serializer::EtherPhySerializer::deserialize().

{
    unsigned char *dest = static_cast<unsigned char *>(_dest);
    while (length--) {
        if (pos >= bufsize) {
            errorFound = true;
            *dest++ = 0;
        } else
            *dest++ = buf[pos++];
    }
}

uint16_t inet::serializer::Buffer::readUint16

(

)

const

Referenced by inet::serializer::ICMPSerializer::deserialize(), inet::serializer::ICMPv6Serializer::deserialize(), inet::serializer::UDPSerializer::deserialize(), inet::serializer::IGMPSerializer::deserialize(), inet::serializer::Ieee80211Serializer::deserialize(), inet::serializer::EthernetSerializer::deserialize(), inet::serializer::ARPSerializer::deserialize(), inet::serializer::IPv4OptionDefaultSerializer::deserializeOption(), inet::serializer::TCPSerializer::deserializeOption(), and inet::serializer::Ieee80211Serializer::parseDataOrMgmtFrame().

{
    uint16_t ret = 0;
    if (pos < bufsize) ret += ((uint16_t)(buf[pos++]) << 8);
    if (pos < bufsize) ret += ((uint16_t)(buf[pos++]));
    else errorFound = true;
    return ret;
}

uint32_t inet::serializer::Buffer::readUint32

(

)

const

Referenced by inet::serializer::ICMPSerializer::deserialize(), inet::serializer::ICMPv6Serializer::deserialize(), inet::serializer::Ieee80211Serializer::deserialize(), inet::serializer::EthernetSerializer::deserialize(), inet::serializer::IPv4OptionDefaultSerializer::deserializeOption(), inet::serializer::TCPSerializer::deserializeOption(), and readIPv6Address().

{
    uint32_t ret = 0;
    if (pos < bufsize) ret += ((uint32_t)(buf[pos++]) << 24);
    if (pos < bufsize) ret += ((uint32_t)(buf[pos++]) << 16);
    if (pos < bufsize) ret += ((uint32_t)(buf[pos++]) <<  8);
    if (pos < bufsize) ret += ((uint32_t)(buf[pos++]));
    else errorFound = true;
    return ret;
}

uint64_t inet::serializer::Buffer::readUint64

(

)

const

Referenced by inet::serializer::Ieee80211Serializer::deserialize().

{
    uint64_t ret = 0;
    if (pos < bufsize) ret += ((uint64_t)(buf[pos++]) << 56);
    if (pos < bufsize) ret += ((uint64_t)(buf[pos++]) << 48);
    if (pos < bufsize) ret += ((uint64_t)(buf[pos++]) << 40);
    if (pos < bufsize) ret += ((uint64_t)(buf[pos++]) << 32);
    if (pos < bufsize) ret += ((uint64_t)(buf[pos++]) << 24);
    if (pos < bufsize) ret += ((uint64_t)(buf[pos++]) << 16);
    if (pos < bufsize) ret += ((uint64_t)(buf[pos++]) <<  8);
    if (pos < bufsize) ret += ((uint64_t)(buf[pos++]));
    else errorFound = true;
    return ret;
}

void inet::serializer::Buffer::seek ( unsigned int  newpos ) const

inline

Referenced by inet::serializer::ICMPv6Serializer::deserialize(), inet::serializer::IGMPSerializer::deserialize(), inet::serializer::TCPSerializer::deserialize(), inet::serializer::EtherPhySerializer::deserialize(), inet::serializer::IPv4Serializer::deserialize(), inet::serializer::IPv4OptionDefaultSerializer::deserializeOption(), inet::serializer::IPv4Serializer::deserializeOptions(), inet::serializer::SerializerBase::deserializePacket(), inet::serializer::Ieee80211Serializer::parseDataOrMgmtFrame(), inet::serializer::ARPSerializer::readIPv4Address(), inet::serializer::ARPSerializer::readMACAddress(), and inet::serializer::IPv4Serializer::serialize().

{ if (newpos <= bufsize) { pos = newpos; } else { pos = bufsize; errorFound = true; } }

void inet::serializer::Buffer::setError ( ) const

inline

Referenced by inet::serializer::IPv6Serializer::deserialize(), inet::serializer::Ieee80211Serializer::deserialize(), inet::serializer::TCPSerializer::deserialize(), inet::serializer::IPv4Serializer::deserialize(), inet::serializer::SerializerBase::lookupAndSerialize(), and inet::serializer::IPv4Serializer::serialize().

{ errorFound = true; }

void inet::serializer::Buffer::writeByte

(

unsigned char

data

)

Referenced by inet::serializer::IPv6Serializer::serialize(), inet::serializer::ICMPSerializer::serialize(), inet::serializer::ICMPv6Serializer::serialize(), inet::serializer::IGMPSerializer::serialize(), inet::serializer::EthernetSerializer::serialize(), inet::serializer::ARPSerializer::serialize(), inet::serializer::Ieee80211Serializer::serialize(), inet::serializer::EtherPhySerializer::serialize(), inet::serializer::IPv4OptionDefaultSerializer::serializeOption(), and inet::serializer::TCPSerializer::serializeOption().

{
    if (pos >= bufsize) {
        errorFound = true;
        return;
    }
    buf[pos++] = data;
}

void inet::serializer::Buffer::writeByteTo	(	unsigned int	position,
		unsigned char	data
	)

Referenced by inet::serializer::IPv6Serializer::serialize(), and inet::serializer::IGMPSerializer::serialize().

{
    if (position >= bufsize) {
        errorFound = true;
        return;
    }
    buf[position] = data;
}

void inet::serializer::Buffer::writeIPv4Address ( IPv4Address  addr )

inline

Referenced by inet::IPv4FragBuf::addFragment(), inet::serializer::IGMPSerializer::serialize(), inet::serializer::ARPSerializer::serialize(), and inet::serializer::IPv4OptionDefaultSerializer::serializeOption().

{ writeUint32(addr.getInt()); }

void inet::serializer::Buffer::writeIPv6Address ( const IPv6Address &  addr )

inline

Referenced by inet::serializer::IPv6Serializer::serialize(), and inet::serializer::ICMPv6Serializer::serialize().

{ for (int i = 0; i < 4; i++) { writeUint32(addr.words()[i]); } }

void inet::serializer::Buffer::writeMACAddress

(

const MACAddress &

addr

)

Referenced by inet::serializer::ICMPv6Serializer::serialize(), inet::serializer::EthernetSerializer::serialize(), inet::serializer::Ieee80211Serializer::serialize(), and inet::serializer::ARPSerializer::serialize().

{
    unsigned char buff[MAC_ADDRESS_SIZE];
    addr.getAddressBytes(buff);
    writeNBytes(MAC_ADDRESS_SIZE, buff);
}

void inet::serializer::Buffer::writeNBytes	(	unsigned int	length,
		const void *	src
	)

Referenced by inet::serializer::Ieee80211Serializer::serialize(), inet::serializer::TCPSerializer::serialize(), inet::serializer::IPv4Serializer::serialize(), and writeMACAddress().

{
    const unsigned char *src = static_cast<const unsigned char *>(_src);
    while (pos < bufsize && length > 0) {
        buf[pos++] = *src++;
        length--;
    }
    if (length)
        errorFound = true;
}

void inet::serializer::Buffer::writeNBytes	(	Buffer &	inputBuffer,
		unsigned int	length
	)

{
    while (pos < bufsize && length > 0) {
        buf[pos++] = inputBuffer.readByte();
        length--;
    }
    if (length)
        errorFound = true;
}

void inet::serializer::Buffer::writeUint16

(

uint16_t

data

)

Referenced by inet::serializer::IPv6Serializer::serialize(), inet::serializer::ICMPSerializer::serialize(), inet::serializer::ICMPv6Serializer::serialize(), inet::serializer::UDPSerializer::serialize(), inet::serializer::IGMPSerializer::serialize(), inet::serializer::EthernetSerializer::serialize(), inet::serializer::ARPSerializer::serialize(), inet::serializer::Ieee80211Serializer::serialize(), inet::serializer::IPv4OptionDefaultSerializer::serializeOption(), and inet::serializer::TCPSerializer::serializeOption().

{
    if (pos < bufsize)
        buf[pos++] = (uint8_t)(data >> 8);
    if (pos < bufsize)
        buf[pos++] = (uint8_t)data;
    else
        errorFound = true;
}

void inet::serializer::Buffer::writeUint16To	(	unsigned int	position,
		uint16_t	data
	)

Referenced by inet::serializer::ICMPSerializer::serialize(), inet::serializer::UDPSerializer::serialize(), inet::serializer::IGMPSerializer::serialize(), inet::serializer::ICMPv6Serializer::serialize(), inet::serializer::EthernetSerializer::serialize(), and inet::serializer::TCPSerializer::serialize().

{
    if (position < bufsize)
        buf[position++] = (uint8_t)(data >> 8);
    if (position < bufsize)
        buf[position++] = (uint8_t)data;
    else
        errorFound = true;
}

void inet::serializer::Buffer::writeUint32

(

uint32_t

data

)

Referenced by inet::serializer::IPv6Serializer::serialize(), inet::serializer::ICMPSerializer::serialize(), inet::serializer::ICMPv6Serializer::serialize(), inet::serializer::EthernetSerializer::serialize(), inet::serializer::Ieee80211Serializer::serialize(), inet::serializer::IPv4OptionDefaultSerializer::serializeOption(), and inet::serializer::TCPSerializer::serializeOption().

{
    if (pos < bufsize)
        buf[pos++] = (uint8_t)(data >> 24);
    if (pos < bufsize)
        buf[pos++] = (uint8_t)(data >> 16);
    if (pos < bufsize)
        buf[pos++] = (uint8_t)(data >> 8);
    if (pos < bufsize)
        buf[pos++] = (uint8_t)data;
    else
        errorFound = true;
}

void inet::serializer::Buffer::writeUint64

(

uint64_t

data

)

Referenced by inet::serializer::Ieee80211Serializer::serialize().

{
    if (pos < bufsize)
        buf[pos++] = (uint8_t)(data >> 56);
    if (pos < bufsize)
        buf[pos++] = (uint8_t)(data >> 48);
    if (pos < bufsize)
        buf[pos++] = (uint8_t)(data >> 40);
    if (pos < bufsize)
        buf[pos++] = (uint8_t)(data >> 32);
    if (pos < bufsize)
        buf[pos++] = (uint8_t)(data >> 24);
    if (pos < bufsize)
        buf[pos++] = (uint8_t)(data >> 16);
    if (pos < bufsize)
        buf[pos++] = (uint8_t)(data >> 8);
    if (pos < bufsize)
        buf[pos++] = (uint8_t)data;
    else
        errorFound = true;
}

Member Data Documentation

unsigned char* inet::serializer::Buffer::buf = nullptr

protected

Referenced by accessNBytes(), Buffer(), fillNBytes(), readByte(), readNBytes(), readUint16(), readUint32(), readUint64(), writeByte(), writeByteTo(), writeNBytes(), writeUint16(), writeUint16To(), writeUint32(), and writeUint64().

unsigned int inet::serializer::Buffer::bufsize = 0

protected

Referenced by accessNBytes(), Buffer(), readByte(), readNBytes(), readUint16(), readUint32(), readUint64(), writeByte(), writeByteTo(), writeUint16(), writeUint16To(), writeUint32(), and writeUint64().

bool inet::serializer::Buffer::errorFound = false

mutableprotected

Referenced by accessNBytes(), fillNBytes(), readByte(), readNBytes(), readUint16(), readUint32(), readUint64(), writeByte(), writeByteTo(), writeNBytes(), writeUint16(), writeUint16To(), writeUint32(), and writeUint64().

unsigned int inet::serializer::Buffer::pos = 0

mutableprotected

Referenced by accessNBytes(), Buffer(), fillNBytes(), readByte(), readNBytes(), readUint16(), readUint32(), readUint64(), writeByte(), writeNBytes(), writeUint16(), writeUint32(), and writeUint64().

---

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

• Buffer.h
• Buffer.cc