oSIP协议栈(及eXoSIP、Ortp等)使用入门

http://ghj19850926.blog.163.com/blog/static/18591560201241410033429/

　一直没空仔细研究下oSIP，最近看到其版本已经到了3.x版本，看到网上的许多帮助说明手册都过于陈旧，且很多文档内容有点误人子弟的嫌疑～～ 
　　Ｌｉｎｕｘ下ｏＳＩＰ的编译使用应该是很简单的，其Ｉｎｓｔａｌｌ说明文档里也介绍的比较清楚，本文主要就ｏＳＩＰ在Ｗｉｎｄｏｗｓ平台下ＶＣ６．０开发环境下的使用作出描述。 
　　虽然ｏＳＩＰ的开发人员也说明了，ｏＳＩＰ只使用了标准Ｃ开发库，但许多人在Ｗｉｎｄｏｗｓ下使用ｏＳＩＰ时，第一步就被卡住了，得不到ｏＳＩＰ的ＬＩＢ库和ＤＬＬ库，也就没有办法将ｏＳＩＰ使用到自己的程序中去，所以第一步，我们将学习如何得到ｏＳＩＰ的静态和动态链接库，以便我们自己的程序能够使用它们来成功编译和执行我们的程序。

第一阶段： 
－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 
　　先创建新工程，网上许多文档都介绍创建一个Ｗｉｎ３２动态链接库工程，我们这里也一样，创建一个空白的工程保存。 
　　同样，将ｏＳＩＰ２版本３．０．１ src目录下的Ｏｓｉｐｐａｒｓｅｒ２目录下的所有文件都拷到我们刚创建的工程的根目录下，在ＶＣ６上操作： 
Ｐｒｏｊｅｃｔ－Ａｄｄ　Ｔｏ　Ｐｒｏｊｅｃｔ－Ｆｉｌｅｓ 
　　将所有的源程序和头文件都加入到工程内，保存工程。 
　　这时，我们可以尝试编译一下工程，你会得到许多错误提示信息，其内容无非是找不到osipparser2/xxxxx.h头文件之类。 
　　处理：在Ｌｉｎｕｘ下，我们一般是将头文件，ｌｉｂ库都拷到/usr/inclue;/usr/lib之类的目录下，ｃ源程序里直接写#include <xxx.h>时，能直接去找到它们，在ＶＣ里，同样的，最简单的方法就是将ｏＳＩＰ２源码包中的Ｉｎｃｌｕｄｅ目录下的osipparser2目录直接拷到我们的Ｗｉｎｄｏｗｓ下默认包含目录即可，这个目录在ＶＣ６的Ｔｏｏｌ－Ｏｐｔｉｏｎｓ－Ｄｉｒｅｃｔｏｒｉｅｓ里设置，（当然，如果你知道这一步，也可以不用拷贝文件，直接在这里把ｏＳＩＰ源码包所在目录加进来就可以了），默认如果装在Ｃ盘，目录则为C:/Program Files/Microsoft Visual Studio/VC98/Include。 
　　这时，我们再次编译我们的工程，顺利编译，生成osipparser2.dll，这时，网上很多文档里可能直接就说，这一步也会生成libs目录，里面里osipparser2.lib文件，但我们这里没有生成：） 
　　最简单的方法，不用深究，直接再创建一个工程，同上述创建动态链接库方法，创建一个Ｗｉｎ３２静态链接库工程，直接编译，即可得到osipparser2.lib。 
－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 
　　上面，我们得到了Ｏｓｉｐ的解析器开发库，下面再编译完整的Ｏｓｉｐ协议栈开发库，同样照上述方法，分别创建动态链接库工程和静态链接库工程，只是要拷的文件换成src下的osip目录下文件和include下的osip目录，得到osip2.dll和osip2.lib。 
　　在编译osip2.dll这一步可能会再次得到错误，内容含义是找不到链接库，所以，我们要把前面编译得到的osipparser2.lib也拷到osip工程目录下，并在ＶＣ６中操作： 
　　Ｐｒｏｊｅｃｔ－Ｓｅｔｔｉｎｇ－Ｌｉｎｋ中的Ｏｂｊｅｃｔ／Ｌｉｂｒａｒｙ　Ｍｏｄｕｌｅｓ： 
kernel32.lib user32.lib ... xxx.lib之类的内容最后增加: osipparser2.lib 
　　保存工程后再次编译，即可成功编译osip2.dll。 
－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 
　　至此，我们得到了完整的ｏＳＩＰ开发库，使用时，只需在我们的程序里包含ｏＳＩＰ的头文件，工程的链接参数里增加osipparser2.lib和osip2.lib即可。 
－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 
　　下面我们验证一下我们得到的开发库，并大概了解一下ＯＳＩＰ的语法规范。 
　　在VC里创建win32控制台程序工程，将libosip源码包的SRC目录下的Test目录内的C源程序随便拷一个到工程时，直接编译（工程设置里照前文方法在link选项里增加osip2.lib,osipparser2.lib引用我们之前成功编译得到的静态库文件）就可以运行（带参数运行，参数一般为一个文本文件，同样从Test目录的res目录里拷一个与源文件同名的纯文本文件到工程目录下即可）。 
　　该目录下的若干文件基本上是测试了Osip的一些基本功能函数，例如URI解析之类，可以大概了解一下oSIP的语法规范和调用方法，同时也能校验一下之前编译的OSIP开发库能否正常使用，成功完成本项工作后，可以进入下一步具体的oSIP的使用学习了。 
－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 
　　由于ｏＳＩＰ是比较底层的ＳＩＰ协议栈实现，新手较难上手，而官方的示例大都是一些伪代码，需要有实际的例子程序参考学习，而最好的例子就是同样官方发布的ｏＳＩＰ的扩展开发库exosip２，使用ｅｘｏＳＩＰ可以很方便地快速创建一个完整的ＳＩＰ程序（只针对性地适用于SIP终端开发用，所以我们这里只是用它快速开发一个SIP终端，用来更方便地学习oSIP，要想真正掌握SIP的开发，需要掌握oSIP并熟读RFC文档才行，exoSIP不是我们的最终学习目的），通过成功编译运行一个自己动手开发出的程序，再由浅入深应该是初学都最好的学习方法通过对使用exosip开发库的使用创建自己的ＳＩＰ程序，熟悉后再一个函数一个函数地深入学习exosip提供的接口函数，就可以深入理解osip 了，达到间接学习ｏＳＩＰ的目的，同时也能从eXoSIP中学习到正确使用ｏＳＩＰ的良好的编程风格和语法格式。 
　　而要成功编译ＥｘｏＳＩＰ，似乎许多人被难住了，直接在ＸＰ－ｓｐ２上，用ＶＣ６，虽然你使用了ｅＸｏＳＩＰ推荐的winsock2.h，但是会得到一个sockaddr_storage结构不能识别的错误，因为vc6自带的开发库太古董了，需要升级系统的Ｐｌａｔｆｏｒｍ　ＳＤＫ，下载地址如下： 
http://www.microsoft.com/msdownl ... PSP2FULLInstall.htm（ＶＣ６的支持已经停止，这是ＶＣ６能使用的最新ＳＤＫ） 
　　成功安装后编译前需加OSIP_MT宏，以启用线程库，否则在程序中使用eXoSIP库时会出错，而编译时也会得到许多函数未定义的Warning提示，编译得到exosip2.lib供我们使用，当然，在此之前需要成功编译了osip2和osipparser2，而在之后的实际使用时，发现ｏＳＩＰ也需要增加ＯＳＩＰ＿ＭＴ宏，否则ＯＳＩＰ＿ＭＴ调用ｏＳＩＰ的线程库时会出错，所以我们需要重新编译ｏＳＩＰ了：），因为ｅＸｏｓｉｐ是基于ｏＳＩＰ的（同上方式创建静态和动态链接库工程，并需在Ｌｉｎｋ中手工添加ｏＳＩＰ和ｏＳＩＰｐａｒｓｅｒ的lib库）。 
－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 
　　创建新工程，可以是任意工程，我们从最简单的Ｗｉｎ３２控制台程序开始，为了成功使用ｏＳＩＰ，我们需要引用相关库，调用相关头文件，经过多次试验，发现需要引用如下的库： 
exosip2.lib osip2.lib osipparser2.lib WSock32.Lib IPHlpApi.Lib WS2_32.Lib Dnsapi.lib 
　　其中，除了我们上面编译得到的三个oSIP库外，其它库都是系统库，其中有一些是新安装的Ｐｌａｔｆｏｒｍ　ＳＤＫ所新提供的。 
　　至此，我们有了一个简单的开发环境了，可以充分利用网上大量的以ｏＳＩＰ为基础的代码片段和官方说明文档开始具体函数功能的测试和使用了：） 
－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 
　　我们先进行一个简单的纯ＳＩＰ信令（不带语音连接建立）的ＵＡＣ的ＳＩＰ终端的程序开发的试验（即一个只能作为主叫不能作为被叫的的ＳＩＰ软电话模型），我们创建一个ＭＦＣ应用程序，对话框模式，照上面的说明，设置工程包含我们上面得到的ｏＳＩＰ的相关开发库及ＳＤＫ的一些开发库，并且由于默认ＬＩＢＣ的冲突，需要排除MSVCRT[D]开发库（其中Ｄ代表Ｄｅｂｕｇ模式下，没有Ｄ表示Ｒｅｌｅａｓｅ模式下），直接使用ｅＸｏｓｉｐ的几个主要函数就可以创建一个基本的ＳＩＰ软电话模型。

