Kea 3.0.0
isc::radius::AttrIpAddr Class Reference

RADIUS attribute holding IPv4 addresses. More...

#include <client_attribute.h>

Inheritance diagram for isc::radius::AttrIpAddr:

Public Member Functions

virtual size_t getValueLen () const override
 Value length.
virtual AttrValueType getValueType () const override
 Get value type.
virtual std::vector< uint8_t > toBytes () const override
 To bytes.
virtual data::ElementPtr toElement () const override
 Unparse attribute.
virtual asiolink::IOAddress toIpAddr () const override
 To IPv4 address.
virtual std::string toText (size_t indent=0) const override
 Returns text representation of the attribute.
Public Member Functions inherited from isc::radius::Attribute
virtual ~Attribute ()=default
 Virtual destructor.
uint8_t getType () const
 Get type.
virtual std::vector< uint8_t > toBinary () const
 To binary.
virtual uint32_t toInt () const
 To integer.
virtual asiolink::IOAddress toIpv6Addr () const
 To IPv6 address.
virtual asiolink::IOAddress toIpv6Prefix () const
 To IPv6 prefix.
virtual uint8_t toIpv6PrefixLen () const
 To IPv6 prefix length.
virtual std::string toString () const
 Specific get methods.
Public Member Functions inherited from isc::data::CfgToElement
virtual ~CfgToElement ()
 Destructor.

Protected Member Functions

 AttrIpAddr (const uint8_t type, const asiolink::IOAddress &value)
 Constructor.
Protected Member Functions inherited from isc::radius::Attribute
 Attribute (const uint8_t type)
 Constructor.

Static Protected Member Functions

static AttributePtr fromBytes (const uint8_t type, const std::vector< uint8_t > &bytes)
 From bytes.
static AttributePtr fromText (const uint8_t type, const std::string &repr)
 From text.

Friends

class Attribute
 Make Attribute a friend class.

Additional Inherited Members

Static Public Member Functions inherited from isc::radius::Attribute
static AttributePtr fromBinary (const uint8_t type, const std::vector< uint8_t > &value)
 From binary with type.
static AttributePtr fromBytes (const AttrDefPtr &def, const std::vector< uint8_t > &value)
 From bytes with definition.
static AttributePtr fromBytes (const std::vector< uint8_t > &bytes)
 From bytes (wire format).
static AttributePtr fromInt (const uint8_t type, const uint32_t value)
 From integer with type.
static AttributePtr fromIpAddr (const uint8_t type, const asiolink::IOAddress &value)
 From IPv4 address with type.
static AttributePtr fromIpv6Addr (const uint8_t type, const asiolink::IOAddress &value)
 From IPv6 address with type.
static AttributePtr fromIpv6Prefix (const uint8_t type, const uint8_t len, const asiolink::IOAddress &value)
 From IPv6 prefix with type.
static AttributePtr fromString (const uint8_t type, const std::string &value)
 From type specific factories.
static AttributePtr fromText (const AttrDefPtr &def, const std::string &value)
 From definition generic factories.
static AttributePtr fromText (const std::string &repr)
 Generic factories.
Public Attributes inherited from isc::radius::Attribute
const uint8_t type_
 Type.

Detailed Description

RADIUS attribute holding IPv4 addresses.

Definition at line 406 of file client_attribute.h.

Constructor & Destructor Documentation

◆ AttrIpAddr()

isc::radius::AttrIpAddr::AttrIpAddr ( const uint8_t type,
const asiolink::IOAddress & value )
inlineprotected

Constructor.

Parameters
typeattribute type.
valueIP address value.

Definition at line 413 of file client_attribute.h.

References Attribute, and isc::asiolink::IOAddress::isV4().

Referenced by fromBytes(), and fromText().

Here is the call graph for this function:

Member Function Documentation

◆ fromBytes()

AttributePtr isc::radius::AttrIpAddr::fromBytes ( const uint8_t type,
const std::vector< uint8_t > & bytes )
staticprotected

From bytes.

Parameters
typeattribute type.
bytesbinary value.
Returns
pointer to the attribute or null.

Definition at line 406 of file client_attribute.cc.

References AttrIpAddr(), isc::asiolink::IOAddress::fromBytes(), isc::radius::AttrDefs::instance(), isc_throw, LOG_ERROR, isc::radius::RADIUS_IPADDR_ATTRIBUTE_FROM_BYTES_FAILED, and isc::radius::radius_logger.

Referenced by isc::radius::Attribute::fromBytes().

Here is the call graph for this function:

◆ fromText()

AttributePtr isc::radius::AttrIpAddr::fromText ( const uint8_t type,
const std::string & repr )
staticprotected

From text.

Parameters
typeattribute type.
reprvalue representation.
Returns
pointer to the attribute or null.

Definition at line 392 of file client_attribute.cc.

References AttrIpAddr(), isc::radius::AttrDefs::instance(), LOG_ERROR, isc::radius::RADIUS_IPADDR_ATTRIBUTE_FROM_TEXT_FAILED, and isc::radius::radius_logger.

Referenced by isc::radius::Attribute::fromText().

Here is the call graph for this function:

◆ getValueLen()

virtual size_t isc::radius::AttrIpAddr::getValueLen ( ) const
inlineoverridevirtual

Value length.

Returns
Value length.

Implements isc::radius::Attribute.

Definition at line 449 of file client_attribute.h.

◆ getValueType()

virtual AttrValueType isc::radius::AttrIpAddr::getValueType ( ) const
inlineoverridevirtual

Get value type.

Returns
the value type.

Implements isc::radius::Attribute.

Definition at line 442 of file client_attribute.h.

References isc::radius::PW_TYPE_IPADDR.

◆ toBytes()

vector< uint8_t > isc::radius::AttrIpAddr::toBytes ( ) const
overridevirtual

To bytes.

Returns
binary representation.

Implements isc::radius::Attribute.

Definition at line 432 of file client_attribute.cc.

References isc::radius::Attribute::getType().

Here is the call graph for this function:

◆ toElement()

ElementPtr isc::radius::AttrIpAddr::toElement ( ) const
overridevirtual

Unparse attribute.

Returns
a pointer to unparsed attribute.

Implements isc::data::CfgToElement.

Definition at line 443 of file client_attribute.cc.

References Element::create(), Element::createMap(), isc::radius::AttrDefs::getByType(), isc::radius::Attribute::getType(), and isc::radius::AttrDefs::instance().

Here is the call graph for this function:

◆ toIpAddr()

virtual asiolink::IOAddress isc::radius::AttrIpAddr::toIpAddr ( ) const
inlineoverridevirtual

To IPv4 address.

Returns
the IPv4 address value.

Reimplemented from isc::radius::Attribute.

Definition at line 467 of file client_attribute.h.

◆ toText()

string isc::radius::AttrIpAddr::toText ( size_t indent = 0) const
overridevirtual

Returns text representation of the attribute.

Parameters
indentnumber of spaces before printing text.
Returns
string with text representation.

Implements isc::radius::Attribute.

Definition at line 421 of file client_attribute.cc.

References isc::radius::AttrDefs::getName(), isc::radius::Attribute::getType(), and isc::radius::AttrDefs::instance().

Here is the call graph for this function:

◆ Attribute

friend class Attribute
friend

Make Attribute a friend class.

Definition at line 436 of file client_attribute.h.

References Attribute.

Referenced by AttrIpAddr(), and Attribute.


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