freeswitch的event事件處理

求真得真發表於2021-09-07
事件

概述

之前的文章中，我們講解了freeswitch的原始碼基本結構，如何新增一個外掛式模組，以及如何在模組中新增一個命令式API介面和APP介面。

freeswitch本身是事件驅動的，它可以併發響應多個事件，也可以廣播事件。

freeswitch的事件可以由核心產生，也可以由外部模組或外部源產生。

freeswitch系統中的幾乎所有事件都會產生事件訊息，這些事件可以被外部實體監聽（通過event socket），也可以被內部模組監聽。

freeswitch的事件系統是雙向的，除了允許外部程式監聽事件外，外部程式還可以向freeswitch傳送事件。

你可以從自己的程式中實時傳送/接收事件。這種組合允許你以幾乎任何你能想到的方式使用freeswitch。

 

通道事件

在freeswitch的事件系統中，有一類以“CHANNEL_“開頭的事件，這些事件表示了一個呼叫通道（channel）的狀態變化的全部過程，是我們在業務開發中最常用的一類事件。

常見的通道事件：

 

CHANNEL_ANSWER

CHANNEL_APPLICATION

CHANNEL_BRIDGE

CHANNEL_CALLSTATE

CHANNEL_CREATE

CHANNEL_DATA

CHANNEL_DESTROY

CHANNEL_EXECUTE

CHANNEL_EXECUTE_COMPLETE

CHANNEL_GLOBAL

CHANNEL_HANGUP

CHANNEL_HANGUP_COMPLETE

CHANNEL_HOLD

CHANNEL_ORIGINATE

CHANNEL_OUTGOING

CHANNEL_PARK

CHANNEL_PROGRESS

CHANNEL_PROGRESS_MEDIA

CHANNEL_STATE

CHANNEL_UNBRIDGE

CHANNEL_UNHOLD

CHANNEL_UNPARK

CHANNEL_UUID

通道事件可以攜帶一通呼叫的全部呼叫資訊，也可以攜帶呼叫流程中的自定義資訊，這個屬性讓我們可以很方便的在一通呼叫的不同階段之間傳遞自定義引數。

本節我們來介紹如何在模組中增加一個channel event事件處理，並傳遞一個自定義引數。

 

開發環境

centos：CentOS release 7.0 (Final)或以上版本

freeswitch：v1.8.7

GCC：4.8.5

 

程式碼處理

新增模組的方法請參考之前的內容，本節內容在模組mod_task的基礎上修改。

mod_task.c內容如下：

#include <switch.h>

 

SWITCH_MODULE_LOAD_FUNCTION(mod_task_load);

SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_task_shutdown);

SWITCH_MODULE_DEFINITION(mod_task, mod_task_load, mod_task_shutdown, NULL);

 

SWITCH_STANDARD_API(task_api_function)

{

    //SWITCH_STANDARD_API have three args: (cmd, session, stream)

    char *mycmd = NULL;

    int argc = 0;

    char *argv[16];

    bzero(argv, sizeof(argv));

 

    //split cmd and parse

    if (cmd)

    {

        mycmd = strdup(cmd);

        if (!mycmd)

        {

            stream->write_function(stream, "Out of memory\n");

            return SWITCH_STATUS_FALSE;   

        }

       

        if (!(argc = switch_split(mycmd, ' ', argv)) || !argv[0])

        {

            argc = 0;

            switch_safe_free(mycmd);

            return SWITCH_STATUS_FALSE;

        }

    }

 

    //parse cmd, brach process

    if(0 == strcmp("test1", argv[0]))

    {

        stream->write_function(stream, "task api test1, cmd:%s, session:%p", cmd, session);

    }

    else if(0 == strcmp("test2", argv[0]))

    {

        stream->write_function(stream, "task api test2, cmd:%s, session:%p", cmd, session);

    }

    else

    {

        stream->write_function(stream, "unknown cmd, cmd:%s, session:%p", cmd, session);

    }   

 

    switch_safe_free(mycmd);

       return SWITCH_STATUS_SUCCESS;

}

 

SWITCH_STANDARD_APP(task_app_function)

{

    switch_channel_t *pchannel = NULL;

 

    //task_app(session, data);

    switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO,

            "task_app_function start, session=%p, data=%s\n", (void*)session, data);

 

    //export variable task_str for hangup event

    pchannel = switch_core_session_get_channel(session);

    if(NULL != pchannel)

    {

        switch_channel_export_variable(pchannel, "task_str", "task_app export variable", SWITCH_EXPORT_VARS_VARIABLE);

    }

}

 

void task_event_channel_hangup_complete(switch_event_t *event)

{

    const char *uuid = switch_event_get_header(event, "Unique-ID");

    const char *call_dir = switch_event_get_header(event, "Call-Direction");

    const char* task_str = switch_event_get_header(event, "variable_task_str");

 

    switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO,

        "task_event_channel_hangup_complete, uuid=%s, call_dir=%s, task_str=%s\n",

        uuid, call_dir, task_str);

}

 

void task_event_handler(switch_event_t *event)

{

    switch (event->event_id)

    {

        case SWITCH_EVENT_CHANNEL_HANGUP_COMPLETE:

            task_event_channel_hangup_complete(event);

            break;

 

        case SWITCH_EVENT_CHANNEL_ANSWER:

        default:

            switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR,

                "unsupported event. event:%d\n", event->event_id);

            break;

    }

 

    return;

}

 