　　其主要流程为： 
　　初始化ｅＸｏｓｉｐ库－启动事件监听线程－向ＳＩＰ　Ｐｒｏｘｙ注册－向某ＳＩＰ终端（电话号码）发起呼叫－建立连接－结束连接

　　初始化代码： 
int ret = 0; 
ret = eXosip_init (); 
eXosip_set_user_agent("##YouToo0.1"); 
if(0 != ret) 
{ 
AfxMessageBox("Couldn't initialize eXosip!/n"); 
return false; 
} 
ret = eXosip_listen_addr (IPPROTO_UDP, NULL, 0, AF_INET, 0); 
if(0 != ret) 
{ 
eXosip_quit (); 
AfxMessageBox("Couldn't initialize transport layer!/n"); 
return false; 
}

　　启动事件监听线程： 
AfxBeginThread(sip_uac,(void *)this);

　　向ＳＩＰ　Ｐｒｏｘｙ注册： 
eXosip_clear_authentication_info(); 
eXosip_add_authentication_info(uname, uname, upwd, "md5", NULL); 
real_send_register(30);　　/* 自定义函数代码请见源码 */

　　发起呼叫（构建假的ＳＤＰ描述，实际软电话使用它构建ＲＴＰ媒体连接）： 
osip_message_t *invite = NULL; /* 呼叫发起消息体 */ 
int i = eXosip_call_build_initial_invite (&invite, dest_call, source_call, NULL, "## YouToo test demo!"); 
if (i != 0) 
{ 
AfxMessageBox("Intial INVITE failed!/n"); 
} 
char localip[128]; 
eXosip_guess_localip (AF_INET, localip, 128); 
snprintf (tmp, 4096, 
"v=0/r/n" 
"o=josua 0 0 IN IP4 %s/r/n" 
"s=conversation/r/n" 
"c=IN IP4 %s/r/n" 
"t=0 0/r/n" 
"m=audio %s RTP/AVP 0 8 101/r/n" 
"a=rtpmap:0 PCMU/8000/r/n" 
"a=rtpmap:8 PCMA/8000/r/n" 
"a=rtpmap:101 telephone-event/8000/r/n" 
"a=fmtp:101 0-11/r/n", localip, localip, "9900"); 
osip_message_set_body (invite, tmp, strlen(tmp)); 
osip_message_set_content_type (invite, "application/sdp"); 
eXosip_lock (); 
i = eXosip_call_send_initial_invite (invite); 
eXosip_unlock ();

