openikev2::Payload Class Reference

This abstract class represents a generic Payload of a Message. More...

#include <payload.h>

Inheritance diagram for openikev2::Payload:

[legend]List of all members.

Public Types
enum	PAYLOAD_TYPE {   PAYLOAD_NONE = 0, PAYLOAD_SA = 33, PAYLOAD_KE, PAYLOAD_IDi,   PAYLOAD_IDr, PAYLOAD_CERT, PAYLOAD_CERT_REQ, PAYLOAD_AUTH,   PAYLOAD_NONCE, PAYLOAD_NOTIFY, PAYLOAD_DEL, PAYLOAD_VENDOR,   PAYLOAD_TSi, PAYLOAD_TSr, PAYLOAD_SK, PAYLOAD_CONF,   PAYLOAD_EAP }
	Payload types. More...
Public Member Functions
virtual void	getBinaryRepresentation (ByteBuffer &byte_buffer) const=0
	Appends the binary representation of the Payload at the end of the buffer, without the fixed header.
virtual auto_ptr< Payload >	clone () const=0
	Cets a clone of this payload.
virtual string	toStringTab (uint8_t tabs) const =0
	Construct a textual representation of the object, preceded of a num of tabs of size TAB_SIZE.
Static Public Member Functions
static string	PAYLOAD_TYPE_STR (Payload::PAYLOAD_TYPE type)
	Returns the textual representation of a PAYLOAD_TYPE value.
Public Attributes
PAYLOAD_TYPE	type
	Payload type.
bool	critical
	Indicates if this payload is critical.
Protected Member Functions
	Payload (Payload::PAYLOAD_TYPE type, bool critical)
	Creates a new Payload.

---

Detailed Description

This abstract class represents a generic Payload of a Message.

Author:

Alejandro Perez Mendez, Pedro J. Fernandez Ruiz <alejandro_perez@dif.um.es, pedroj.fernandez@dif.um.es>

---

Member Enumeration Documentation

enum openikev2::Payload::PAYLOAD_TYPE

Payload types.

Enumerator:

PAYLOAD_NONE	Payload NONE.
PAYLOAD_SA	Security Association Payload.
PAYLOAD_KE	Key Exchange Payload.
PAYLOAD_IDi	Identification (initiartor) Payload.
PAYLOAD_IDr	Identification (responder) Payload.
PAYLOAD_CERT	Certificate Payload.
PAYLOAD_CERT_REQ	Certificate Request Payload.
PAYLOAD_AUTH	Authentication Payload.
PAYLOAD_NONCE	Nonce Payload.
PAYLOAD_NOTIFY	Notify Payload.
PAYLOAD_DEL	Delete Payload.
PAYLOAD_VENDOR	Vendor Payload.
PAYLOAD_TSi	Traffic Selector (initiator) Payload.
PAYLOAD_TSr	Traffic Selector (responder) Payload.
PAYLOAD_SK	Encrypted Payload.
PAYLOAD_CONF	Configuration Payload.
PAYLOAD_EAP	Extensible Authentication Payload.

---

Constructor & Destructor Documentation

openikev2::Payload::Payload	(	Payload::PAYLOAD_TYPE	type,
		bool	critical
	)			[protected]

Creates a new Payload.

Parameters:

	type	Payload type
	critical	Indicates if the payloads is critical or not

---

Member Function Documentation

string openikev2::Payload::PAYLOAD_TYPE_STR

(

Payload::PAYLOAD_TYPE

type

)

[static]

Returns the textual representation of a PAYLOAD_TYPE value.

Parameters:

type

Payload type

Returns:

Textual representation

virtual void openikev2::Payload::getBinaryRepresentation

(

ByteBuffer &

byte_buffer

)

const [pure virtual]

Appends the binary representation of the Payload at the end of the buffer, without the fixed header.

Parameters:

byte_buffer

Byte buffer where append the binary representation

Implemented in openikev2::Payload_AUTH, openikev2::Payload_CERT, openikev2::Payload_CERT_REQ, openikev2::Payload_CONF, openikev2::Payload_DEL, openikev2::Payload_EAP, openikev2::Payload_ID, openikev2::Payload_KE, openikev2::Payload_NONCE, openikev2::Payload_NOTIFY, openikev2::Payload_SA, openikev2::Payload_SK, openikev2::Payload_TS, and openikev2::Payload_VENDOR.

virtual auto_ptr<Payload> openikev2::Payload::clone

(

)

const [pure virtual]

Cets a clone of this payload.

Returns:

Clone of the payload.

Implemented in openikev2::Payload_AUTH, openikev2::Payload_CERT, openikev2::Payload_CERT_REQ, openikev2::Payload_CONF, openikev2::Payload_DEL, openikev2::Payload_EAP, openikev2::Payload_ID, openikev2::Payload_KE, openikev2::Payload_NONCE, openikev2::Payload_NOTIFY, openikev2::Payload_SA, openikev2::Payload_SK, openikev2::Payload_TS, and openikev2::Payload_VENDOR.

virtual string openikev2::Payload::toStringTab

(

uint8_t

tabs

)

const [pure virtual]

Construct a textual representation of the object, preceded of a num of tabs of size TAB_SIZE.

Parameters:

tabs

Num of tabs preceding the textual representation.

Returns:

Textual tabulated represetation of the object.

Implements openikev2::Printable.

Implemented in openikev2::Payload_AUTH, openikev2::Payload_CERT, openikev2::Payload_CERT_REQ, openikev2::Payload_CONF, openikev2::Payload_DEL, openikev2::Payload_EAP, openikev2::Payload_ID, openikev2::Payload_KE, openikev2::Payload_NONCE, openikev2::Payload_NOTIFY, openikev2::Payload_SA, openikev2::Payload_SK, openikev2::Payload_TS, and openikev2::Payload_VENDOR.

---