1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/* $Id$ */
/*
* Copyright (C) 2003-2006 Benny Prijono <benny@prijono.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __PJSIP_SIP_UA_LAYER_H__
#define __PJSIP_SIP_UA_LAYER_H__
/**
* @file sip_ua_layer.h
* @brief SIP User Agent Layer Module
*/
#include <pjsip/sip_types.h>
PJ_BEGIN_DECL
/**
* @defgroup PJSUA SIP User Agent Stack
*/
/**
* @defgroup PJSUA_UA SIP User Agent Module
* @ingroup PJSUA
* @{
* \brief
* User Agent manages the interactions between application and SIP dialogs.
*/
/** User agent initialization parameter. */
typedef struct pjsip_ua_init_param
{
pjsip_dialog* (*on_dlg_forked)(pjsip_dialog *first_set, pjsip_rx_data *res);
} pjsip_ua_init_param;
/**
* Initialize user agent layer and register it to the specified endpoint.
*
* @param endpt The endpoint where the user agent will be
* registered.
* @param prm UA initialization parameter.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_ua_init(pjsip_endpoint *endpt,
const pjsip_ua_init_param *prm);
/**
* Get the instance of the user agent.
*
* @return The user agent module instance.
*/
PJ_DECL(pjsip_user_agent*) pjsip_ua_instance(void);
/**
* Destroy the user agent layer.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_ua_destroy(void);
/**
* Get the endpoint instance of a user agent module.
*
* @param ua The user agent instance.
*
* @return The endpoint instance where the user agent is
* registered.
*/
PJ_DECL(pjsip_endpoint*) pjsip_ua_get_endpt(pjsip_user_agent *ua);
/*
* Internal.
*/
PJ_DECL(pj_status_t) pjsip_ua_register_dlg( pjsip_user_agent *ua,
pjsip_dialog *dlg );
PJ_DECL(pj_status_t) pjsip_ua_unregister_dlg(pjsip_user_agent *ua,
pjsip_dialog *dlg );
/**
* @}
*/
PJ_END_DECL
#endif /* __PJSIP_SIP_UA_LAYER_H__ */
|