　　挂断或取消通话： 
int ret; 
ret = eXosip_call_terminate(call_id, dialog_id); 
if(0 != ret) 
{ 
AfxMessageBox("hangup/terminate Failed!"); 
}

　　可以看到非常简单，再借助于ｏＲＴＰ和Ｍｅｄｉａｓｔｒｅａｍｅｒ开发库，来快速为我们的ＳＩＰ软电话增加ＲＴＰ和与系统语音ＡＰＩ接口交互及语音编码功能，即可以快速开发出一个可用的ＳＩＰ软电话，关于ｏＲＴＰ和Ｍｅｄｉａｓｔｒｅａｍｅｒ的相关介绍不是本文重点，将在有空的时候考虑增加相应使用教程，文章前提到的地方可以下载基本可用的完整ＳＩＰ软电话的ＶＣ源码工程文件供参考使用，完全ＣｏｐｙＬｅｆｔ，欢迎转载，但请在转载时注明作者信息，谢谢！

第二阶段： 
－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 
　　得到了一个ＳＩＰ软电话模型后，我们可以根据软电话的实际运行表现（结合用Ethereal抓包分析）来进行代码的分析，以达到利用eXoSIP来辅助我们学习ｏＳＩＰ的最终目的（如要快速开发一个可用的ＳＩＰ软电话，请至前面提到的论坛去下载使用ｏＲＴＰ和Ｍｅｄｉａｓｔｒｅａｍｅｒ快速搭建的一个基本完整可用的ＳＩＰ软电话##YouToo 0.1版本的ＶＣ源码工程文件作参考）。

　　现在从eXosip的初始化函数开始入手，来分析oSIP的使用，这是第二阶段，第三阶段就是深入学习oSIP的源码了，但大多数情况下应该没有必要了，因为在第二阶段就有部分涉及到第三阶段的工作了，而且ｏＳＩＰ的源码也就大多是一些ＳＩＰ数据的语法解析和状态机的实现，能深入理解了ＳＩＰ协议后，这些只是一种实现方式，没必要完全去接受，而是可以用自己的方式和风格来实现一套，比如，更轻量化更有适用目的性的方式，ｏＳＩＰ则只起参考作用了。

　　eXosip_init()是ｅＸｏｓｉｐ的初始化函数，我们来看看它的内部实现: 
　　首行是定义的　osip_t *osip，这在oSIP的官方手册里我们看到，所有使用oSIP的程序都要在最开始处声明一个osip_t的指针，并使用osip_init(&osip)来初始化这个指针，销毁这个资源使用osip_release(osip)即可。 
　　我们可以在代码中看到很多OSIP_TRACE，这是调试输出宏调用了函数osip_trace，可以用ENABLE_TRACE宏来打开调试以方便我们开发调试。 
　　其它就是很多的eXosip_t的全局变量eXosip的一些初始化操作，包括最上面的memset (&eXosip, 0, sizeof (eXosip))完全清空和下面的类似eXosip.user_agent = osip_strdup ("eXosip/" EXOSIP_VERSION)的exosip变量的一些初始值设置，其中有一个eXosip.j_stop_ua = 0应该是一个状态机开关，后面可以看到很多代码检测这个变量来决定是否继续流程处理，默认置成了0表示现在exosip的处理流程是就绪的，即ua是not stop的。 
　　 
　　osip_set_application_context (osip, &eXosip)是比较有意思的，它让下面的eXosip_set_callbacks (osip)给osip设置大量的回调函数时，能让osip能访问到eXosip这个全局变量中设置的大量程序运行时交互的信息，相当于我们在ＶＣ下开启一个线程时，给线程传入的一个ｖｏｉｄ指针指向我们的ＭＦＣ应用程序的当前dialog对象实例，可以用void *osip_get_application_context (osip_t * osip)这个函数来取出指针来使用，不过好象exosip中并没有用到它，可能是留给个人自已扩展的吧:) 
　　 
　　还能看到初始化代码前面有一段ＷＩＮ３２平台下的ＳＯＣＫ的初始化代码，可以知道eXosip是用的原生的winsock api函数，也就是我们可能以前学过的用VC和WINAPI写sock程序时(不是ＭＦＣ)，用到的那段ＳＯＣＫ初始代码，还有一段有意思的代码，就是jpipe()函数，它们返回的是一个管道，一个有２个整型数值的数组（一个进一个出），查看其代码发现，非WIN32平台是直接使用的pipe系统函数，而ＷＩＮ３２下则是用一对ＴＣＰ的本地ＳＯＣＫ连接来模拟的管道，一个ＳＯＣＫ写一个ＳＯＣＫ读，这段代码是比较有参考价值的：） 
j = 50; 
while (aport++ && j-- > 0) 
{ 
　　raddr.sin_port = htons ((short) aport); 
　　if (bind (s, (struct sockaddr *) &raddr, sizeof (raddr)) < 0) 
　　{ 
　　　　OSIP_TRACE (osip_trace (__FILE__, __LINE__, OSIP_WARNING, NULL, 
　　　　"Failed to bind one local socket %i!/n", aport)); 
　　} else 
　　break; 
} 
含义即，依次检测５０个端口，从static int aport = 10500;即10500~10550端口找出一个可用的本地端口来绑定listen模拟pipe的一对sock。 
　　eXosip_set_callbacks (osip)没有什么好看的，无非是和ｏＳＩＰ官方文档介绍的一样，设置一大堆的回调函数，关键是回调函数的实现，这也是许多初学者使用ｏＳＩＰ被卡壳的主要原因，不知道ｏＳＩＰ构建的程序是怎样跑起来的，随便选几个回调函数看一下eXosip是怎样实现的，有许多是形如下文的函数： 
static void 
cb_sndbye (int type, osip_transaction_t * tr, osip_message_t * sip) 
{ 
　　OSIP_TRACE (osip_trace 
　　(__FILE__, __LINE__, OSIP_INFO3, NULL, "cb_sndbye (id=%i)/r/n", 
　　tr->transactionid)); 
} 
　　即，只是打印一下调试，并没有完整实现什么功能，我们学习时，完全可以用相同的方法，定义一大堆回调函数，并不忙想怎么完全实现，先都是只打印一下调试信息，看具体的应用逻辑根据抓包测试分析和看调试看程序走到了哪一步，调用了哪一个回调，来明白具体回调函数要实现什么用途，再来实现代码就方便多了，当然，如果看透了ＲＦＣ文档，应该从字面就能知道各个回调函数的用途了，这是后话，不是谁都能快速完全看懂ＲＦＣ的，所以我们要参考eXosip：） 
　　 
　　我们对其中的重要的回调函数进行逐个的分析： 
　　－－－－－－－－－－－－－－－－－－－－－－－－－－－ 
　　osip_set_cb_send_message (osip, &cb_snd_message)　ＳＩＰ消息发送回调函数 
　　这个函数可能是最重要的回调函数之一，消息发送，包括请求消息和回应消息，一般情况下，状态机的状态就是由它控制的，发起一个消息初始化一个状态机，回应一个消息对状态机修改，终结消息发送结束状态机…… 
　　看cb_snd_message的函数实现，要以发现，其主要代码是对参数中的要发送的消息osip_message_t * sip进行分析，找出消息要发送的真实char *host,int port的值（这些参数可以省略，但要发送消息肯定需要host和port，所以要从sip中解析），最后根据sip中解析出的传输方式是TCP还是UDP选择最终进行消息发送处理的函数cb_udp_snd_message，cb_tcp_snd_message处理（它们的参数一致，即本函数只是补全一些省略的参数并对消息进行合法性检查）。 
　　**毕竟eXosip是一个通用的开发库，它考虑了要支持TCP,UDP,TCPs,IPV4,IPV6，WIN32,*nix,WINCE等等多样化的复杂环境，所以，我们可以略过我们暂时不需要的部分，比如，ＩＰＶ６相关的代码实现等。 
　　 
　　由于我们大多数情况下ＳＩＰ是用的ＵＤＰ，所以先来看一下cb_udp_snd_message的实现，它从全局变量exosip中获取可用的sock，并尽最大能力解析出host和port（？？难道前面的函数还不够解析彻底？？如最终仍无port信息则默认设置为5060），使用osip_message_to_str (sip, &message, &length)函数将要发送的格式化的ＳＩＰ消息转换成能用ＳＯＣＫ传输的简单数据并发送即完成消息发送，代码中有许多复杂的环境探测和错误控制等等等等，我们可以暂时不用过多关注，可以继续向下，结尾处有一个keeplive相关代码，从代码字面分析，可能是ＳＩＰ的Register消息的自动重发相关代码，可以在后面再细化分析。 
　　cb_tcp_snd_essage的函数实现要比上文的udp的实现简单很多，主要是环境探测错误控制方面，因为毕竟tcp是稳定连接的，对比一下代码，可以看到主要流程还是将ＳＩＰ消息转换后，发送到从ＳＩＰ消息中解析出的host和port对应的目标。 
　　 
　　看完两个函数，可以知道，eXosip需要有两个sock，是一个数组，0是给ＵＤＰ用的，１是给ＴＣＰ用的，要用ＳＯＣＫ当然要初始化，就是下文要介绍的eXosip的网络相关的初始化了，上面的exosip_init可以看成是这个开发库的系统初始化吧：）　 
　　至些，我们应该知道了ｏＳＩＰ开发的ＳＩＰ应用程序的消息是从哪里发出的吧，对了，就是从这个回调函数里，所谓万事开头难，就象开发ＷＩＮ３２应用程序时，找到了ＷＩＮ３２程序的main函数入口下面的工作就好办了，下面就都是为一些事件消息开发对应的处理函数而已了：）

