inet::serializer::SerializerBase Class Reference

Converts between cPacket and binary (network byte order) packet. More...

#include <SerializerBase.h>

Inheritance diagram for inet::serializer::SerializerBase:

Public Member Functions
	SerializerBase (const char *name=nullptr)
void	serializePacket (const cPacket *pkt, Buffer &b, Context &context)
cPacket *	deserializePacket (const Buffer &b, Context &context)

Static Public Member Functions
static SerializerBase &	lookupSerializer (const cPacket *pkt, Context &context, ProtocolGroup group, int id)
static void	lookupAndSerialize (const cPacket *pkt, Buffer &b, Context &context, ProtocolGroup group, int id, unsigned int maxLength=(unsigned int)(-1))
static SerializerBase &	lookupDeserializer (Context &context, ProtocolGroup group, int id)
static cPacket *	lookupAndDeserialize (const Buffer &b, Context &context, ProtocolGroup group, int id, unsigned int maxLength=(unsigned int)(-1))

Protected Member Functions
virtual void	serialize (const cPacket *pkt, Buffer &b, Context &context)=0
	Serializes a cPacket for transmission on the wire. More...
virtual cPacket *	deserialize (const Buffer &b, Context &context)=0
	Puts a packet sniffed from the wire into an EtherFrame. More...

Detailed Description

Converts between cPacket and binary (network byte order) packet.

Constructor & Destructor Documentation

inet::serializer::SerializerBase::SerializerBase ( const char *  name = nullptr )

inline

: cOwnedObject(name) {}

Member Function Documentation

virtual cPacket* inet::serializer::SerializerBase::deserialize ( const Buffer &  b, Context &  context  )

protectedpure virtual

Puts a packet sniffed from the wire into an EtherFrame.

Implemented in inet::serializer::ByteArraySerializer, inet::serializer::DefaultSerializer, inet::serializer::IPv4Serializer, inet::serializer::EtherPhySerializer, inet::serializer::ARPSerializer, inet::serializer::EthernetSerializer, inet::serializer::TCPSerializer, inet::serializer::Ieee80211Serializer, inet::serializer::ICMPSerializer, inet::serializer::IGMPSerializer, inet::serializer::ICMPv6Serializer, inet::serializer::SCTPSerializer, inet::serializer::UDPSerializer, and inet::serializer::IPv6Serializer.

Referenced by deserializePacket().

cPacket * inet::serializer::SerializerBase::deserializePacket	(	const Buffer &	b,
		Context &	context
	)

Referenced by inet::serializer::Ieee80211PhySerializer::deserialize(), inet::serializer::IGMPSerializer::deserialize(), inet::serializer::UDPSerializer::deserialize(), inet::physicallayer::APSKPhyFrameSerializer::deserialize(), inet::ExtInterface::handleMessage(), and lookupAndDeserialize().

{
    if (b.getRemainingSize() == 0)
        return nullptr;

    unsigned int startPos = b.getPos();
    cPacket *pkt = deserialize(b, context);
    if (pkt == nullptr) {
        b.seek(startPos);
        pkt = serializers.byteArraySerializer.deserialize(b, context);
    }
    ASSERT(pkt);
    if (!pkt->hasBitError() && !b.hasError() && (b.getPos() - startPos != pkt->getByteLength())) {
        const char *encclass = pkt->getEncapsulatedPacket() ? pkt->getEncapsulatedPacket()->getClassName() : "<nullptr>";
        throw cRuntimeError("%s deserializer error: packet %s (%s) length is %d but deserialized length is %d (encapsulated packet is %s)", getClassName(), pkt->getName(), pkt->getClassName(), pkt->getByteLength(), b.getPos() - startPos, encclass);
    }
    if (b.hasError())
        pkt->setBitError(true);
    return pkt;
}

cPacket * inet::serializer::SerializerBase::lookupAndDeserialize ( const Buffer &  b, Context &  context, ProtocolGroup  group, int  id, unsigned int  maxLength = (unsigned int)(-1)  )

static

Referenced by inet::IPv4FragBuf::addFragment(), inet::EtherMACBase::decapsulate(), inet::serializer::IPv6Serializer::deserialize(), inet::serializer::ICMPSerializer::deserialize(), inet::serializer::Ieee80211Serializer::deserialize(), inet::serializer::EthernetSerializer::deserialize(), inet::serializer::EtherPhySerializer::deserialize(), and inet::serializer::IPv4Serializer::deserialize().

