Skip to content

Notify

API reference for diameter.message.commands.notify.

This module contains Notify Request and Answer messages for the S6a/S6d interface, implementing AVPs documented in 3GPP TS 29.272.

Notify 

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

Bases: DefinedMessage

A Notify base message.

This message class lists message attributes based on the current 3GPP TS 29.272 version 19.4.0 Release 19 as python properties, accessible as instance attributes. AVPs not listed in the spec protocol can be retrieved using the Notify.find_avps search method.

Examples:

AVPs accessible either as instance attributes or by searching:

>>> msg = Message.from_bytes(b"...")
>>> msg.session_id
dra1.python-diameter.org;2323;546
>>> msg.find_avps((AVP_SESSION_ID, 0))
['dra1.python-diameter.org;2323;546']

When diameter message is decoded using Message.from_bytes, it returns either an instance of NotifyRequest or NotifyAnswer automatically:

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

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

>>> msg = NotifyRequest()
>>> msg.session_id = "dra1.python-diameter.org;2323;546"

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

NotifyAnswer 

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

Bases: Notify

A Notify-Answer message.

3GPP TS 29.272 version 19.4.0

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]

load instance-attribute 

load: list[Load]

oc_olr instance-attribute 

oc_olr: OcOlr

oc_supported_features instance-attribute 

oc_supported_features: OcSupportedFeatures

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

NotifyRequest 

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

Bases: Notify

A Notify-Request message.

3GPP TS 29.272 version 19.4.0

alert_reason instance-attribute 

alert_reason: int

auth_session_state instance-attribute 

auth_session_state: int

context_identifier instance-attribute 

context_identifier: int

destination_host instance-attribute 

destination_host: bytes

destination_realm instance-attribute 

destination_realm: bytes

drmp instance-attribute 

drmp: int

emergency_services instance-attribute 

emergency_services: int

homogeneous_support_of_ims_voice_over_ps_sessions instance-attribute 

homogeneous_support_of_ims_voice_over_ps_sessions: int

maximum_ue_availability_time instance-attribute 

maximum_ue_availability_time: datetime

mip6_agent_info instance-attribute 

mip6_agent_info: Mip6AgentInfo

monitoring_event_config_status instance-attribute 

monitoring_event_config_status: list[MonitoringEventConfigStatus]

nor_flags instance-attribute 

nor_flags: int

oc_supported_features instance-attribute 

oc_supported_features: OcSupportedFeatures

origin_host instance-attribute 

origin_host: bytes

origin_realm instance-attribute 

origin_realm: bytes

proxy_info instance-attribute 

proxy_info: list[ProxyInfo]

route_record instance-attribute 

route_record: list[bytes]

service_selection instance-attribute 

service_selection: str

session_id instance-attribute 

session_id: str

supported_features instance-attribute 

supported_features: list[SupportedFeatures]

terminal_information instance-attribute 

terminal_information: TerminalInformation

ue_srvcc_capability instance-attribute 

ue_srvcc_capability: int

user_name instance-attribute 

user_name: str

vendor_specific_application_id instance-attribute 

vendor_specific_application_id: VendorSpecificApplicationId

visited_network_identifier instance-attribute 

visited_network_identifier: bytes