Osip源代码框架04 ---invite消息中事件和事务的创建

事件创建

osip_new_outgoing_sipmessage 的函数，其主要功能是创建一个新的 SIP（Session Initiation Protocol，会话发起协议）事件对象，用于表示一个即将发送的 SIP 消息

执行流程：

• 参数检查：
  首先检查输入的 SIP 消息指针是否为 NULL，如果是则直接返回 NULL。
  如果 SIP 消息是一个请求（通过 MSG_IS_REQUEST 宏判断），则进一步检查请求方法（sip_method）和请求 URI（req_uri）是否存在，若不存在则返回 NULL。
• 内存分配：
  使用 osip_malloc 分配一个 osip_event_t 结构大小的内存空间。
  如果内存分配失败（返回 NULL），则函数直接返回 NULL。
• 初始化事件结构：
  将传入的 SIP 消息指针赋值给事件结构的 sip 字段。
  通过调用 evt_set_type_outgoing_sipmessage 函数设置事件类型，该函数根据 SIP 消息的内容确定具体的事件类型。
  将事务 ID（transactionid）初始化为 0，表示该事件尚未与任何事务关联。
• 返回结果：
  返回初始化完成的事件结构指针。

具体实现：

osip_event_t* osip_new_outgoing_sipmessage(osip_message_t * sip)
{
    osip_event_t *sipevent;

    if (sip == NULL)
        return NULL;

    if (MSG_IS_REQUEST(sip))
    {
        if (sip->sip_method == NULL)
            return NULL;

        if (sip->req_uri == NULL)
            return NULL;
    }

    sipevent = (osip_event_t *) osip_malloc(sizeof(osip_event_t));

    if (sipevent == NULL)
        return NULL;

    sipevent->sip = sip;

    sipevent->type = evt_set_type_outgoing_sipmessage(sip);

    sipevent->transactionid = 0;

    return sipevent;
}

事务创建

事务 transaction是 SIP 协议中管理消息交换的状态机，负责跟踪请求和响应的匹配、重传机制、超时处理等

该函数的主要作用是初始化一个新的 SIP INVITE 事务，并将 INVITE 请求发送到远程终端，为后续的媒体流传输建立会话。它是 eXosip 库中处理呼叫建立的关键接口

参数与返回值
参数：
osip_message_t* invite：指向已构建好的 SIP INVITE 消息的指针，包含呼叫参数（如 To/From/Contact 头域、SDP 媒体描述等）。
返回值：
成功时返回新创建的呼叫 ID（jc->c_id），用于后续操作（如终止呼叫、处理响应）。
失败时返回 -1，并释放相关资源。

执行流程：

1. 初始化呼叫对象：

SipStackCallObj* jc = NULL;
SipCallLegInit(&jc);

2.初始化事务层：
创建一个 INVITE Client Transaction（ICT），负责管理 INVITE 请求的发送和响应处理。
ICT 是事务类型常量，表示这是一个客户端发起的 INVITE 事务

i = SipStackTransactionInit(&transaction, ICT, eXosip.j_osip, invite);

3.设置呼叫属性：
将 INVITE 消息中的业务 ID、通道号等信息复制到呼叫对象中，并标记呼叫方向为 “呼出”。

jc->nCall_BId = invite->nm_BId;
jc->nCall_Ch  = invite->nm_nCh;
jc->nCall_Dir = 2;  // 表示呼出方向
jc->c_out_tr = transaction;

4. 创建 SIP 事件：
   调用 osip_new_outgoing_sipmessage 创建一个表示 “即将发送的 SIP 消息” 的事件对象。
   将事务 ID 关联到事件，以便后续追踪。

sipevent = osip_new_outgoing_sipmessage(invite);
sipevent->transactionid = transaction->transactionid;

5. 关联事务与回调数据

osip_transaction_set_your_instance(transaction, SipStackInternalNewJinfo(jc, NULL, NULL, NULL));

6. 添加事件到事务：

osip_transaction_add_event(transaction, sipevent);

7. 注册到全局列表：
   将新创建的呼叫对象添加到 eXosip 库的全局呼叫列表中。
   更新内部链表，确保资源管理一致性。

ADD_ELEMENT(eXosip.j_calls, jc);
SipStackUpdateAllLinkList();

8. 唤醒事件处理线程：
   通过管道写入事件，唤醒 eXosip 的事件处理线程，开始处理待发送的 INVITE 请求。

SipStackWritePipeEventWakeup();

具体实现：

int eXosip_call_send_initial_invite(osip_message_t* invite)
{
	SipStackCallObj*		jc = NULL;
	osip_transaction_t*		transaction = NULL;
	osip_event_t*			sipevent = NULL;
	int						i = 0;

	SipCallLegInit(&jc);

	i = SipStackTransactionInit(&transaction, ICT, eXosip.j_osip, invite); 
	if (i != 0)
	{
		SipCallLegFree(jc);
		osip_message_free (invite);
		return -1;
	}

	jc->nCall_BId = invite->nm_BId;
	jc->nCall_Ch  = invite->nm_nCh;//for sipp test
	jc->nCall_Dir = 2;
	jc->nSipSessionExpiresEnable = invite->nSipSessionExpiresEnable;
	jc->c_out_tr = transaction;

	sipevent = osip_new_outgoing_sipmessage (invite);

	sipevent->transactionid = transaction->transactionid;

	osip_transaction_set_your_instance (transaction, SipStackInternalNewJinfo(jc, NULL, NULL, NULL));

	osip_transaction_add_event (transaction, sipevent);

	jc->external_reference = NULL;

	ADD_ELEMENT(eXosip.j_calls, jc);

	SipStackUpdateAllLinkList();

	SipStackWritePipeEventWakeup();

	return jc->c_id;
}