【FreeSwitch模块开发指南】创建一个自定义mod

在FS上创建一个mod,是一个简单又复杂的工作。
为什么说简单呢?基于FS良好的系统架构,只需要实现几个接口,你就可以轻轻松松实现一个mod
为什么说复杂呢?要实现功能强大的mod,你需要详细了解FS原理才可以。

今天我们就来先从简单的入手。

如上所述,要实现一个mod,实现如下几个接口即可。这几个函数都定义了宏。几个名字顾名思义。
看懂了这几个宏的定义以及实现,就很容易创建一个新的mod。下面来一个一个看一下吧。

SWITCH_MODULE_LOAD_FUNCTION(name) //定义load函数,加载时运行
SWITCH_MODULE_SHUTDOWN_FUNCTION(name) // 定义shutdown函数,关闭时运行
SWITCH_MODULE_RUNTIME_FUNCTION(name)//  定义runtime函数
SWITCH_MODULE_DEFINITION//申明函数,用来申请前面三者

先简单看一下几个主要函数定义:(定义在switch.h中)

宏SWITCH_MODULE_LOAD_FUNCTION

// switch_module_load_t为一个函数指针
#define SWITCH_MODULE_LOAD_ARGS (switch_loadable_module_interface_t **module_interface, switch_memory_pool_t *pool)
typedef switch_status_t (*switch_module_load_t) SWITCH_MODULE_LOAD_ARGS;

// 通过SWITCH_MODULE_LOAD_FUNCTION定义的name,
// 说白了就是一个函数签名为
// switch_status_t(switch_loadable_module_interface_t **module_interface, switch_memory_pool_t *pool)的函数
#define SWITCH_MODULE_LOAD_FUNCTION(name) switch_status_t name SWITCH_MODULE_LOAD_ARGS

宏SWITCH_MODULE_SHUTDOWN_FUNCTION

// switch_module_shutdown_t为一个函数指针
#define SWITCH_MODULE_SHUTDOWN_ARGS (void)
typedef switch_status_t (*switch_module_shutdown_t) SWITCH_MODULE_SHUTDOWN_ARGS;
// 通过SWITCH_MODULE_SHUTDOWN_FUNCTION定义的name,
// 是一个函数签名为 switch_status_t(void)的函数
#define SWITCH_MODULE_SHUTDOWN_FUNCTION(name) switch_status_t name SWITCH_MODULE_SHUTDOWN_ARGS

宏SWITCH_MODULE_RUNTIME_FUNCTION

#define SWITCH_MODULE_RUNTIME_ARGS (void)
typedef switch_status_t (*switch_module_runtime_t) SWITCH_MODULE_RUNTIME_ARGS;
// 通过SWITCH_MODULE_RUNTIME_FUNCTION定义的name,
// 是一个函数签名为 switch_module_runtime_t(void)的函数
#define SWITCH_MODULE_RUNTIME_FUNCTION(name) switch_status_t name SWITCH_MODULE_RUNTIME_ARGS

宏SWITCH_MODULE_DEFINITION

typedef enum {
    SMODF_NONE = 0,
    SMODF_GLOBAL_SYMBOLS = (1 << 0)
} switch_module_flag_enum_t;

// 实际上调用的是SWITCH_MODULE_DEFINITION_EX
#define SWITCH_MODULE_DEFINITION(name, load, shutdown, runtime)  \
SWITCH_MODULE_DEFINITION_EX(name, load, shutdown, runtime, SMODF_NONE)

SWITCH_MODULE_DEFINITION_EX定义如下

// 函数表,实际上还是申明上面三个函数
typedef struct switch_loadable_module_function_table {
    int switch_api_version;
    switch_module_load_t load;
    switch_module_shutdown_t shutdown;
    switch_module_runtime_t runtime;
    switch_module_flag_t flags;
} switch_loadable_module_function_table_t;

#define SWITCH_MODULE_DEFINITION_EX(name, load, shutdown, runtime, flags)                   \
static const char modname[] =  #name ;  // 定义了mod name,在其他函数中可以直接使用                                             \
SWITCH_MOD_DECLARE_DATA switch_loadable_module_function_table_t name##_module_interface = { \
    SWITCH_API_VERSION,                                                                     \
    load,                                                                                   \
    shutdown,                                                                               \
    runtime,                                                                                \
    flags                                                                                   \
}

一个简单的例子

SWITCH_MODULE_RUNTIME_FUNCTION不是必须的,这里以最简单为原则,实现一个mod。

#include <switch.h>


SWITCH_MODULE_LOAD_FUNCTION(mod_eric_load);
//SWITCH_MODULE_RUNTIME_FUNCTION(mod_eric_runtime);
SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_eric_shutdown);

extern "C"
{
// Actually it explains as followings:
// static const char modname[] = "mod_eric";
// SWITCH_MOD_DECLARE_DATA switch_loadable_module_function_table_t mod_eric_module_interface ={
//  SWITCH_API_VERSION,
//  mod_eric_load,
//  mod_eric_shutdown,
//  mod_eric_runtime(NULL),
//  SMODF_NONE
// }
SWITCH_MODULE_DEFINITION(mod_eric, mod_eric_load, mod_eric_shutdown, NULL);
}

// Actually it explains as followings:
// switch_status_t mod_eric_load(switch_loadable_module_interface_t **module_interface, switch_memory_pool_t *pool)
SWITCH_MODULE_LOAD_FUNCTION(mod_eric_load) {
    // init module interface
    *module_interface = switch_loadable_module_create_module_interface(pool, modname);

    return SWITCH_STATUS_SUCCESS;
}

SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_eric_shutdown)
{
    return SWITCH_STATUS_SUCCESS;
}

看一下加载与卸载功能


加载eric.PNG

卸载eric.PNG

好啦。尽管它什么功能也没有,但是它就是一个完整的FS模块了。完成了这个也算是万里长征的第一步了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,992评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,212评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,535评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,197评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,310评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,383评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,409评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,191评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,621评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,910评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,084评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,763评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,403评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,083评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,318评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,946评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,967评论 2 351

推荐阅读更多精彩内容