{
    cPacket *encapPacket = nullptr;
    SerializerBase& serializer = lookupDeserializer(context, group, id);
    Buffer subBuffer(b, maxLength);
    encapPacket = serializer.deserializePacket(subBuffer, context);
    b.accessNBytes(subBuffer.getPos());
    return encapPacket;
}

void inet::serializer::SerializerBase::lookupAndSerialize ( const cPacket *  pkt, Buffer &  b, Context &  context, ProtocolGroup  group, int  id, unsigned int  maxLength = (unsigned int)(-1)  )

static

Referenced by inet::serializer::IPv6Serializer::serialize(), inet::serializer::ICMPv6Serializer::serialize(), inet::serializer::UDPSerializer::serialize(), inet::serializer::ICMPSerializer::serialize(), inet::serializer::EthernetSerializer::serialize(), inet::serializer::Ieee80211Serializer::serialize(), inet::serializer::EtherPhySerializer::serialize(), and inet::serializer::IPv4Serializer::serialize().

{
    ASSERT(pkt);
    Buffer subBuffer(b, maxLength);
    SerializerBase & serializer = lookupSerializer(pkt, context, group, id);
    serializer.serializePacket(pkt, subBuffer, context);
    b.accessNBytes(subBuffer.getPos());
    if (subBuffer.hasError())
        b.setError();
}

SerializerBase & inet::serializer::SerializerBase::lookupDeserializer ( Context &  context, ProtocolGroup  group, int  id  )

static

Referenced by lookupAndDeserialize().

{
    SerializerBase *serializer = serializers.lookup(group, id);
    if (serializer != nullptr)
        return *serializer;
    else
        return serializers.byteArraySerializer;
}

SerializerBase & inet::serializer::SerializerBase::lookupSerializer ( const cPacket *  pkt, Context &  context, ProtocolGroup  group, int  id  )

static

Referenced by lookupAndSerialize().

{
    const RawPacket *bam = dynamic_cast<const RawPacket *>(pkt);
    if (bam != nullptr)
        return serializers.byteArraySerializer;
    SerializerBase *serializer = serializers.lookup(group, id);
    if (serializer != nullptr)
        return *serializer;
    serializer = serializers.lookup(pkt->getClassName());
    if (serializer != nullptr)
        return *serializer;
    if (context.throwOnSerializerNotFound)
        throw cRuntimeError("Serializer not found for '%s' (%i, %i)", pkt->getClassName(), group, id);
    return serializers.defaultSerializer;
}

virtual void inet::serializer::SerializerBase::serialize ( const cPacket *  pkt, Buffer &  b, Context &  context  )

protectedpure virtual

Serializes a cPacket for transmission on the wire.

Returns the length of data written into buffer.

Implemented in inet::serializer::ByteArraySerializer, inet::serializer::DefaultSerializer, inet::serializer::IPv4Serializer, inet::serializer::EtherPhySerializer, inet::serializer::TCPSerializer, inet::serializer::ARPSerializer, inet::serializer::Ieee80211Serializer, inet::serializer::EthernetSerializer, inet::serializer::ICMPSerializer, inet::serializer::IGMPSerializer, inet::serializer::ICMPv6Serializer, inet::serializer::SCTPSerializer, inet::serializer::UDPSerializer, and inet::serializer::IPv6Serializer.

Referenced by serializePacket().

void inet::serializer::SerializerBase::serializePacket	(	const cPacket *	pkt,
		Buffer &	b,
		Context &	context
	)

Referenced by inet::serializer::SCTPSerializer::deserialize(), inet::tcp::TCP_NSC::handleIpInputMessage(), inet::tcp::TCP_lwIP::handleIpInputMessage(), inet::ExtInterface::handleMessage(), lookupAndSerialize(), inet::sctp::SCTP::send_to_ip(), inet::physicallayer::APSKPhyFrameSerializer::serialize(), inet::PcapDump::writeFrame(), and inet::PcapDump::writeIPv6Frame().

{
    unsigned int startPos = b.getPos();
    serialize(pkt, b, c);
    if (!b.hasError() && (b.getPos() - startPos != pkt->getByteLength()))
        throw cRuntimeError("%s serializer error: packet %s (%s) length is %d but serialized length is %d", getClassName(), pkt->getName(), pkt->getClassName(), pkt->getByteLength(), b.getPos() - startPos);
}

---

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

• SerializerBase.h
• SerializerBase.cc