Product Documentation

RADIUS_RES_T

Sep 12, 2016

Retrieves header information and AVPs from radius responses.

AVPs can be retrieved by:

  • Directly specifying the AVP codes in the form: radius.RES.AVP( ). For example, to retrieve the PROXY STATE AVP (code 33), you can use the expression: radius.RES.AVP(33).
General usage: radius.RES.

This topic lists the expressions that are provided by this class.

Note: Expressions with the * symbol are inherited/promoted from radius_message_t.

* ACCT_MULTI_SESSION_ID

Returns the Acct-Multi-Session-Id AVP (code 50) from the message.

Returns: radius_avp_t

* ACCT_SESSION_ID

Returns the Acct-Session-ID AVP (code 44) from the message.

Returns: radius_avp_t

* ACCT_STATUS_TYPE

Returns the ACCT_STATUS_TYPE AVP (code 40) from the message.

Returns: radius_avp_t

* AVP_END

Returns the location at the end of radius message (or in other words end of all AVPs) in radius message.

Returns: text_t

* AVP_LIST

Returns the AVP region in radius message (or in other words returns location at start of AVPs and length equal to radius message length excluding header).

Returns: text_t

* AVP (uint avpcode)

Returns the specified AVP from the message.

For example, to get the AVP with code 26 from a Request, use the expression: radius.REQ.AVP(26).

Parameters (expressions not allowed):

avpcode - AVP code

Returns: radius_avp_t

* AVP (uint avpcode, uint vendorid)

Returns the specified AVP encoded within a Vendor-Specific Radius attribute with the given vendorid from the message.

For example, to get Vendor AVP 1 with vender ID '10415' from a Request, use the expression: radius.REQ.AVP(10, 10415).

Parameters (expressions not allowed):

avpcode - AVP code

vendorid - Vendor ID

Returns: radius_avp_t

* AVP_START

Returns the location at the start of AVPs (or in other words end of radius header) in radius message.

Returns: text_t

* CALLED_STATION_ID

Returns the CALLED_STATION_ID AVP (code 30) from the message.

Returns: radius_avp_t

* CALLING_STATION_ID

Returns the CALLING_STATION_ID AVP (code 31) from the message.

Returns: radius_avp_t

* CODE

Returns code header field from the message.

Returns: radius_code_t

* FRAMED_IP_ADDRESS

Returns the FRAMED_IP_ADDRESS AVP (code 8) from the message.

Returns: radius_avp_t

* FRAMED_PROTOCOL

Returns the FRAMED_PROTOCOL AVP (code 7) from the message.

Returns: radius_avp_t

* IDENTIFIER

Returns identifier header field from the message.

Returns: num_at

* LENGTH

Returns the Message Length from the message.

Returns: num_at

* NAS_IDENTIFIER

Returns the NAS_IDENTIFIER AVP (code 32) from the message.

Returns: radius_avp_t

* NAS_IP_ADDRESS

Returns the NAS-IP-ADDRESS AVP (code 4) from the message.

Returns: radius_avp_t

* NAS_PORT

Returns the NAS_PORT AVP (code 5) from the message.

Returns: radius_avp_t

TYPECAST_RADIUS_MESSAGE_T

Convert radius_res_t to radius_message_t. Will raise an undef if the value is null, empty, or the value has an invalid format for the destination type. (radius_message_t : Define common operations for radius.Req or radius.Res.)

Returns: radius_message_t

* USER_NAME

Returns the User-Name AVP (code 1) from the message.

Returns: radius_avp_t

* VENDOR_SPECIFIC

Returns the Vendor-Id AVP (code 26) from the message.

Returns: vendor_spec_radius_avp_t