Mod event multicast

From FreeSWITCH Wiki

Contents 1 Introduction 2 Example Events 2.1 Heartbeat 2.2 System Ready/Status 2.3 Sofia Register 2.4 Sofia Presence 2.5 MWI Message Query 2.6 MWI Mailbox Settings 2.7 MWI Message Waiting

Introduction

'mod_event_multicast' sends FreeSWITCH events from the machine via multicast to a configurable address/port combination.
Other hosts can be configured to listen for these events and parse them, potentially also triggering events to happen on those
hosts.

You get access to all of the same events that you would get with mod_event_socket and "event plain ALL".
This can be both a blessing and a curse. Please take care to audit the events, as they'll be sent everywhere that the
router of your subnet and the adjoining routers are configured to send multicast packets. You may wish to explicitly
plan for this and use a VLAN or similar precaution to protect yourself from information leaking to places it need not go.

Example Events

Heartbeat

Task-ID: 1
Task-Desc: heartbeat
Task-Group: core
Task-Runtime: 1203449859
Event-Name: RE_SCHEDULE
Core-UUID: ec34f765-65de-dc11-93bf-0090fb0792c6
FreeSWITCH-Hostname: fs.example.com
FreeSWITCH-IPv4: 10.50.0.50
FreeSWITCH-IPv6: 127.0.0.1
Event-Date-Local: 2008-02-19%2014%3A37%3A19
Event-Date-GMT: Tue,%2019%20Feb%202008%2019%3A37%3A19%20GMT
Event-Date-timestamp: 1203449839239110
Event-Calling-File: switch_scheduler.c
Event-Calling-Function: switch_scheduler_execute
Event-Calling-Line-Number: 70
Multicast-Sender: fs.example.com

System Ready/Status

Event-Info: System%20Ready
Up-Time: 0%20years,%200%20days,%2022%20hours,%2030%20minutes,%2038%20seconds,%20667%20milliseconds,%2022%20microseconds
Session-Count: 0
Session-Per-Sec: 15
Event-Name: HEARTBEAT
Core-UUID: ec34f765-65de-dc11-93bf-0090fb0792c6
FreeSWITCH-Hostname: fs.example.com
FreeSWITCH-IPv4: 10.50.0.50
FreeSWITCH-IPv6: 127.0.0.1
Event-Date-Local: 2008-02-19%2014%3A37%3A19
Event-Date-GMT: Tue,%2019%20Feb%202008%2019%3A37%3A19%20GMT
Event-Date-timestamp: 1203449839239110
Event-Calling-File: switch_core.c
Event-Calling-Function: send_heartbeat
Event-Calling-Line-Number: 74
Multicast-Sender: fs.example.com

Sofia Register

Event-Subclass: sofia%3A%3Aregister
profile-name: default
from-user: 1000
from-host: fs.example.com
contact: %22user%22%20%3Csip%3A1000%4010.50.0.125%3A5060%3E
call-id: 7ab517a5-a115b4d3-33625510%4010.50.0.125
rpid: unknown
expires: 3600
Event-Name: CUSTOM
Core-UUID: ec34f765-65de-dc11-93bf-0090fb0792c6
FreeSWITCH-Hostname: fs.example.com
FreeSWITCH-IPv4: 10.50.0.50
FreeSWITCH-IPv6: 127.0.0.1
Event-Date-Local: 2008-02-19%2014%3A37%3A19
Event-Date-GMT: Tue,%2019%20Feb%202008%2019%3A37%3A19%20GMT
Event-Date-timestamp: 1203449839185855
Event-Calling-File: sofia_reg.c
Event-Calling-Function: sofia_reg_handle_register
Event-Calling-Line-Number: 547
Event-Subclass: sofia%3A%3Aregister
Event-Subclass-Owner: src/switch_event.c
Multicast-Sender: fs.example.com

Sofia Presence

proto: sip
login: sip%3Amod_sofia%4010.50.0.50%3A5060
rpid: unknown
from: 1000%40fs.example.com
status: Registered
event_type: presence
Event-Name: PRESENCE_IN
Core-UUID: ec34f765-65de-dc11-93bf-0090fb0792c6
FreeSWITCH-Hostname: fs.example.com
FreeSWITCH-IPv4: 10.50.0.50
FreeSWITCH-IPv6: 127.0.0.1
Event-Date-Local: 2008-02-19%2014%3A37%3A19
Event-Date-GMT: Tue,%2019%20Feb%202008%2019%3A37%3A19%20GMT
Event-Date-timestamp: 1203449839185855
Event-Calling-File: sofia_reg.c
Event-Calling-Function: sofia_reg_handle_register
Event-Calling-Line-Number: 564
Multicast-Sender: fs.example.com

MWI Message Query

Message-Account: sip%3A1000%40fs.example.com
Event-Name: MESSAGE_QUERY
Core-UUID: ec34f765-65de-dc11-93bf-0090fb0792c6
FreeSWITCH-Hostname: fs.example.com
FreeSWITCH-IPv4: 10.50.0.50
FreeSWITCH-IPv6: 127.0.0.1
Event-Date-Local: 2008-02-19%2014%3A37%3A19
Event-Date-GMT: Tue,%2019%20Feb%202008%2019%3A37%3A19%20GMT
Event-Date-timestamp: 1203449839185855
Event-Calling-File: sofia_reg.c
Event-Calling-Function: sofia_reg_handle_register
Event-Calling-Line-Number: 635
Multicast-Sender: fs.example.com

MWI Mailbox Settings

sip_mailbox: 1000
sip_auth_username: 1000
sip_auth_realm: fs.example.com
mailbox: 1000
user_name: 1000
domain_name: fs.example.com
record_stereo: true
accountcode: 1000
user_context: default
effective_caller_id_name: Joe%20Schmoe
effective_caller_id_number: 8005551212
Event-Name: MESSAGE
Core-UUID: ec34f765-65de-dc11-93bf-0090fb0792c6
FreeSWITCH-Hostname: fs.example.com
FreeSWITCH-IPv4: 10.50.0.50
FreeSWITCH-IPv6: 127.0.0.1
Event-Date-Local: 2008-02-19%2014%3A37%3A19
Event-Date-GMT: Tue,%2019%20Feb%202008%2019%3A37%3A19%20GMT
Event-Date-timestamp: 1203449839185855
Event-Calling-File: sofia_reg.c
Event-Calling-Function: sofia_reg_handle_sip_i_register
Event-Calling-Line-Number: 668
Multicast-Sender: fs.example.com

MWI Message Waiting

MWI-Messages-Waiting: no
MWI-Message-Account: sip%3A1000%40fs.example.com
Event-Name: MESSAGE_WAITING
Core-UUID: ec34f765-65de-dc11-93bf-0090fb0792c6
FreeSWITCH-Hostname: fs.example.com
FreeSWITCH-IPv4: 10.50.0.50
FreeSWITCH-IPv6: 127.0.0.1
Event-Date-Local: 2008-02-19%2014%3A37%3A19
Event-Date-GMT: Tue,%2019%20Feb%202008%2019%3A37%3A19%20GMT
Event-Date-timestamp: 1203449839231026
Event-Calling-File: mod_voicemail.c
Event-Calling-Function: message_query_handler
Event-Calling-Line-Number: 2169
Multicast-Sender: fs.example.com