openikev2::Payload_CONF Class Reference

This class represents a Configuration Payload. More...

#include <payload_conf.h>

Inheritance diagram for openikev2::Payload_CONF:

[legend]List of all members.

Public Types
enum	CONFIGURATION_TYPE {   RESERVED = 0, CFG_REQUEST = 1, CFG_REPLY = 2, CFG_SET = 3,   CFG_ACK = 4 }
	Configuration types. More...
Public Member Functions
	Payload_CONF (CONFIGURATION_TYPE configuration_type)
	Creates a new Payload_CONF.
	Payload_CONF (const Payload_CONF &other)
	Creates a new Payload_CONF cloning another one.
	Payload_CONF (ByteBuffer &byte_buffer)
	Creates a new Payload_KE based on its binary representation.
void	addConfigurationAttribute (auto_ptr< ConfigurationAttribute > attribute)
	Add an attribute to the configuration.
virtual void	getBinaryRepresentation (ByteBuffer &byte_buffer) const
	Appends the binary representation of the Payload at the end of the buffer, without the fixed header.
virtual string	toStringTab (uint8_t tabs) const
	Construct a textual representation of the object, preceded of a num of tabs of size TAB_SIZE.
virtual auto_ptr< Payload >	clone () const
	Cets a clone of this payload.
Static Public Member Functions
static string	CONFIGURATION_TYPE_STR (CONFIGURATION_TYPE conf_type)
	Translate from Configuration type IDs to strings.
Public Attributes
AutoVector< ConfigurationAttribute >	attributes
	Configuration attribute collection.
Protected Attributes
CONFIGURATION_TYPE	configuration_type
	Configuration type.

---

Detailed Description

This class represents a Configuration Payload.

Author:

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

---

Member Enumeration Documentation

enum openikev2::Payload_CONF::CONFIGURATION_TYPE

Configuration types.

Enumerator:

RESERVED	Reserved.
CFG_REQUEST	Configuration request.
CFG_REPLY	Configuration reply.
CFG_SET	Configuration set.
CFG_ACK	Configuration ACK.

---

Constructor & Destructor Documentation

openikev2::Payload_CONF::Payload_CONF

(

CONFIGURATION_TYPE

configuration_type

)

Creates a new Payload_CONF.

Parameters:

configuration_type

Configuration type

openikev2::Payload_CONF::Payload_CONF

(

const Payload_CONF &

other

)

Creates a new Payload_CONF cloning another one.

Parameters:

other

Other Payload_CONF to be cloned

openikev2::Payload_CONF::Payload_CONF

(

ByteBuffer &

byte_buffer

)

Creates a new Payload_KE based on its binary representation.

Parameters:

byte_buffer

Buffer with its read pointer at the "payload length" field

---

Member Function Documentation

string openikev2::Payload_CONF::CONFIGURATION_TYPE_STR

(

CONFIGURATION_TYPE

conf_type

)

[static]

Translate from Configuration type IDs to strings.

Parameters:

conf_type

Configuration type IDs

Returns:

String with the configuration type

void openikev2::Payload_CONF::addConfigurationAttribute

(

auto_ptr< ConfigurationAttribute >

attribute

)

Add an attribute to the configuration.

Parameters:

attribute

Attribute to be added

void openikev2::Payload_CONF::getBinaryRepresentation

(

ByteBuffer &

byte_buffer

)

const [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

Implements openikev2::Payload.

string openikev2::Payload_CONF::toStringTab

(

uint8_t

tabs

)

const [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::Payload.

auto_ptr< Payload > openikev2::Payload_CONF::clone

(

)

const [virtual]

Cets a clone of this payload.

Returns:

Clone of the payload.

Implements openikev2::Payload.

---