AftPacket Class Reference

Primary class for Aft Packets. More...

#include <AftPacket.h>

Public Types
enum	PacketDirEnum { PacketDirReceive = 0, PacketDirTransmit }
enum	PacketTypeEnum { PacketTypeL2 = 0, PacketTypeL3 }

Public Member Functions
	AftPacket ()
	Default constructor for AftPacket.
AftSandboxId	sandboxId () const
	Packet data size. More...
AftIndex	portIndex () const
AftPacket::PacketDirEnum	packetDir () const
AftPacket::PacketTypeEnum	innerPacketType () const
uint8_t *	header () const
int	headerSize () const
uint8_t *	data () const
int	dataSize () const
int	size () const
void	headerSerialize ()
	Serializes header.
void	headerParse ()
	Parses header.

Static Public Member Functions
static AftPacketPtr	createTransmit (AftLength dataSize, AftSandboxId sandboxId, AftIndex portIndex, AftPacket::PacketTypeEnum packetType)
	Factory method to create packet for transmit. More...
static AftPacketPtr	createReceive (void)
	Factory method to create packet for receive. More...

Detailed Description

Primary class for Aft Packets.

Member Enumeration Documentation

enum AftPacket::PacketDirEnum

Enumerator
PacketDirReceive	Aft Sandbox to Aft Client.
PacketDirTransmit	Aft Client to Aft Sandbox.

enum AftPacket::PacketTypeEnum

Enumerator
PacketTypeL2	Layer 2 packet.
PacketTypeL3	Layer 3 packet.

Member Function Documentation

static AftPacketPtr AftPacket::createReceive ( void  )

static

Factory method to create packet for receive.

Returns

Return Aft packet shared pointer

static AftPacketPtr AftPacket::createTransmit ( AftLength  dataSize, AftSandboxId  sandboxId, AftIndex  portIndex, AftPacket::PacketTypeEnum  packetType  )

static

Factory method to create packet for transmit.

Parameters

[in]	sandboxId	Sandbox Id
[in]	portIndex	Port index
[in]	packetType	Packet Type

Returns

Return Aft packet shared pointer

uint8_t* AftPacket::data ( ) const

inline

Returns

Start of packer data

int AftPacket::dataSize ( ) const

inline

Returns

Packet data size

uint8_t* AftPacket::header ( ) const

inline

Returns

Start of packet data buffer

int AftPacket::headerSize ( ) const

inline

Returns

Header size

AftPacket::PacketTypeEnum AftPacket::innerPacketType ( ) const

inline

Returns

Inner packet type

AftPacket::PacketDirEnum AftPacket::packetDir ( ) const

inline

Returns

Packet direction

AftIndex AftPacket::portIndex ( ) const

inline

Returns

Port index

AftSandboxId AftPacket::sandboxId ( ) const

inline

Packet data size.

Returns

Sandbox Id

int AftPacket::size ( ) const

inline

Returns

Packet size

---

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

• AftPacket.h