　　osip_set_kill_transaction_callback　事务终结回调函数 
　　对应ＩＣＴ，ＩＳＴ，ＮＩＣＴ，ＮＩＳＴ客户/服务器注册/非注册事务状态机的终结，主要是使用osip_remove_transaction (eXosip.j_osip, tr)将当前tr事务删除，再加上一系列的清理工作，其中，NICT即客户端的非Ｉｎｖｉｔｅ事务的清理比较复杂一些，要处理的内容也比较多，可以根据实际应用的情况进行有必要的清理工作：）

　　cb_transport_error　传输失败处理回调 
　　对应于上面说到的四种事务状态机，如果它们在处理时失败，则在这时进行统一处理。 
　　从代码可知，只是在NOTIFY,SUBSCRIBE,OPTION操作失败才进行处理，其它错误可直接忽略。

　　osip_set_message_callback　消息发送处理回调 
　　根据type不同，表示不同的消息发送状态 
　　OSIP_XXX_AGAIN 重发相关消息 
　　OSIP_ICT_INVITE_SENT 发起呼叫 
　　OSIP_ICT_ACK_SENT　ＡＣＫ回应 
　　OSIP_NICT_REGISTER_SENT　发起注册 
　　OSIP_NICT_BYE_SENT　ＢＹＥ发出 
　　OSIP_NICT_CANCEL_SENT　Ｃａｎｃｅｌ发出 
　　OSIP_NICT_INFO_SENT，OSIP_NICT_OPTIONS_SENT，OSIP_NICT_SUBSCRIBE_SENT，OSIP_NICT_NOTIFY_SENT，OSIP_NICT_UNKNOWN_REQUEST_SENT 
　　我们可以看到，eXosip没有对它们作任何处理，我们可以根据自己需要，比如，重发2xx消息前记录一下日志之类的，扩展一下retransmission的处理方式，发起Invite前记录一下通话日志等等。

