Home Agent MIP
API reference for diameter.message.commands.home_agent_mip.
This module contains Home-Agent-MIP Request and Answer messages, implementing AVPs documented in rfc4004.
HomeAgentMip ¶
HomeAgentMip(header: MessageHeader = None, avps: list[Avp] = None)
Bases: DefinedMessage
A Home-Agent-MIP base message.
This message class lists message attributes based on the current rfc4004 as python properties, acessible as instance attributes. AVPs not listed in the base protocol can be retrieved using the HomeAgentMip.find_avps search method.
Examples:
AVPs accessible either as instance attributes or by searching:
>>> msg = Message.from_bytes(b"...")
>>> msg.session_id
dra1.mvno.net;2323;546
>>> msg.find_avps((AVP_SESSION_ID, 0))
['dra1.mvno.net;2323;546']
When diameter message is decoded using
Message.from_bytes, it returns
either an instance of HomeAgentMipRequest or HomeAgentMipAnswer
automatically:
>>> msg = Message.from_bytes(b"...")
>>> assert msg.header.is_request is True
>>> assert isinstance(msg, HomeAgentMipRequest)
When creating a new message, the HomeAgentMipRequest or
HomeAgentMipAnswer class should be instantiated directly, and values
for AVPs set as class attributes:
>>> msg = HomeAgentMipRequest()
>>> msg.session_id = "dra1.mvno.net;2323;546"
Other, custom AVPs can be appended to the message using the
HomeAgentMip.append_avp method, or
by overwriting the avp attribute entirely. Regardless of the custom AVPs
set, the mandatory values listed in rfc4004 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.
HomeAgentMipAnswer ¶
HomeAgentMipAnswer(
header: MessageHeader = None, avps: list[Avp] = None
)
HomeAgentMipRequest ¶
HomeAgentMipRequest(
header: MessageHeader = None, avps: list[Avp] = None
)
Bases: HomeAgentMip
A Home-Agent-MIP-Request message.
mip_originating_foreign_aaa
instance-attribute
¶
mip_originating_foreign_aaa: MipOriginatingForeignAaa