summaryrefslogtreecommitdiff
path: root/pjsip/include/pjsip/sip_private.h
blob: 813b76bee708d2be213ba7a3e84580d92a08bbef (plain)
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
105
106
107
/* $Id$
 */
/* 
 * PJSIP - SIP Stack
 * (C)2003-2005 Benny Prijono <bennylp@bulukucing.org>
 *
 * Author:
 *  Benny Prijono <bennylp@bulukucing.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
#ifndef __PJSIP_SIP_PRIVATE_H__
#define __PJSIP_SIP_PRIVATE_H__

/**
 * @file sip_private.h
 * @brief Private structures and functions for PJSIP Library.
 */ 

#include <pjsip/sip_types.h>

PJ_BEGIN_DECL

/**
 * @defgroup PJSIP_PRIVATE Private structures and functions (PJSIP internals)
 * @ingroup PJSIP
 * @{
 */


/** 
 * Create a new transport manager.
 * @param pool The pool
 * @param endpt The endpoint
 * @param cb Callback to be called to receive messages from transport.
 */
PJ_DECL(pj_status_t) pjsip_transport_mgr_create( pj_pool_t *pool,
						 pjsip_endpoint *endpt,
						 void (*cb)(pjsip_endpoint *,
							    pjsip_rx_data *),
						 pjsip_transport_mgr **);


/**
 * Destroy transport manager and release all transports.
 * @param mgr Transport manager to be destroyed.
 */
PJ_DECL(pj_status_t) pjsip_transport_mgr_destroy( pjsip_transport_mgr *mgr );

/**
 * Poll for transport events.
 * Incoming messages will be parsed by the transport manager, and the callback
 * will be called for each of this message.
 * @param endpt The endpoint.
 * @param timeout Timeout value, or NULL to wait forever.
 */
PJ_DECL(int) pjsip_transport_mgr_handle_events( pjsip_transport_mgr *mgr,
					        const pj_time_val *timeout );

/**
 * Get the pointer to the first transport iterator.
 * @param mgr The transport manager.
 * @param it  The iterator used for iterating the hash element.
 * @return the iterator to the first transport, or NULL.
 */
PJ_DECL(pj_hash_iterator_t*) pjsip_transport_first( pjsip_transport_mgr *mgr,
						    pj_hash_iterator_t *it );


/**
 * Get the next transport iterator.
 * @param itr the iterator to the transport.
 * @return the iterator pointed to the next transport, or NULL.
 */
PJ_DECL(pj_hash_iterator_t*) pjsip_transport_next( pjsip_transport_mgr *mgr,
						   pj_hash_iterator_t *itr );

/**
 * Get the value of transport iterator.
 * @param mgr the transport manager.
 * @param itr the transport iterator.
 * @return the transport associated with the iterator.
 */
PJ_DECL(pjsip_transport_t*) pjsip_transport_this( pjsip_transport_mgr *mgr,
						  pj_hash_iterator_t *itr );

/** 
 * @}
 */

PJ_END_DECL

#endif /* __PJSIP_PRIVATE_I_H__ */