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

得到了一个ＳＩＰ软电话模型后，我们可以根据软电话的实际运行表现（结合用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)则标准地，将事件入状态机，状态机将能处理随后的应用逻辑调用相应的回调函数了。

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