SWITCH_MODULE_LOAD_FUNCTION(mod_task_load)

{

       switch_api_interface_t* api_interface = NULL;

    switch_application_interface_t* app_interface = NULL;

    *module_interface = switch_loadable_module_create_module_interface(pool, modname);

 

       switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO,

            "mod_task_load start\n");

 

    // register APP

    SWITCH_ADD_APP(app_interface,

           "task_app",

           "task_app",

           "task_app",

           task_app_function,

           "NULL",

           SAF_SUPPORT_NOMEDIA | SAF_ROUTING_EXEC);

 

    // register API

    SWITCH_ADD_API( api_interface,

                    "task",

                    "task api",

                    task_api_function,

                    "<cmd> <args>");

   

    // 註冊終端命令自動補全

    switch_console_set_complete("add task test1 [args]");

    switch_console_set_complete("add task test2 [args]");

 

    ///////////////EVENT INIT////////////////////

    if (SWITCH_STATUS_SUCCESS != switch_event_bind(modname, SWITCH_EVENT_CHANNEL_HANGUP_COMPLETE, SWITCH_EVENT_SUBCLASS_ANY, task_event_handler, NULL)){

        switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "can't bind event\n");

        return SWITCH_STATUS_GENERR;

    }

 

    return SWITCH_STATUS_SUCCESS;

}

 

SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_task_shutdown)

{

       switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO,

            "mod_task_shutdown stop\n");

       return SWITCH_STATUS_SUCCESS;

}

 

在呼叫處理過程中，我們在“task_app_function“函式中通過”switch_channel_export_variable“介面設定了一個自定義通道變數”task_str“的值為”task_app export variable“。

然後在呼叫的掛機事件中，我們又取出了訊息頭域中“variable_task_str“的值並列印到日誌中。

通過這種方式，我們可以在呼叫流程的不同階段傳遞任意自定義引數。

 

編譯安裝

進入task模組目錄，編譯安裝，在Makefile.am檔案未變化的情況下，不需要重新config。

cd  $(top_srcdir)/src/mod/applications/mod_task

make  install

 

配置啟動

修改dialplan撥號計劃

cd /usr/local/freeswitch/conf/dialplan

vi public.xml

…

<include>

  <context name="public">

    <extension name="test">

      <condition>

        <action application="task_app" data="${destination_number}"/>

      </condition>

    </extension>

…

 

啟動fs

cd /usr/local/freeswitch/bin/

./freeswitch –nonat

 

載入測試

freeswitch啟動成功後，在freeswitch命令列中輸入API命令載入mod_task模組：

freeswitch@localhost.localdomain> load mod_task

2021-09-03 11:34:50.954223 [INFO] mod_enum.c:882 ENUM Reloaded

2021-09-03 11:34:50.954223 [INFO] mod_task.c:134 mod_task_load start

2021-09-03 11:34:50.954223 [CONSOLE] switch_loadable_module.c:1540 Successfully Loaded [mod_task]

2021-09-03 11:34:50.954223 [NOTICE] switch_loadable_module.c:292 Adding Application 'task_app'

 

+OK Reloading XML

+OK

 

2021-09-03 11:34:50.954223 [NOTICE] switch_loadable_module.c:338 Adding API Function 'task'

 

通過其他sip伺服器發起invite呼叫到本機的5080埠，在日誌中可以檢視到：

freeswitch@localhost.localdomain> 2021-09-03 11:34:56.614251 [NOTICE] switch_channel.c:1114 New Channel sofia/external/10011@192.168.0.110 [a34a67c3-2b8d-401f-a16f-1f5ec3e5169f]

2021-09-03 11:34:56.614251 [INFO] mod_dialplan_xml.c:637 Processing 10011 <10011>->10012 in context public

2021-09-03 11:34:56.614251 [INFO] mod_task.c:88 task_app_function start, session=0x7fbb8402fab8, data=10012

2021-09-03 11:34:56.614251 [NOTICE] switch_core_state_machine.c:385 sofia/external/10011@192.168.0.110 has executed the last dialplan instruction, hanging up.

2021-09-03 11:34:56.614251 [NOTICE] switch_core_state_machine.c:387 Hangup sofia/external/10011@192.168.0.110 [CS_EXECUTE] [NORMAL_CLEARING]

2021-09-03 11:34:56.614251 [INFO] mod_task.c:105 task_event_channel_hangup_complete, uuid=a34a67c3-2b8d-401f-a16f-1f5ec3e5169f, call_dir=inbound, task_str=task_app export variable

2021-09-03 11:34:56.614251 [NOTICE] switch_core_session.c:1744 Session 1 (sofia/external/10011@192.168.0.110) Ended

2021-09-03 11:34:56.614251 [NOTICE] switch_core_session.c:1748 Close Channel sofia/external/10011@192.168.0.110 [CS_DESTROY]

在日誌中，可以看到“task_app_function start “的資訊，同時也可以看到” task_event_channel_hangup_complete “的函式列印中”task_str=task_app export variable “的列印資訊，驗證了在呼叫中設定的自定義引數傳遞到掛機事件的後處理的過程。

 

總結

freeswitch的event事件是整個架構體系中非常重要的一環，基礎核心層通過event事件將所有呼叫相關的資訊非同步的通知到應用層，極大的方便了呼叫流程的業務開發。

其中的非同步設計思想值得我們多多參考學習。

空空如常

求真得真

 

相關文章