Skip to content

Registration Termination

API reference for diameter.message.commands.registration_termination.

This module contains Registration-Termination Request and Answer messages, implementing AVPs documented in 3GPP TS 29.229.

RegistrationTermination 

RegistrationTermination(
    header: MessageHeader = None, avps: list[Avp] = None
)

Bases: DefinedMessage

A Registration-Termination base message.

This message class lists message attributes based on the current 3GPP TS 29.229 version 13.1.0 Release 13 as python properties, accessible as instance attributes. AVPs not listed in the spec protocol can be retrieved using the RegistrationTermination.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 a diameter message is decoded using Message.from_bytes, it returns either an instance of RegistrationTerminationRequest or RegistrationTerminationAnswer automatically:

>>> msg = Message.from_bytes(b"...")
>>> assert msg.header.is_request is True
>>> assert isinstance(msg, RegistrationTerminationRequest)

When creating a new message, the RegistrationTerminationRequest or RegistrationTerminationAnswer class should be instantiated directly, and values for AVPs set as class attributes:

>>> msg = RegistrationTerminationRequest()
>>> msg.session_id = "dra1.mvno.net;2323;546"

Other, custom AVPs can be appended to the message using the RegistrationTermination.append_avp method, or by overwriting the avp attribute entirely. Regardless of the custom AVPs set, the mandatory values listed in TS 29.229 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.

RegistrationTerminationAnswer 

RegistrationTerminationAnswer(
    header: MessageHeader = None, avps: list[Avp] = None
)

Bases: RegistrationTermination

A Registration-Termination-Answer message.

associated_identities instance-attribute 

associated_identities: AssociatedIdentities

auth_session_state instance-attribute 

auth_session_state: int

drmp instance-attribute 

drmp: int

experimental_result instance-attribute 

experimental_result: ExperimentalResult

failed_avp instance-attribute 

failed_avp: list[FailedAvp]

identity_with_emergency_registration instance-attribute 

identity_with_emergency_registration: list[
    IdentityWithEmergencyRegistration
]

origin_host instance-attribute 

origin_host: bytes

origin_realm instance-attribute 

origin_realm: bytes

proxy_info instance-attribute 

proxy_info: list[ProxyInfo]

result_code instance-attribute 

result_code: int

route_record instance-attribute 

route_record: list[bytes]

session_id instance-attribute 

session_id: str

supported_features instance-attribute 

supported_features: list[SupportedFeatures]

vendor_specific_application_id instance-attribute 

vendor_specific_application_id: VendorSpecificApplicationId

RegistrationTerminationRequest 

RegistrationTerminationRequest(
    header: MessageHeader = None, avps: list[Avp] = None
)

Bases: RegistrationTermination

A Registration-Termination-Request message.

associated_identities instance-attribute 

associated_identities: AssociatedIdentities

auth_session_state instance-attribute 

auth_session_state: int

deregistration_reason instance-attribute 

deregistration_reason: DeregistrationReason

destination_host instance-attribute 

destination_host: bytes

destination_realm instance-attribute 

destination_realm: bytes

drmp instance-attribute 

drmp: int

origin_host instance-attribute 

origin_host: bytes

origin_realm instance-attribute 

origin_realm: bytes

proxy_info instance-attribute 

proxy_info: list[ProxyInfo]

public_identity instance-attribute 

public_identity: list[str]

route_record instance-attribute 

route_record: list[bytes]

session_id instance-attribute 

session_id: str

supported_features instance-attribute 

supported_features: list[SupportedFeatures]

user_name instance-attribute 

user_name: str

vendor_specific_application_id instance-attribute 

vendor_specific_application_id: VendorSpecificApplicationId