　　OSIP_ICT_STATUS_1XX_RECEIVED　uac收到1xx消息，一般是表示对端正在处理中，这时，主要是设置一下事务状态机的状态值，并对会话中的osip的一些参数根据返回值进行相应设置，里面有许多条件判断，但我们常用的一般是100,180,183的判断而已，暂时可以忽略里面复杂的判断代码。 
　　OSIP_ICT_STATUS_2XX_RECEIVED uac收到2xx消息，这里主要跟踪一下Register情况下的2xx，表示注册成功，这时会更新一下exosip的注册字段值，以便让eXosip能自动维护uac的注册，ＢＹＥ的２ｘｘ回应是终结消息，Invite的2xx回应，则主要是初始化一下会话相关的数据，表示已成功建立连接。 
　　其它４ｘｘ，５ｘｘ，６ｘｘ则分别是对应的处理，根据实现情况进行概要的查看即可。 
　　report_event (je, sip)是代码中用来进行事件处理的一个函数，跟踪后发现，其最终是使用了我们上文提到的ｊｐｉｐｅ管道，以便在状态机外实时观测状态机内的处理信息。 
　　 
　　OSIP_NIST_STATUS_XXX_SENT即对应于上面的uac的处理，这里是uas的对应的消息处理，相比较于uac简单一点。

　　前面简单介绍了一下大量的回调函数及它们的概要处理逻辑，可能会比较混乱，暂时不用管它，只需要记得一个大概的形象，知道一个ＳＩＰ处理程序是通过osip_set_cb_send_message回调函数来实现真实地发送各种ＳＩＰ消息，并且ＳＩＰ的标准事务模型是由ｏＳＩＰ实现好了，我们只需要给不同的事务状态设置不同的回调处理函数来处理事务，具体的状态变化和内部逻辑不用管就可以了。

　　下面来说一下消息处理回调函数用到的ＳＯＣＫ的初始化函数，即我们上面说的除了系统初始化外的网络初始化函数eXosip_listen_addr： 
　　从上文知道了，系统将初始化两个ＳＯＣＫ，一个ＵＤＰ一个ＴＣＰ，但查看代码发现还有第三个，ＴＣＰｓ的，但好象还不能实用，现在不管它，代码首先是根据传输是ＵＤＰ还是ＴＣＰ来设置对应的数组值，并且如果没有提供ＩＰ地址和端口号，系统会自动取出本机网络接口并创建可用的ＳＯＣＫ（http_port的方式暂不用考虑）。 
　　ＳＯＣＫ初始化后，如何开始ＳＩＰ事务的呢？看到这个调用eXosip.j_thread = (void *) osip_thread_create (20000, _eXosip_thread, NULL)，对的，这里启用了一个线程，即，ｅＸｏｓｉｐ是调用ｏＳＩＰ的线程函数（没用系统提供的线程函数，是为了跨平台）进行事务处理的状态机逻辑是在一个线程中处理的，这样就明白了为什么一直没能看到顺序执行下来的程序启动代码了，接下去看，线程实际处理函数是_eXosip_thread，这里面的代码中，我们看到了上文提到的状态机控制开关变量while (eXosip.j_stop_ua == 0)，即，当j_stop_ua设置为1时，osip_thread_exit ()结束事务处理即程序终结，再接下去看，_eXosip_execute是最终的处理函数了，而且它在程序未终结情况下是一直逻辑在执行，注意，要启用ｏＳＩＰ的多线程宏OSIP_MT。 
　　 
　　看到_eXosip_execute的代码中有很多时间函数和变量，仔细看，除去一些控制代码，主要处理函数是eXosip_read_message (1, lower_tv.tv_sec, lower_tv.tv_usec)，即取出消息，1表示只取出一条消息，其代码量非常的大，但同样的，其中也许多的控制代码和错误检测代码，我们在查看时可以暂时忽略掉它们。 
　　eXosip_read_message读取消息时，即没有采用sock的block也没有用非block方式，而是采用了select方式，具体应用可查询fd_set相关文档。 
　　根据jpipe_read (eXosip.j_socketctl, buf2, 499)，我们可以估计，buf2中应该是保存的我们的控制管道的数据，具体作用至些还没有表现出来，应该是用来反映一些状态机内部的警示之类的信息，实际的ＳＩＰ的处理的状态机的数据是存放在buf中，使用_eXosip_recvfrom获取的，获取后sipevent = osip_parse (buf, i)解析，使用osip_find_transaction_and_add_event (eXosip.j_osip, sipevent)来查询事件对应的事务状态机，找到后就如同其注解所说明的，/* handled by oSIP ! */，即我们上文设置的那一大堆回调函数，至此，我们知道了整个ＳＩＰ应用所处理的大概流程了。 
　　如果没有找到事务状态机呢？直接丢弃吗？不是的，如果这是一个回应消息，但没有事务状态机处理它，那它是一个错误的，要进行清理后才能丢弃，而如果是一个请求，那更不能丢弃了，因为UAS事务状态机要由它来启动创建的(回应消息表示本地发出了请求消息，即ＵＡＣ行为，事务状态机应是由启动ＵＡＣ的代码初始化启动的)，整个逻辑应该是很简单的，但ｅＸｏｓｉｐ的实现代码却非常多，可见其花了非常多的精力在保证会话的稳定性和应付网络复杂情况上，我们可以对其进行大量的精简来构建满足我们需求的代码实现。 
　　先来看错误的回应消息的处理函数eXosip_process_response_out_of_transaction，可以看到其代码就是一大堆的赋值语句，XXX= NULL，即将一大堆的运行时变量清空，再调用osip_event_free清空事件，或者就是一些复杂的情况下，需要通过解析现在的运行时数据，从中分析出"可能"的正在等待回应的对端，并发送相关终结通知消息等等，可以根据实际需要进行简化。 
　　请求事件的处理eXosip_process_newrequest，首先是对事件进行探测，MSG_IS_INVITE、MSG_IS_ACK、MSG_IS_REQUEST……，对事件进行所属状态机分类，随后使用_eXosip_transaction_init (&transaction,(osip_fsm_type_t) tx_type,eXosip.j_osip, evt->sip)根据探测结果进行状态机初始化，实际调用的是osip_transaction_init，初始化后即将事件入状态机osip_transaction_add_event (transaction, evt)，由状态机自动处理后调用相应回调函数处理逻辑了。当然，ｅＸｏｓｉｐ为方便快速开发ＳＩＰ终端应用，在下面又添加了许多自动化的处理代码，来和我们在回调函数中设置的处理代码相区分。

