diff --git a/src/analyzer/protocol/sip/events.bif b/src/analyzer/protocol/sip/events.bif index 66ae7b5034..f8ab6f4f37 100644 --- a/src/analyzer/protocol/sip/events.bif +++ b/src/analyzer/protocol/sip/events.bif @@ -1,39 +1,43 @@ -## Generated for SIP requests, used in Voice over IP (VoIP). +## Generated for :abbr:`SIP (Session Initiation Protocol)` requests, used in Voice over IP (VoIP). ## ## This event is generated as soon as a request's initial line has been parsed. ## ## See `Wikipedia `__ -## for more information about the SIP protocol. +## for more information about the :abbr:`SIP (Session Initiation Protocol)` protocol. ## ## c: The connection. ## -## method: The SIP method extracted from the request (e.g., ``REGISTER``, ``NOTIFY``). +## method: The :abbr:`SIP (Session Initiation Protocol)` method extracted from the request (e.g., ``REGISTER``, ``NOTIFY``). ## ## original_URI: The unprocessed URI as specified in the request. ## ## version: The version number specified in the request (e.g., ``2.0``). +## +## .. bro:see:: sip_reply sip_header sip_all_headers sip_begin_entity sip_end_entity event sip_request%(c: connection, method: string, original_URI: string, version: string%); -## Generated for SIP replies, used in Voice over IP (VoIP). +## Generated for :abbr:`SIP (Session Initiation Protocol)` replies, used in Voice over IP (VoIP). ## ## This event is generated as soon as a reply's initial line has been parsed. ## ## See `Wikipedia `__ -## for more information about the SIP protocol. +## for more information about the :abbr:`SIP (Session Initiation Protocol)` protocol. ## ## c: The connection. ## -## version: The SIP version in use. +## version: The :abbr:`SIP (Session Initiation Protocol)` version in use. ## ## code: The response code. ## ## reason: Textual details for the response code. +## +## .. bro:see:: sip_request sip_header sip_all_headers sip_begin_entity sip_end_entity event sip_reply%(c: connection, version: string, code: count, reason: string%); -## Generated for each SIP header. +## Generated for each :abbr:`SIP (Session Initiation Protocol)` header. ## ## See `Wikipedia `__ -## for more information about the SIP protocol. +## for more information about the :abbr:`SIP (Session Initiation Protocol)` protocol. ## ## c: The connection. ## @@ -42,38 +46,46 @@ event sip_reply%(c: connection, version: string, code: count, reason: string%); ## name: Header name. ## ## value: Header value. +## +## .. bro:see:: sip_request sip_reply sip_all_headers sip_begin_entity sip_end_entity event sip_header%(c: connection, is_orig: bool, name: string, value: string%); -## Generated once for all SIP headers from the originator or responder. +## Generated once for all :abbr:`SIP (Session Initiation Protocol)` headers from the originator or responder. ## ## See `Wikipedia `__ -## for more information about the SIP protocol. +## for more information about the :abbr:`SIP (Session Initiation Protocol)` protocol. ## ## c: The connection. ## ## is_orig: Whether the headers came from the originator. ## ## hlist: All the headers, and their values +## +## .. bro:see:: sip_request sip_reply sip_header sip_begin_entity sip_end_entity event sip_all_headers%(c: connection, is_orig: bool, hlist: mime_header_list%); -## Generated at the beginning of a SIP message. +## Generated at the beginning of a :abbr:`SIP (Session Initiation Protocol)` message. ## ## This event is generated as soon as a message's initial line has been parsed. ## ## See `Wikipedia `__ -## for more information about the SIP protocol. +## for more information about the :abbr:`SIP (Session Initiation Protocol)` protocol. ## ## c: The connection. ## ## is_orig: Whether the message came from the originator. +## +## .. bro:see:: sip_request sip_reply sip_header sip_all_headers sip_end_entity event sip_begin_entity%(c: connection, is_orig: bool%); -## Generated at the end of a SIP message. +## Generated at the end of a :abbr:`SIP (Session Initiation Protocol)` message. ## ## See `Wikipedia `__ -## for more information about the SIP protocol. +## for more information about the :abbr:`SIP (Session Initiation Protocol)` protocol. ## ## c: The connection. ## ## is_orig: Whether the message came from the originator. +## +## .. bro:see:: sip_request sip_reply sip_header sip_all_headers sip_begin_entity event sip_end_entity%(c: connection, is_orig: bool%);