libbgp::BgpKeepaliveMessage Class Reference

The BgpKeepaliveMessage class. More...

#include <bgp-keepalive-message.h>

Inheritance diagram for libbgp::BgpKeepaliveMessage:

Collaboration diagram for libbgp::BgpKeepaliveMessage:

Public Member Functions
	BgpKeepaliveMessage (BgpLogHandler *logger)
	Construct a new Bgp Keepalive Message:: Bgp Keepalive Message object. More...
ssize_t	doPrint (size_t indent, uint8_t **to, size_t *buf_sz) const
	Print implementation. More...
ssize_t	parse (const uint8_t *from, size_t msg_sz)
	Deserialize a BGP message body. More...
ssize_t	write (uint8_t *to, size_t buf_sz) const
	Serialize a BGP message body. More...
Public Member Functions inherited from libbgp::BgpMessage
	BgpMessage (BgpLogHandler *logger)
	Construct a new Bgp Message object. More...
Public Member Functions inherited from libbgp::Serializable
	Serializable (BgpLogHandler *logger)
	Construct a new Serializable:: Serializable object. More...
	~Serializable ()
	Destroy the Serializable:: Serializable object.
ssize_t	print (uint8_t *to, size_t buf_sz) const
	Print the Serializable object as human readable string. More...
ssize_t	print (size_t indent, uint8_t *to, size_t buf_sz) const
	Print the Serializable object as human readable string, with indentation. More...
virtual ssize_t	length () const
	Get size in bytes required to serialize the object. More...
bool	hasError () const
	Check if error information available. More...
uint8_t	getErrorCode () const
uint8_t	getErrorSubCode () const
const uint8_t *	getError () const
size_t	getErrorLength () const
void	setLogger (BgpLogHandler *logger)
	Replace logger for this object. More...

Additional Inherited Members
Public Attributes inherited from libbgp::BgpMessage
uint8_t	type
Protected Member Functions inherited from libbgp::Serializable
void	setError (uint8_t err, uint8_t suberr, const uint8_t *data, size_t data_len)
	Set the error information. More...
void	forwardParseError (const Serializable &other)
	Forward error information from other Serializable object. More...
Static Protected Member Functions inherited from libbgp::Serializable
static ssize_t	_print (size_t indent, uint8_t **to, size_t *buf_left, const char *format,...)
	Print helper. More...
Protected Attributes inherited from libbgp::Serializable
uint8_t	err_code
uint8_t	err_subcode
size_t	err_len
uint8_t *	err_data
BgpLogHandler *	logger

Detailed Description

The BgpKeepaliveMessage class.

This is deserializer/serializer for BGP keepalive message body. If you want to deserializer/serializer a full BGP message. Take a look at BgpPacket class.

Definition at line 27 of file bgp-keepalive-message.h.

Constructor & Destructor Documentation

BgpKeepaliveMessage()

libbgp::BgpKeepaliveMessage::BgpKeepaliveMessage

(

BgpLogHandler *

logger

)

Construct a new Bgp Keepalive Message:: Bgp Keepalive Message object.

Parameters

loggger

Pointer to logger object for error logging.

Definition at line 22 of file bgp-keepalive-message.cc.

Member Function Documentation

doPrint()

ssize_t libbgp::BgpKeepaliveMessage::doPrint ( size_t  indent, uint8_t **  to, size_t *  buf_sz  ) const

virtual

Print implementation.

Parameters

indent	indent level.
to	The pointer to the pointer to the string buffer.
buf_sz	The pointer to the counter of avaliable buffer space.

Returns

ssize_t ssize_t Bytes written.

Return values

-1	Failed to print.
>=	0 Bytes written.

Implements libbgp::Serializable.

Definition at line 40 of file bgp-keepalive-message.cc.

References libbgp::Serializable::_print().

parse()

ssize_t libbgp::BgpKeepaliveMessage::parse ( const uint8_t *  from, size_t  msg_sz  )

virtual

Deserialize a BGP message body.

BgpMessage deserializer only deserialize message body. (i.e. message without BGP marker and message length field) To deserialize a BGP packet, use BgpPacket.

Parameters

from	Pointer to message body buffer.
msg_sz	Size of message.

Returns

ssize_t Bytes read.

Return values

-1	Deserialization error. Error may be logged.
>=0	Bytes read.

Exceptions

bad_parse	Internal deserialization error.
bad_type	The type of message/field member in buffer does not match the attribute type of container.

Implements libbgp::BgpMessage.

Definition at line 26 of file bgp-keepalive-message.cc.

References libbgp::Serializable::setError().

write()

ssize_t libbgp::BgpKeepaliveMessage::write ( uint8_t *  to, size_t  buf_sz  ) const

virtual

Serialize a BGP message body.

BgpMessage serializer only serialize message body. (i.e. message without BGP marker and message length field) To serialize a BGP packet, use BgpPacket.

Parameters

to	Pointer to destination buffer.
buf_sz	Max write size.

Returns

ssize_t Bytes written.

Return values

-1	Serialization error. Error may be logged.
>=0	Bytes written.

Implements libbgp::BgpMessage.

Definition at line 36 of file bgp-keepalive-message.cc.

---

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

• src/bgp-keepalive-message.h
• src/bgp-keepalive-message.cc