　　线程调用的事件处理函数代码最后是 
if (eXosip.keep_alive > 0) 
{ 
　　_eXosip_keep_alive (); 
} 
　　这段代码印证了上文提到了，keep_alive是用来设置是否自动重新注册，由_eXosip_keep_alive函数来实现自动将eXosip全局变量中保存的注册消息解析后自动根据需要重新向ＳＩＰ服务器发起Ｒｅｇｉｓｔｅｒ注册。 
　　同样，因为注册消息发起是ＵＡＣ的行为，将它放在这里，可以看出来所有事件消息的事务状态机处理都是在这里，只不过这里只创建ＵＡＳ的事务状态机，ＵＡＣ的事务状态机的创建则要继续到下面找了，从我们的ＹｏｕＴｏｏ软电话代码中可知，发起呼叫和发起注册分别调用了eXosip_call_send_initial_invite，eXosip_register_send_register这两个函数（另外用到的两个build函数则是分别构建这两个send函数要发送的ＳＩＰ消息），查看这两个函数可知，ＵＡＣ的事务处理状态机是在这里进行初始化的。 
　　eXosip_register_send_register中可以看到是_eXosip_transaction_init (&transaction, NICT, eXosip.j_osip, reg)初始化ＵＡＣ状态机，实际也同ＵＡＳ是调用的osip_transaction_init函数，同样使用osip_transaction_add_event (transaction, sipevent)将事件入状态机，状态机随后将自动处理调用相应回调函数处理逻辑了。 
　　另有osip_new_outgoing_sipmessage(reg)，表示发送消息，到这里，我们应该可以理解，真实的发送操作，是要到由状态机处理后，调用了消息发送回调函数才真正地将注册消息发送出去的。 
　　同注册消息发送，它是ＮＩＣＴ状态机，呼叫消息的发送是ＩＣＴ，由eXosip_call_send_initial_invite处理，_eXosip_transaction_init (&transaction, ICT, eXosip.j_osip, invite)初始化了状态机，之前还有一个eXosip_call_init是用来初始化eXosip的一些参数的，暂时不管它，同样osip_new_outgoing_sipmessage (invite)发送呼叫消息，但实际还是要状态机处理后调用消息发送回调函数真实发送呼叫请求函数的，osip_transaction_add_event (transaction, sipevent)则标准地，将事件入状态机，状态机将能处理随后的应用逻辑调用相应的回调函数了。

　　好了，作了这么多的分析，我们了解了ｅＸｏｓｉｐ是怎样调用ｏＳＩＰ来形成被我能方便地再次调用的了，可以看到，为了实现最大限度的跨平台和兼容性，代码中有大量的测试代码，宏定义和错误再处理代码，看起来非常吃力，但了解了其主要的调用框架： 
　　初始化，回调函数设置，ＵＡＣ和ＵＡＳ事务处理状态机的启动，事件处理流程等，就可以基本明白了ｏＳＩＰ各个函数的主要作用和正确的用法了，下一步，可以参考ｅＸｏｓｉｐ来针对某个应用，去除掉大量暂时用不到的代码，来构建一个简单的ＳＩＰ软电话和ＳＩＰ服务器，来进一步深入ｏＳＩＰ学习应用了。　

续一：纯协议栈逻辑分析（转）

转自http://mbstudio.spaces.live.com/blog/cns!C898C3C40396DC11!2860.entry

很长时间之前，简单粗略地看了下Osip,eXosip,ortp等并快速"封装"了一个Windows下的基于VC6的MFC的SIP软电话（全部源代码VC6工程文件及Lib库可在本Blog共享文件夹找到），由于时间限制，只能是一知半解地纯"应用"式地分析了一下osip,eXosip等开发库的代码，作为兴趣爱好者参考了解下SIP电话工作原理还可以，但作为商用产品开发参考则还是太浅显了些：） 
　　最近扩展嵌入式Linux平台上的SIP功能模块（基于OSIP），由于使用的Osip不包括Call Transfer相关字段(Refer,Notify等)的解析和状态机控制（最近的Osip版本是否有扩展未查看）不能支持呼叫转接，需要手工扩展，有机会对Osip的主要事务状态机、解析库等部分稍有了些较深入的了解，结合SIP RFC总结分享如下。 
　　（注：下文假设阅读者已经大概了解SIP协议的简单呼叫流程，会使用Ethereal等抓包工具分析SIP消息结构，对C语言的指针、链表、内存控制及状态机等概念有足够的认识。）

