Product Documentation

DIAMETER_PROTOCOL_T

Jun 14, 2016

Provides expressions to retrieve Diameter header information and Diameter Header and AVPs (attribute value pairs) from Diameter requests and responses.

Note: The Diameter implementation is RFC 6733 compliant.

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

IS_CLIENT

Returns true if this is a Diameter client connection.

Returns: bool_at

IS_SERVER

Returns true if this is a Diameter server connection.

Returns: bool_at

NEW_ANSWER

Creates new Diameter Response Message (Header only) based on Request header.

Returns: text_t

NEW_ANSWER (bool_at error, ip_address_at command_code, ip_address_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, ip_address_at command_code, num_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, ip_address_at command_code, time_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, ip_address_at command_code, unsigned_long_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, num_at command_code, ip_address_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, num_at command_code, num_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, num_at command_code, time_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, num_at command_code, unsigned_long_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, time_at command_code, ip_address_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, time_at command_code, num_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, time_at command_code, time_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, time_at command_code, unsigned_long_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, unsigned_long_at command_code, ip_address_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, unsigned_long_at command_code, num_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, unsigned_long_at command_code, time_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_ANSWER (bool_at error, unsigned_long_at command_code, unsigned_long_at application_id)

Creates new Diameter Message (Header only) based on given parameters.

Parameters:

error - Error flag

command_code - Command associated with the Diameter message

application_id - Application id to be used in Diameter Header

Returns: text_t

NEW_AVP_FLOAT32 (uint avpcode, double_at avpvalue)

Creates new AVP based on given avp code and given Float32 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_FLOAT32 (uint avpcode, ip_address_at avpvalue)

Creates new AVP based on given avp code and given Float32 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_FLOAT32 (uint avpcode, num_at avpvalue)

Creates new AVP based on given avp code and given Float32 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_FLOAT32 (uint avpcode, time_at avpvalue)

Creates new AVP based on given avp code and given Float32 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_FLOAT32 (uint avpcode, unsigned_long_at avpvalue)

Creates new AVP based on given avp code and given Float32 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_FLOAT32 (uint avpcode, double_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Float32 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_FLOAT32 (uint avpcode, ip_address_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Float32 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_FLOAT32 (uint avpcode, num_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Float32 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_FLOAT32 (uint avpcode, time_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Float32 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_FLOAT32 (uint avpcode, unsigned_long_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Float32 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_FLOAT64 (uint avpcode, double_at avpvalue)

Creates new AVP based on given avp code and given Float64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_FLOAT64 (uint avpcode, ip_address_at avpvalue)

Creates new AVP based on given avp code and given Float64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_FLOAT64 (uint avpcode, num_at avpvalue)

Creates new AVP based on given avp code and given Float64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_FLOAT64 (uint avpcode, time_at avpvalue)

Creates new AVP based on given avp code and given Float64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_FLOAT64 (uint avpcode, unsigned_long_at avpvalue)

Creates new AVP based on given avp code and given Float64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_FLOAT64 (uint avpcode, double_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Float64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_FLOAT64 (uint avpcode, ip_address_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Float64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_FLOAT64 (uint avpcode, num_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Float64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_FLOAT64 (uint avpcode, time_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Float64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_FLOAT64 (uint avpcode, unsigned_long_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Float64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_INTEGER32 (uint avpcode, num_at avpvalue)

Creates new AVP based on given avp code and given Integer32 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_INTEGER32 (uint avpcode, num_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Integer32 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_INTEGER64 (uint avpcode, ip_address_at avpvalue)

Creates new AVP based on given avp code and given Integer64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_INTEGER64 (uint avpcode, num_at avpvalue)

Creates new AVP based on given avp code and given Integer64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_INTEGER64 (uint avpcode, time_at avpvalue)

Creates new AVP based on given avp code and given Integer64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_INTEGER64 (uint avpcode, unsigned_long_at avpvalue)

Creates new AVP based on given avp code and given Integer64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_INTEGER64 (uint avpcode, ip_address_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Integer64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_INTEGER64 (uint avpcode, num_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Integer64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_INTEGER64 (uint avpcode, time_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Integer64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_INTEGER64 (uint avpcode, unsigned_long_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Integer64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP (uint avpcode, text_t avpvalue)

Creates new AVP based on given avp code and given value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value as octet string

Returns: text_t

NEW_AVP (uint avpcode, text_t avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value as octet string

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_UNSIGNED32 (uint avpcode, uint avpvalue)

Creates new AVP based on given avp code and given Unsigned32 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_UNSIGNED32 (uint avpcode, uint avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Unsigned32 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_UNSIGNED64 (uint avpcode, ip_address_at avpvalue)

Creates new AVP based on given avp code and given Unsigned64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_UNSIGNED64 (uint avpcode, num_at avpvalue)

Creates new AVP based on given avp code and given Unsigned64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_UNSIGNED64 (uint avpcode, time_at avpvalue)

Creates new AVP based on given avp code and given Unsigned64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_UNSIGNED64 (uint avpcode, unsigned_long_at avpvalue)

Creates new AVP based on given avp code and given Unsigned64 value. Vendor-Specific and Mandatory bit are not set.

Parameters:

avpcode - AVP code

avpvalue - AVP value

Returns: text_t

NEW_AVP_UNSIGNED64 (uint avpcode, ip_address_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Unsigned64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_UNSIGNED64 (uint avpcode, num_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Unsigned64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_UNSIGNED64 (uint avpcode, time_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Unsigned64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_AVP_UNSIGNED64 (uint avpcode, unsigned_long_at avpvalue, bool_at is_mandatory, uint vendor_id)

Creates new AVP based on given avp code and given Unsigned64 value. Set the 'M' and 'V' bits, and vendor_id field for this AVP.

Parameters:

avpcode - AVP code

avpvalue - AVP value

is_mandatory - 'true' to set The 'M' bit in AVP

vendor_id - vendor_id field. non-zero vendor_id sets the 'V' bit and fills the vendor_id field in AVP as given.

Returns: text_t

NEW_ERROR_ANSWER

Creates new Diameter Error Response Message (Header only) based on Request header.

Returns: text_t

NEW_REDIRECT (text_t redirectUri)

Creates new Diameter Redirect Response Message (Header only) based on Request header. This Redirect message will not have Redirect-Host-Usage and Redirect-Max-Cache-Time AVP.

Parameters (expressions not allowed):

redirectUri - Redirect-Host AVP value

Returns: text_t

NEW_REDIRECT (text_t redirectUri, uint hostUsage, uint maxCacheTime)

Creates new Diameter Redirect Response Message (Header only) based on Request header. Use hostUsage and maxCacheTime parameters to insert Redirect-Host-Usage and Redirect-Max-Cache-Time AVP as defined in RFC 6733 section-6.13 (http://tools.ietf.org/html/rfc6733#section-6.13)

Parameters (expressions not allowed):

redirectUri - Redirect-Host AVP value

hostUsage - Redirect-Host-Usage AVP value

maxCacheTime - Redirect-Max-Cache-Time AVP value.

Returns: text_t

REQ

Retrieves header information and AVPs from Diameter requests.

Returns: diameter_req_t

RES

Retrieves header information and AVPs from Diameter responses.

Returns: diameter_res_t