Capabilities Exchange
API reference for diameter.message.commands.capabilities_exchange.
This module contains Capabilities-Exchange Request and Answer messages, implementing AVPs documented in rfc6733.
CapabilitiesExchange ¶
CapabilitiesExchange(
header: MessageHeader = None, avps: list[Avp] = None
)
Bases: DefinedMessage
A Capabilities-Exchange message.
This message class lists message attributes based on the current RFC6733 as python properties, acessible as instance attributes. AVPs not listed in the base protocol can be retrieved using the CapabilitiesExchange.find_avps search method.
Examples:
AVPs accessible either as instance attributes or by searching:
>>> msg = Message.from_bytes(b"...")
>>> msg.origin_realm
b'mvno.net'
>>> msg.find_avps((AVP_ORIGIN_REALM, 0))
[b'mvno.net']
When diameter message is decoded using
Message.from_bytes, it returns
either an instance of CapabilitiesExchangeRequest or
CapabilitiesExchangeAnswer automatically:
>>> msg = Message.from_bytes(b"...")
>>> assert msg.header.is_request is True
>>> assert isinstance(msg, CapabilitiesExchangeRequest)
When creating a new message, the CapabilitiesExchangeRequest or
CapabilitiesExchangeAnswer class should be instantiated directly, and
values for AVPs set as class attributes:
>>> msg = CapabilitiesExchangeRequest()
>>> msg.origin_realm = b"mvno.net"
Other, custom AVPs can be appended to the message using the
CapabilitiesExchange.append_avp
method, or by overwriting the avp attribute entirely. Regardless of the
custom AVPs set, the mandatory values listed in RFC6733 must be set,
however they can be set as None, if they are not to be used.
Warning
Every AVP documented for the subclasses of this command can be accessed
as an instance attribute, even if the original network-received message
did not contain that specific AVP. Such AVPs will be returned with the
value None when accessed.
Every other AVP not mentioned here, and not present in a
network-received message will raise an AttributeError when being
accessed; their presence should be validated with hasattr before
accessing.
CapabilitiesExchangeAnswer ¶
CapabilitiesExchangeAnswer(
header: MessageHeader = None, avps: list[Avp] = None
)
Bases: CapabilitiesExchange
A Capabilities-Exchange-Answer message.
vendor_specific_application_id
instance-attribute
¶
vendor_specific_application_id: list[VendorSpecificApplicationId]
CapabilitiesExchangeRequest ¶
CapabilitiesExchangeRequest(
header: MessageHeader = None, avps: list[Avp] = None
)
Bases: CapabilitiesExchange
A Capabilities-Exchange-Request message.
vendor_specific_application_id
instance-attribute
¶
vendor_specific_application_id: list[VendorSpecificApplicationId]