　　要应用Osip到我们的程序中去，首先要看官方文档，文档中对Osip协议栈提供的各个功能部件如何使用都有比较详细的描述，但未进行整体性的分析，某些中文的指导文档也都停留在对其简单的翻译，不能为不熟悉该协议栈使用的用户快速参考使用，本文档不按照Osip的代码进行按功能分块说明，而是根据实际使用时的代码使用顺序来对主要逻辑流程进行分析，并适当对流程中使用到的功能部件进行说明，具体更详细的功能说明或疑问可直接查看官方文档对应部分的解释或直接查看功能函数源代码即可解决。 
准备工作 
先认识几个结构体：osip_t，osip_message_t，osip_dialog_t，osip_transaction_t； 
　　osip_t是一个全局变量，所有要使用Osip协议栈的事务处理能力的程序都要第一步就初始化它（相对应于只使用osipparser库进行SIP消息字段解析的应用来说，如果只使用parser库到自己的程序中，想必对SIP协议栈已经很熟悉了，不需再往下看了^_^），它内部主要是定义了Osip协议栈的四个主要事务链表、消息实际发送函数及状态机各状态事件下的回调函数等； 
　　osip_message_t是SIP消息的C语言结构体存储空间，收到SIP消息解析后存在该结构中方便程序使用接收到的消息中的指定的字段，发送消息前为方便设置要发送的字段值，将要发送的内容存在该结构中等发送时转为字符串； 
　　osip_dialog_t则是SIP RFC中的dialog或叫call leg的定义，它标识了uac和uas的一对关系，并一直保持到会话(session)结束，一个完整的dialog主要包括from,to,callid,fromtag,totag,state等（可查看源码），其中fromtag,totag,callid在一个dialog成功建立后才完整，体现在SIP消息中，就是From、To的tag，Call-id字段的值相同时，这些消息是属于它们对应的一个Dialog的，例如将要发起invite时，只有fromtag,callid填充有值，在收到to远端的响应时，收到totag填充到dialog中，建立成功一个dialog，后继的逻辑均是使用这个dialog进行处理（如transaction事务处理），state表示本dialog的状态，与transaction的state有很大的关联，共用由Enum结构state_t定义； 
osip_transaction_t则是RFC中的事务的定义，它表示的是一个会话的某个Dialog之间的某一次消息发送及其完整的响应，例如invite-100-180-200-ack这是一个完整的事务，bye-200这也是一个完整的事务，体现在SIP消息中，就是Via中的branch的值相同表示属于一个事务的消息（当然，事务是在Dialog中的，所以From、To的tag，Call-id值也是相同的），事务对于UAC,UAS的终端类型不同及消息的不同，分为四类，前面说的invite的事务，主叫uac中会关联一个ict事务，被叫uas会关联一个ist事务，而除了invite之外，都归类定义主叫nict，被叫nist，在Osip中，它是靠有限状态机来实现的上述四种事务（osip_fsm_type_t中定义）的，它的主要属性值有callid,transactionid，分别来标识dialog和transaction，其中还有一个时间戳birth_time标识事务创建时间，可由超时处理函数用来判断和决定超时情况下的事务的进行和销毁，而它的state属性是非常重要的，根据上述的事务类型不同，其值也不同，它是前面提到的状态机的"状态"，在实际状态机的逻辑执行中是一个关键值； 
Osip初始化 
　　提到osip的初始化，可能大家都看过官方文档里第一页的代码，首先就是osip_init(&osip)初始化了全局的osip_t结构体，然后对它的回调函数进行设置，很多人估计就是一看到这密密麻麻的一页多的call_back设置被吓到了，但结合前面分析的三个结构体的含义，这里的含义就很清晰了： 
　　osip_t中有一个cb_send_message函数指针，它是Osip最终与外界网络交互的接口，它的参数有( osip_transaction_t * trn, /*本消息所属的事务*/ 
osip_message_t * sipmsg, /*待发送的消息结构体*/ 
char *dest_socket_str, /*目标地址*/ 
int32_t dest_port, /*目标端口*/ 
int32_t send_sock)　　　　/*用来发送消息的socket*/ 
　　其中trn传入主要是为了方便获取事务的上下文数据，它有一个void指针your_instance，可以用来传入更多数据方便发送消息时参考，例如将该事务所属的dialog指针传入； 
　　而sipmsg则是我们要发送的SIP消息的C结构体，使用osip_message_to_str将其按RFC文档格式转换为一个字符串（osip中的parser模块的主要功能），再通过任意你自己的网络数据发送函数使用send_sock发送给dest_socket_str和dest_port指定的目标，当然，要记得使用osip_free释放刚才发送出去的字符串占用的内存，Osip中很多osipparser提供的消息解析处理函数都是动态内存分配的，使用完毕后需要及时释放； 
　　使用osip_set_cb_send_message成功设置回调函数，我们的SIP消息就有了出口了，下面继续分析（当然，了解到了上面的流程，也可以手工指定了）。

