freeswitch新增模块API

概述

上一章我们讲解了freeswitch的源码基本结构，以及如何新增一个插件式模块。

freeswitch的架构非常适合这种业务开发模式，即以freeswitch的基本功能为开发平台，新增插件式模块来适配各种不同的业务场景，开发效率很高，学习成本相对较低。

freeswitch的许多模块具有API，freeswitch可以通过命令行、脚本或事件套接字从远程计算机接收API命令。

API命令可以做什么取决于每个单独的模块，常见的功能有数百个，包括返回状态信息（例如会议中有多少听众）或控制当前运行的应用程序（例如暂停正在播放的文件）。

可用的命令集取决于加载的模块，要查看可用API命令的列表，只需在cli中输入help或show api。

本节我们来介绍如何在新增模块中增加API接口，提供给外部命令行使用。

开发环境

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

freeswitch：v1.8.7

GCC：4.8.5

新增模块API

新增模块的方法请参考上一节的内容，本节内容在模块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_MODULE_LOAD_FUNCTION(mod_task_load) {     switch_api_interface_t* api_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 API SWITCH_ADD_API( api_interface, "task", "task api", task_api_function, "<cmd><args>"); //注册终端命令自动补全 switch_console_set_complete("add tasktest1 [args]"); switch_console_set_complete("add tasktest2 [args]"); return SWITCH_STATUS_SUCCESS; } SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_task_shutdown) { switch_log_printf(SWITCH_CHANNEL_LOG,SWITCH_LOG_INFO, "mod_task_shutdownstop\n"); return SWITCH_STATUS_SUCCESS; } 编译安装

进入task模块目录，编译安装，在Makefile.am文件未变化的情况下，不需要重新config。

cd $(top_srcdir)/src/mod/applications/mod_task make install 加载测试

启动freeswitch

cd /usr/local/freeswitch/bin/ ./freeswitch –nonat

freeswitch启动成功后，在freeswitch命令行中输入API命令：

freeswitch@localhost.localdomain>load mod_task 2021-08-2409:04:05.554740 [INFO] mod_task.c:94 mod_task_load start 2021-08-2409:04:05.554740 [CONSOLE] switch_loadable_module.c:1540 Successfully Loaded[mod_task] 2021-08-2409:04:05.554740 [NOTICE] switch_loadable_module.c:338 Adding API Function 'task' +OK ReloadingXML +OK freeswitch@localhost.localdomain> freeswitch@localhost.localdomain>task test1 138 task api test1,cmd:test1 138, session:0 freeswitch@localhost.localdomain>task test2 139 task api test2,cmd:test2 139, session:0 freeswitch@localhost.localdomain>task test5 140 unknown cmd,cmd:test5 140, session:0 freeswitch@localhost.localdomain>

OK，今天我们这一节的新增模块API的说明就完成了。