class RipPacket

RIP Packet class. More...

List of all Methods
Definition	`#include <packets.hh>`
Template form	RipPacket<typename A>


	Annotated List
	Files
	Globals
	Hierarchy
	Index

Public Types

typedef A Addr

Public Methods

inline const Addr& address () const
inline uint16_t port () const
inline uint32_t max_entries () const
inline void set_max_entries (uint32_t max_entries)
RipPacket (const Addr& addr, uint16_t port, uint32_t max_entries = RIPv2_ROUTES_PER_PACKET)
inline const RipPacketHeader* header () const
inline RipPacketHeader* header ()
inline const PacketRouteEntry<A>* route_entry (uint32_t entry_no) const
inline PacketRouteEntry<A>* route_entry (uint32_t entry_no)
void append_data (const uint8_t* data, uint32_t data_bytes)
void append_data (const vector<uint8_t>& data)
inline vector<uint8_t>& data ()
inline const vector<uint8_t>& data () const
inline uint32_t data_bytes () const
inline const uint8_t* data_ptr () const
inline uint8_t* data_ptr ()
template <typename A> const RipPacketHeader* header () const
template <typename A> RipPacketHeader* header ()
template <typename A> const PacketRouteEntry<A>* route_entry (uint32_t entry_no) const
template <typename A> PacketRouteEntry<A>* route_entry (uint32_t entry_no)
template <typename A> void append_data (const uint8_t* data, uint32_t data_bytes)
template <typename A> void append_data (const vector<uint8_t>& data)
template <typename A> void set_max_entries (uint32_t max_entries)

Protected Methods

const uint8_t* base_ptr () const
uint8_t* base_ptr ()

Protected Members

Addr _addr
uint16_t _port
vector<uint8_t> _data
uint32_t _max_entries

Detailed Description

A container for RIP packet, provides easy to use accessors and modifiers.

typedef A Addr

Addr

Addr _addr

_addr

[protected]

uint16_t _port

_port

[protected]

vector<uint8_t> _data

_data

[protected]

uint32_t _max_entries

_max_entries

[protected]

const uint8_t* base_ptr ()

base_ptr

[protected const]

uint8_t* base_ptr ()

base_ptr

[protected]

inline const Addr& address ()

address

[const]

Returns: destination address of packet.

inline uint16_t port ()

port

[const]

Returns: destination port of packet.

inline uint32_t max_entries ()

max_entries

[const]

Returns: the maximum number of route entries packet may have.

inline void set_max_entries (uint32_t max_entries)

set_max_entries

Set the maximum number of route entries a packet may have. This method should be called before using append_data methods as it resizes the internal storage and will cause appended data to be lost.

RipPacket (const Addr& addr, uint16_t port, uint32_t max_entries = RIPv2_ROUTES_PER_PACKET)

RipPacket

inline const RipPacketHeader* header ()

header

[const]

Returns: const pointer to RipPacketHeader.

inline RipPacketHeader* header ()

header

Returns: pointer to RipPacketHeader.

inline const PacketRouteEntry<A>* route_entry (uint32_t entry_no)

route_entry

[const]

Route entry accessor.

Parameters:

entry_no index of route entry to retrive

Returns: const pointer to route entry, or 0 if entry_no is greater than the maximum route entries associated with packet.

inline PacketRouteEntry<A>* route_entry (uint32_t entry_no)

route_entry

Route entry accessor.

Parameters:

entry_no index of route entry to retrive

Returns: const pointer to route entry, or 0 if entry_no is greater than the maximum route entries associated with packet.

void append_data (const uint8_t* data, uint32_t data_bytes)

append_data

void append_data (const vector<uint8_t>& data)

append_data

inline vector<uint8_t>& data ()

data

inline const vector<uint8_t>& data ()

data

[const]

inline uint32_t data_bytes ()

data_bytes

[const]

inline const uint8_t* data_ptr ()

data_ptr

[const]

inline uint8_t* data_ptr ()

data_ptr

template <typename A> const RipPacketHeader* header ()

header

[const]

template <typename A> RipPacketHeader* header ()

header

template <typename A> const PacketRouteEntry<A>* route_entry (uint32_t entry_no)

route_entry

[const]

template <typename A> PacketRouteEntry<A>* route_entry (uint32_t entry_no)

route_entry

template <typename A> void append_data (const uint8_t* data, uint32_t data_bytes)

append_data

template <typename A> void append_data (const vector<uint8_t>& data)

append_data

template <typename A> void set_max_entries (uint32_t max_entries)

set_max_entries

Generated by: pavlin on possum.icir.org on Thu Aug 28 12:52:20 2003, using kdoc 2.0a54+XORP.