　　下面的回调函数分为三类，分别是普通事务消息（osip_message_callback_type_t中定义）的处理回调函数、事务销毁事件（osip_kill_callback_type_t中定义）的清理回调函数以及事务执行过程中的错误事件（osip_transport_error_callback_type_t中定义）处理回调函数： 
　　先说简单的，事务销毁事件，事务正常结束（成功完成状态机流程）或由超时处理函数强制终结等情况下均调用了这些回调函数，一般就是释放事务结构体，为ICT,NICT,IST,NIST各设置或共用一个回调函数均可，只要正确释放不再使用的内存即可； 
　　错误处理函数则是在整个状态机执行过程中发生的任何错误的出口，一般用来安插log函数方便调试，也可以直接设为空函数； 
　　而最关键的就是正常消息的处理回调函数了，其量是非常大的，但仔细分下类，也和上面的回调函数一样，也是分为四类，我们可有根据实际程序的需要来进行设置，例如，SIP电话机就不需要处理OSIP_NIST_REGISTER_RECEIVED这个SIP注册服务器才需要处理的Register消息事件了，精简一下，如果只是要做一个只需要实现主叫功能且不考虑错误情况的UAC的Demo软电话程序，则只需要设置如下几个事件的回调函数： 
　　OSIP_ICT_INVITE_SENT　发出Invite开始呼叫 
　　OSIP_ICT_STATUS_1XX_RECEIVED　收到180 
　　OSIP_ICT_STATUS_2XX_RECEIVED　收到200 
　　OSIP_ICT_ACK_SENT　　发出ack确定呼叫 
　　OSIP_NICT_BYE_SENT　　发出bye结束呼叫 
　　OSIP_NICT_STATUS_2XX_RECEIVED　收到200确认结束呼叫 
　　OSIP_NIST_BYE_RECEIVED　收到bye结束呼叫 
　　OSIP_NIST_STATUS_2XX_SENT　发出 200确定结束呼叫 
而要增加接受呼叫的被叫UAS功能，则只需要增加如下事件： 
　　OSIP_IST_INVITE_RECEIVED　收到invite开始呼叫 
　　OSIP_IST_STATUS_1XX_SENT　发出180 
　　OSIP_IST_STATUS_2XX_SENT　发出200 
　　OSIP_IST_ACK_RECEIVED　　收到ack确认呼叫 
具体的函数定义，则直接参考osip_message_cb_t，osip_kill_transaction_cb_t，osip_transport_error_cb_t即可，回调函数的设置同上可以手工设置，也可以使用Osip提供的对应的osip_set_xxx_callback函数； 
发出SIP消息 
　　要发送SIP消息，从上面的分析可知有几个必要的条件，osip_messag_t结构的待发送消息，osip_dialog_t结构体的dialog以及osip_transaction_t的事务； 
　　首先osip_malloc新分配一个dialog，使用osip_to_init，osip_to_parse，osip_to_free这类parser函数功能函数按RFC设置call-id,from,to,local_cseq等必要字段（原则是：后面生成实际SIP消息结构体要用到的字段就需要设置），使用osip_message_init初始化一个sipmsg，根据dialog来填充该结构体（不同的消息填充的数据是不同的，没有捷径可走，只能看RFC根据需要填充字段），如果要给SIP消息添加Body例如SDP段，需要使用osip_message_set_body，osip_message_set_content_type函数，设置的值是纯文本，如果是SDP，Osip有提供简单的解析和生成便捷函数例如sdp_message_to_str,sdp_message_a_attribute_add，但只是简单的字符操作，要填充合法的字段需要自己参考SDP的RFC文档，同样没捷径可走。 
　　现在我们有了两个必要条件了，还有最后一个也是最关键的部件，就是事务的创建和触发， 
int osip_transaction_init( 
osip_transaction_t ** transaction, /*返回的事务结构体指针*/ 
osip_fsm_type_t ctx_type, /*事务类型ICT/NICT/IST/NIST*/ 
osip_t * osip,　　/*前文说的全局变量*/ 
osip_message_t * request)　/*前面生成的sipmsg*/ 
　　创建了一个新的事务，并自动根据事务类型、dialog和sipmsg进行了初始化，最重要的是它使用了__osip_add_ict等函数，将本事务插入到全局的osip_t结构体的全局FIFO链表中去了，不同的事务类型对应不同的FIFO，由前文可知，本类函数有四个，FIFO也有四个，对应ICT,NICT,IST,NIST，注意这个这里使用osip_transaction_set_out_socket把发送sip消息的socket接口配给该事务，方便自动调用前面设置的发送消息回调函数使用它自动发送消息； 
　　前文提到了transaction里的state作为状态机的"状态"，要执行状态机，就需要有"事件"来触发，事件结构体osip_event_t需要使用osip_new_outgoing_sipmessage来对sipmsg进行探测生成，设置正确的事件值，省却了我们手工设置的工作，它调用evt_set_type_outgoing_sipmessage来设置"事件"type_t，并将sipmsg挂到事件结构体的sip属性值上，有了根据消息分析出的事件后，使用osip_fifo_add(trn->transactionff, ev)将事件插入到事务的事件FIFO中，即transactionff属性； 
　　 
　　有了上面的发送消息的必要条件了，消息是如何实际出发的呢？上面提到了，SIP消息的发送和响应是一个事务，不能隔离开来，即消息的发送需要事务状态机来控制，我们上面设置了状态机的状态和事件，要触发它，就是要执行状态机了： 
　　osip_ict_execute 
　　osip_nict_execute 
　　osip_ist_execute 
　　osip_nist_execute 
　　分别用来遍历前面提到的四个事务FIFO，取出事务，再依次取出事务内的事件FIFO上的事件，使用osip_transaction_execute依次执行（有兴趣的可以更深一步去查看，可以看到它最终就是调用了我们前面设置的消息回调函数，至于具体调用哪个，这就是OSIP协议栈内部帮我们做的大量的工作了^_^）； 
　　如果某个事务不能正常终结怎么办呢？例如发出了Invite没有收到任何响应，按RFC定义，不同的事务有不同的超时时间，osip_timers_ict[nict|ist|nist]_execute这些函数就是来根据取出的事务的时间戳与当前时间取差后与规定的超时时间比对，如果超时，就自动设置了超时"事件"并将事务"状态"设为终结，使用前面设定的消息超时事件回调函数处理即可（如果设置了）； 
　　如果网络质量不稳定，经常丢失消息，需要使用osip_retransmissions_execute函数来自动重发消息而不是等待超时； 
　　为了即时响应SIP消息的处理推动状态机，上述的九个函数需要不停执行，可以将它放入单独线程中。 
收到SIP消息 
　　有了前面的发送SIP消息的理解，接收消息的处理就方便理解了，收到SIP消息，使用osip_parse进行解析，得到一个osip_message_t的sipmsg，使用evt_set_type_incoming_sipmessage得到事务的"事件"，并同上将sipmsg挂到事件结构体的sip字段，随后立即使用osip_find_transaction_and_add_event来根据"事件"查找事务（有兴趣可以深入看一下，事务的查找是通过SIP消息Via中的branch来匹配的），否则新建事务，然后推动状态机执行。 
状态机内部逻辑 
　　弄清了上面的状态机的大概逻辑，设置正确完备的回调函数，就可以正确使用Osip来进行工作了，如果要进一步深入Osip，比如要扩展Osip的状态机处理自定义的消息字段和实现新的事务逻辑来生成新业务时，就需要对状态机的内部逻辑有一定的了解； 
　　前面一再强调，Osip内部的几个重要的数据结构osip_message_t,osip_dialog_t,osip_transaction_t，其中面向用户的主要是前后两个，而中间的dialog则很多时候是在状态机内部使用的，例如：收到消息，解析到sipmsg中，查找transaction并进行驱动，随后找到它关联的dialog（或者新生成）解析填充要发送的消息结构体sipmsg，再次根据dialog和sipmsg查找或生成transaction。 
　　如果要扩展Osip，要做工作主要有： 
　　扩展osip_message_t，增加要解析的字段或消息头，并参考原Osip函数生成对应的SIP字符串生成和解析函数； 
　　扩展osip_dialog_t，增加新的属性，对应osip_message_t的新增内容； 
　　扩展状态机的事件和状态类型，设置对应的回调函数，并关联新增事件和状态类型到osip_message_t的解析函数或osip_dialog_t的初始化函数中，而osip_transaction_t大多数时候不需要扩展，只要在对应的事务类型（大多数时候是NICT、NIST）处理逻辑中，增加对新增事件和状态类型的判断和调用回调函数的逻辑即可。