1
/* $Id: sip_transport.c 4094 2012-04-26 09:31:00Z bennylp $ */
3
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
4
* Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; either version 2 of the License, or
9
* (at your option) any later version.
11
* This program is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with this program; if not, write to the Free Software
18
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
#include <pjsip/sip_transport.h>
21
#include <pjsip/sip_endpoint.h>
22
#include <pjsip/sip_parser.h>
23
#include <pjsip/sip_msg.h>
24
#include <pjsip/sip_private.h>
25
#include <pjsip/sip_errno.h>
26
#include <pjsip/sip_module.h>
27
#include <pj/except.h>
30
#include <pj/ioqueue.h>
32
#include <pj/string.h>
34
#include <pj/assert.h>
39
#define THIS_FILE "sip_transport.c"
42
# define TRACE_(x) PJ_LOG(5,x)
44
static const char *addr_string(const pj_sockaddr_t *addr)
46
static char str[PJ_INET6_ADDRSTRLEN];
47
pj_inet_ntop(((const pj_sockaddr*)addr)->addr.sa_family,
48
pj_sockaddr_get_addr(addr),
57
static pj_status_t mod_on_tx_msg(pjsip_tx_data *tdata);
59
/* This module has sole purpose to print transmit data to contigous buffer
60
* before actually transmitted to the wire.
62
static pjsip_module mod_msg_print =
64
NULL, NULL, /* prev and next */
65
{ "mod-msg-print", 13}, /* Name. */
67
PJSIP_MOD_PRIORITY_TRANSPORT_LAYER, /* Priority */
72
NULL, /* on_rx_request() */
73
NULL, /* on_rx_response() */
74
&mod_on_tx_msg, /* on_tx_request() */
75
&mod_on_tx_msg, /* on_tx_response() */
76
NULL, /* on_tsx_state() */
84
pj_hash_table_t *table;
86
pjsip_endpoint *endpt;
87
pjsip_tpfactory factory_list;
88
#if defined(PJ_DEBUG) && PJ_DEBUG!=0
89
pj_atomic_t *tdata_counter;
91
void (*on_rx_msg)(pjsip_endpoint*, pj_status_t, pjsip_rx_data*);
92
pj_status_t (*on_tx_msg)(pjsip_endpoint*, pjsip_tx_data*);
93
pjsip_tp_state_callback tp_state_cb;
97
/* Transport state listener list type */
98
typedef struct tp_state_listener
100
PJ_DECL_LIST_MEMBER(struct tp_state_listener);
102
pjsip_tp_state_callback cb;
110
typedef struct transport_data
112
/* Transport listeners */
113
tp_state_listener st_listeners;
114
tp_state_listener st_listeners_empty;
118
/*****************************************************************************
120
* GENERAL TRANSPORT (NAMES, TYPES, ETC.)
122
*****************************************************************************/
127
struct transport_names_t
129
pjsip_transport_type_e type; /* Transport type */
130
pj_uint16_t port; /* Default port number */
131
pj_str_t name; /* Id tag */
132
const char *description; /* Longer description */
133
unsigned flag; /* Flags */
134
char name_buf[16]; /* For user's transport */
135
} transport_names[16] =
138
PJSIP_TRANSPORT_UNSPECIFIED,
149
PJSIP_TRANSPORT_DATAGRAM
156
PJSIP_TRANSPORT_RELIABLE
163
PJSIP_TRANSPORT_RELIABLE | PJSIP_TRANSPORT_SECURE
166
PJSIP_TRANSPORT_SCTP,
170
PJSIP_TRANSPORT_RELIABLE
173
PJSIP_TRANSPORT_LOOP,
176
"Loopback transport",
177
PJSIP_TRANSPORT_RELIABLE
180
PJSIP_TRANSPORT_LOOP_DGRAM,
183
"Loopback datagram transport",
184
PJSIP_TRANSPORT_DATAGRAM
187
PJSIP_TRANSPORT_UDP6,
190
"UDP IPv6 transport",
191
PJSIP_TRANSPORT_DATAGRAM
194
PJSIP_TRANSPORT_TCP6,
197
"TCP IPv6 transport",
198
PJSIP_TRANSPORT_RELIABLE
202
static void tp_state_callback(pjsip_transport *tp,
203
pjsip_transport_state state,
204
const pjsip_transport_state_info *info);
207
struct transport_names_t *get_tpname(pjsip_transport_type_e type)
210
for (i=0; i<PJ_ARRAY_SIZE(transport_names); ++i) {
211
if (transport_names[i].type == type)
212
return &transport_names[i];
214
pj_assert(!"Invalid transport type!");
221
* Register new transport type to PJSIP.
223
PJ_DEF(pj_status_t) pjsip_transport_register_type( unsigned tp_flag,
230
PJ_ASSERT_RETURN(tp_flag && tp_name && def_port, PJ_EINVAL);
231
PJ_ASSERT_RETURN(pj_ansi_strlen(tp_name) <
232
PJ_ARRAY_SIZE(transport_names[0].name_buf),
235
for (i=1; i<PJ_ARRAY_SIZE(transport_names); ++i) {
236
if (transport_names[i].type == 0)
240
if (i == PJ_ARRAY_SIZE(transport_names))
243
transport_names[i].type = (pjsip_transport_type_e)i;
244
transport_names[i].port = (pj_uint16_t)def_port;
245
pj_ansi_strcpy(transport_names[i].name_buf, tp_name);
246
transport_names[i].name = pj_str(transport_names[i].name_buf);
247
transport_names[i].flag = tp_flag;
257
* Get transport type from name.
259
PJ_DEF(pjsip_transport_type_e) pjsip_transport_get_type_from_name(const pj_str_t *name)
264
return PJSIP_TRANSPORT_UNSPECIFIED;
266
/* Get transport type from name. */
267
for (i=0; i<PJ_ARRAY_SIZE(transport_names); ++i) {
268
if (pj_stricmp(name, &transport_names[i].name) == 0) {
269
return transport_names[i].type;
273
pj_assert(!"Invalid transport name");
274
return PJSIP_TRANSPORT_UNSPECIFIED;
279
* Get the transport type for the specified flags.
281
PJ_DEF(pjsip_transport_type_e) pjsip_transport_get_type_from_flag(unsigned flag)
285
/* Get the transport type for the specified flags. */
286
for (i=0; i<PJ_ARRAY_SIZE(transport_names); ++i) {
287
if (transport_names[i].flag == flag) {
288
return transport_names[i].type;
292
pj_assert(!"Invalid transport type");
293
return PJSIP_TRANSPORT_UNSPECIFIED;
297
* Get the socket address family of a given transport type.
299
PJ_DEF(int) pjsip_transport_type_get_af(pjsip_transport_type_e type)
301
if (type & PJSIP_TRANSPORT_IPV6)
302
return pj_AF_INET6();
307
PJ_DEF(unsigned) pjsip_transport_get_flag_from_type(pjsip_transport_type_e type)
309
/* Return transport flag. */
310
return get_tpname(type)->flag;
314
* Get the default SIP port number for the specified type.
316
PJ_DEF(int) pjsip_transport_get_default_port_for_type(pjsip_transport_type_e type)
318
/* Return the port. */
319
return get_tpname(type)->port;
323
* Get transport name.
325
PJ_DEF(const char*) pjsip_transport_get_type_name(pjsip_transport_type_e type)
327
/* Return the name. */
328
return get_tpname(type)->name.ptr;
332
* Get transport description.
334
PJ_DEF(const char*) pjsip_transport_get_type_desc(pjsip_transport_type_e type)
336
/* Return the description. */
337
return get_tpname(type)->description;
341
/*****************************************************************************
345
*****************************************************************************/
348
* Add transport/listener reference in the selector.
350
PJ_DEF(void) pjsip_tpselector_add_ref(pjsip_tpselector *sel)
352
if (sel->type == PJSIP_TPSELECTOR_TRANSPORT && sel->u.transport != NULL)
353
pjsip_transport_add_ref(sel->u.transport);
354
else if (sel->type == PJSIP_TPSELECTOR_LISTENER && sel->u.listener != NULL)
355
; /* Hmm.. looks like we don't have reference counter for listener */
360
* Decrement transport/listener reference in the selector.
362
PJ_DEF(void) pjsip_tpselector_dec_ref(pjsip_tpselector *sel)
364
if (sel->type == PJSIP_TPSELECTOR_TRANSPORT && sel->u.transport != NULL)
365
pjsip_transport_dec_ref(sel->u.transport);
366
else if (sel->type == PJSIP_TPSELECTOR_LISTENER && sel->u.listener != NULL)
367
; /* Hmm.. looks like we don't have reference counter for listener */
371
/*****************************************************************************
373
* TRANSMIT DATA BUFFER MANIPULATION.
375
*****************************************************************************/
378
* Create new transmit buffer.
380
PJ_DEF(pj_status_t) pjsip_tx_data_create( pjsip_tpmgr *mgr,
381
pjsip_tx_data **p_tdata )
384
pjsip_tx_data *tdata;
387
PJ_ASSERT_RETURN(mgr && p_tdata, PJ_EINVAL);
389
pool = pjsip_endpt_create_pool( mgr->endpt, "tdta%p",
390
PJSIP_POOL_LEN_TDATA,
391
PJSIP_POOL_INC_TDATA );
395
tdata = PJ_POOL_ZALLOC_T(pool, pjsip_tx_data);
398
pj_memcpy(tdata->obj_name, pool->obj_name, PJ_MAX_OBJ_NAME);
400
status = pj_atomic_create(tdata->pool, 0, &tdata->ref_cnt);
401
if (status != PJ_SUCCESS) {
402
pjsip_endpt_release_pool( mgr->endpt, tdata->pool );
406
//status = pj_lock_create_simple_mutex(pool, "tdta%p", &tdata->lock);
407
status = pj_lock_create_null_mutex(pool, "tdta%p", &tdata->lock);
408
if (status != PJ_SUCCESS) {
409
pjsip_endpt_release_pool( mgr->endpt, tdata->pool );
413
pj_ioqueue_op_key_init(&tdata->op_key.key, sizeof(tdata->op_key.key));
415
#if defined(PJ_DEBUG) && PJ_DEBUG!=0
416
pj_atomic_inc( tdata->mgr->tdata_counter );
425
* Add reference to tx buffer.
427
PJ_DEF(void) pjsip_tx_data_add_ref( pjsip_tx_data *tdata )
429
pj_atomic_inc(tdata->ref_cnt);
433
* Decrease transport data reference, destroy it when the reference count
436
PJ_DEF(pj_status_t) pjsip_tx_data_dec_ref( pjsip_tx_data *tdata )
438
pj_assert( pj_atomic_get(tdata->ref_cnt) > 0);
439
if (pj_atomic_dec_and_get(tdata->ref_cnt) <= 0) {
440
PJ_LOG(5,(tdata->obj_name, "Destroying txdata %s",
441
pjsip_tx_data_get_info(tdata)));
442
pjsip_tpselector_dec_ref(&tdata->tp_sel);
443
#if defined(PJ_DEBUG) && PJ_DEBUG!=0
444
pj_atomic_dec( tdata->mgr->tdata_counter );
446
pj_atomic_destroy( tdata->ref_cnt );
447
pj_lock_destroy( tdata->lock );
448
pjsip_endpt_release_pool( tdata->mgr->endpt, tdata->pool );
449
return PJSIP_EBUFDESTROYED;
456
* Invalidate the content of the print buffer to force the message to be
457
* re-printed when sent.
459
PJ_DEF(void) pjsip_tx_data_invalidate_msg( pjsip_tx_data *tdata )
461
tdata->buf.cur = tdata->buf.start;
466
* Print the SIP message to transmit data buffer's internal buffer.
468
PJ_DEF(pj_status_t) pjsip_tx_data_encode(pjsip_tx_data *tdata)
470
/* Allocate buffer if necessary. */
471
if (tdata->buf.start == NULL) {
475
tdata->buf.start = (char*)
476
pj_pool_alloc(tdata->pool, PJSIP_MAX_PKT_LEN);
483
tdata->buf.cur = tdata->buf.start;
484
tdata->buf.end = tdata->buf.start + PJSIP_MAX_PKT_LEN;
487
/* Do we need to reprint? */
488
if (!pjsip_tx_data_is_valid(tdata)) {
491
size = pjsip_msg_print( tdata->msg, tdata->buf.start,
492
tdata->buf.end - tdata->buf.start);
494
return PJSIP_EMSGTOOLONG;
496
pj_assert(size != 0);
497
tdata->buf.cur[size] = '\0';
498
tdata->buf.cur += size;
504
PJ_DEF(pj_bool_t) pjsip_tx_data_is_valid( pjsip_tx_data *tdata )
506
return tdata->buf.cur != tdata->buf.start;
509
static char *get_msg_info(pj_pool_t *pool, const char *obj_name,
510
const pjsip_msg *msg)
512
char info_buf[128], *info;
513
const pjsip_cseq_hdr *cseq;
516
cseq = (const pjsip_cseq_hdr*) pjsip_msg_find_hdr(msg, PJSIP_H_CSEQ, NULL);
517
PJ_ASSERT_RETURN(cseq != NULL, "INVALID MSG");
519
if (msg->type == PJSIP_REQUEST_MSG) {
520
len = pj_ansi_snprintf(info_buf, sizeof(info_buf),
521
"Request msg %.*s/cseq=%d (%s)",
522
(int)msg->line.req.method.name.slen,
523
msg->line.req.method.name.ptr,
524
cseq->cseq, obj_name);
526
len = pj_ansi_snprintf(info_buf, sizeof(info_buf),
527
"Response msg %d/%.*s/cseq=%d (%s)",
528
msg->line.status.code,
529
(int)cseq->method.name.slen,
530
cseq->method.name.ptr,
531
cseq->cseq, obj_name);
534
if (len < 1 || len >= (int)sizeof(info_buf)) {
535
return (char*)obj_name;
538
info = (char*) pj_pool_alloc(pool, len+1);
539
pj_memcpy(info, info_buf, len+1);
544
PJ_DEF(char*) pjsip_tx_data_get_info( pjsip_tx_data *tdata )
546
/* tdata->info may be assigned by application so if it exists
552
if (tdata==NULL || tdata->msg==NULL)
555
pj_lock_acquire(tdata->lock);
556
tdata->info = get_msg_info(tdata->pool, tdata->obj_name, tdata->msg);
557
pj_lock_release(tdata->lock);
562
PJ_DEF(pj_status_t) pjsip_tx_data_set_transport(pjsip_tx_data *tdata,
563
const pjsip_tpselector *sel)
565
PJ_ASSERT_RETURN(tdata && sel, PJ_EINVAL);
567
pj_lock_acquire(tdata->lock);
569
pjsip_tpselector_dec_ref(&tdata->tp_sel);
571
pj_memcpy(&tdata->tp_sel, sel, sizeof(*sel));
572
pjsip_tpselector_add_ref(&tdata->tp_sel);
574
pj_lock_release(tdata->lock);
580
PJ_DEF(char*) pjsip_rx_data_get_info(pjsip_rx_data *rdata)
582
char obj_name[PJ_MAX_OBJ_NAME];
584
PJ_ASSERT_RETURN(rdata->msg_info.msg, "INVALID MSG");
586
if (rdata->msg_info.info)
587
return rdata->msg_info.info;
589
pj_ansi_strcpy(obj_name, "rdata");
590
pj_ansi_snprintf(obj_name+5, sizeof(obj_name)-5, "%p", rdata);
592
rdata->msg_info.info = get_msg_info(rdata->tp_info.pool, obj_name,
593
rdata->msg_info.msg);
594
return rdata->msg_info.info;
597
/*****************************************************************************
601
*****************************************************************************/
604
/*****************************************************************************
608
*****************************************************************************/
610
static void transport_send_callback(pjsip_transport *transport,
614
pjsip_tx_data *tdata = (pjsip_tx_data*) token;
616
PJ_UNUSED_ARG(transport);
618
/* Mark pending off so that app can resend/reuse txdata from inside
621
tdata->is_pending = 0;
623
/* Call callback, if any. */
625
(*tdata->cb)(tdata->token, tdata, size);
628
/* Decrement reference count. */
629
pjsip_tx_data_dec_ref(tdata);
632
/* This function is called by endpoint for on_tx_request() and on_tx_response()
635
static pj_status_t mod_on_tx_msg(pjsip_tx_data *tdata)
637
return pjsip_tx_data_encode(tdata);
641
* Send a SIP message using the specified transport.
643
PJ_DEF(pj_status_t) pjsip_transport_send( pjsip_transport *tr,
644
pjsip_tx_data *tdata,
645
const pj_sockaddr_t *addr,
648
pjsip_tp_send_callback cb)
652
PJ_ASSERT_RETURN(tr && tdata && addr, PJ_EINVAL);
654
/* Is it currently being sent? */
655
if (tdata->is_pending) {
656
pj_assert(!"Invalid operation step!");
657
PJ_LOG(2,(THIS_FILE, "Unable to send %s: message is pending",
658
pjsip_tx_data_get_info(tdata)));
659
return PJSIP_EPENDINGTX;
662
/* Add reference to prevent deletion, and to cancel idle timer if
665
pjsip_transport_add_ref(tr);
667
/* Fill in tp_info. */
668
tdata->tp_info.transport = tr;
669
pj_memcpy(&tdata->tp_info.dst_addr, addr, addr_len);
670
tdata->tp_info.dst_addr_len = addr_len;
672
pj_inet_ntop(((pj_sockaddr*)addr)->addr.sa_family,
673
pj_sockaddr_get_addr(addr),
674
tdata->tp_info.dst_name,
675
sizeof(tdata->tp_info.dst_name));
676
tdata->tp_info.dst_port = pj_sockaddr_get_port(addr);
678
/* Distribute to modules.
679
* When the message reach mod_msg_print, the contents of the message will
680
* be "printed" to contiguous buffer.
682
if (tr->tpmgr->on_tx_msg) {
683
status = (*tr->tpmgr->on_tx_msg)(tr->endpt, tdata);
684
if (status != PJ_SUCCESS) {
685
pjsip_transport_dec_ref(tr);
690
/* Save callback data. */
691
tdata->token = token;
694
/* Add reference counter. */
695
pjsip_tx_data_add_ref(tdata);
697
/* Mark as pending. */
698
tdata->is_pending = 1;
700
/* Send to transport. */
701
status = (*tr->send_msg)(tr, tdata, addr, addr_len, (void*)tdata,
702
&transport_send_callback);
704
if (status != PJ_EPENDING) {
705
tdata->is_pending = 0;
706
pjsip_tx_data_dec_ref(tdata);
709
pjsip_transport_dec_ref(tr);
714
/* send_raw() callback */
715
static void send_raw_callback(pjsip_transport *transport,
719
pjsip_tx_data *tdata = (pjsip_tx_data*) token;
721
/* Mark pending off so that app can resend/reuse txdata from inside
724
tdata->is_pending = 0;
726
/* Call callback, if any. */
728
(*tdata->cb)(tdata->token, tdata, size);
731
/* Decrement tdata reference count. */
732
pjsip_tx_data_dec_ref(tdata);
734
/* Decrement transport reference count */
735
pjsip_transport_dec_ref(transport);
740
PJ_DEF(pj_status_t) pjsip_tpmgr_send_raw(pjsip_tpmgr *mgr,
741
pjsip_transport_type_e tp_type,
742
const pjsip_tpselector *sel,
743
pjsip_tx_data *tdata,
744
const void *raw_data,
746
const pj_sockaddr_t *addr,
749
pjsip_tp_send_callback cb)
754
/* Acquire the transport */
755
status = pjsip_tpmgr_acquire_transport(mgr, tp_type, addr, addr_len,
757
if (status != PJ_SUCCESS)
760
/* Create transmit data buffer if one is not specified */
762
status = pjsip_endpt_create_tdata(tr->endpt, &tdata);
763
if (status != PJ_SUCCESS) {
764
pjsip_transport_dec_ref(tr);
770
/* Add reference counter. */
771
pjsip_tx_data_add_ref(tdata);
774
/* Allocate buffer */
775
if (tdata->buf.start == NULL ||
776
(tdata->buf.end - tdata->buf.start) < (int)data_len)
778
/* Note: data_len may be zero, so allocate +1 */
779
tdata->buf.start = (char*) pj_pool_alloc(tdata->pool, data_len+1);
780
tdata->buf.end = tdata->buf.start + data_len + 1;
783
/* Copy data, if any! (application may send zero len packet) */
785
pj_memcpy(tdata->buf.start, raw_data, data_len);
787
tdata->buf.cur = tdata->buf.start + data_len;
789
/* Save callback data. */
790
tdata->token = token;
793
/* Mark as pending. */
794
tdata->is_pending = 1;
796
/* Send to transport */
797
status = tr->send_msg(tr, tdata, addr, addr_len,
798
tdata, &send_raw_callback);
800
if (status != PJ_EPENDING) {
801
/* callback will not be called, so destroy tdata now. */
802
pjsip_tx_data_dec_ref(tdata);
803
pjsip_transport_dec_ref(tr);
810
static void transport_idle_callback(pj_timer_heap_t *timer_heap,
811
struct pj_timer_entry *entry)
813
pjsip_transport *tp = (pjsip_transport*) entry->user_data;
814
pj_assert(tp != NULL);
816
PJ_UNUSED_ARG(timer_heap);
818
entry->id = PJ_FALSE;
819
pjsip_transport_destroy(tp);
825
PJ_DEF(pj_status_t) pjsip_transport_add_ref( pjsip_transport *tp )
827
PJ_ASSERT_RETURN(tp != NULL, PJ_EINVAL);
829
if (pj_atomic_inc_and_get(tp->ref_cnt) == 1) {
830
pj_lock_acquire(tp->tpmgr->lock);
832
if (pj_atomic_get(tp->ref_cnt) == 1) {
833
if (tp->idle_timer.id != PJ_FALSE) {
834
pjsip_endpt_cancel_timer(tp->tpmgr->endpt, &tp->idle_timer);
835
tp->idle_timer.id = PJ_FALSE;
838
pj_lock_release(tp->tpmgr->lock);
847
PJ_DEF(pj_status_t) pjsip_transport_dec_ref( pjsip_transport *tp )
849
PJ_ASSERT_RETURN(tp != NULL, PJ_EINVAL);
851
pj_assert(pj_atomic_get(tp->ref_cnt) > 0);
853
if (pj_atomic_dec_and_get(tp->ref_cnt) == 0) {
854
pj_lock_acquire(tp->tpmgr->lock);
855
/* Verify again. Do not register timer if the transport is
858
if (pj_atomic_get(tp->ref_cnt) == 0 && !tp->is_destroying) {
861
/* If transport is in graceful shutdown, then this is the
862
* last user who uses the transport. Schedule to destroy the
863
* transport immediately. Otherwise schedule idle timer.
865
if (tp->is_shutdown) {
866
delay.sec = delay.msec = 0;
868
delay.sec = (tp->dir==PJSIP_TP_DIR_OUTGOING) ?
869
PJSIP_TRANSPORT_IDLE_TIME :
870
PJSIP_TRANSPORT_SERVER_IDLE_TIME;
874
pj_assert(tp->idle_timer.id == 0);
875
tp->idle_timer.id = PJ_TRUE;
876
pjsip_endpt_schedule_timer(tp->tpmgr->endpt, &tp->idle_timer,
879
pj_lock_release(tp->tpmgr->lock);
887
* Register a transport.
889
PJ_DEF(pj_status_t) pjsip_transport_register( pjsip_tpmgr *mgr,
890
pjsip_transport *tp )
898
pj_bzero(&tp->idle_timer, sizeof(tp->idle_timer));
899
tp->idle_timer.user_data = tp;
900
tp->idle_timer.cb = &transport_idle_callback;
903
* Register to hash table (see Trac ticket #42).
905
key_len = sizeof(tp->key.type) + tp->addr_len;
906
pj_lock_acquire(mgr->lock);
908
/* If entry already occupied, unregister previous entry */
910
entry = pj_hash_get(mgr->table, &tp->key, key_len, &hval);
912
pj_hash_set(NULL, mgr->table, &tp->key, key_len, hval, NULL);
914
/* Register new entry */
915
pj_hash_set(tp->pool, mgr->table, &tp->key, key_len, hval, tp);
917
pj_lock_release(mgr->lock);
919
TRACE_((THIS_FILE,"Transport %s registered: type=%s, remote=%s:%d",
921
pjsip_transport_get_type_name(tp->key.type),
922
addr_string(&tp->key.rem_addr),
923
pj_sockaddr_get_port(&tp->key.rem_addr)));
928
/* Force destroy transport (e.g. during transport manager shutdown. */
929
static pj_status_t destroy_transport( pjsip_tpmgr *mgr,
930
pjsip_transport *tp )
936
TRACE_((THIS_FILE, "Transport %s is being destroyed", tp->obj_name));
938
pj_lock_acquire(tp->lock);
939
pj_lock_acquire(mgr->lock);
941
tp->is_destroying = PJ_TRUE;
944
* Unregister timer, if any.
946
//pj_assert(tp->idle_timer.id == PJ_FALSE);
947
if (tp->idle_timer.id != PJ_FALSE) {
948
pjsip_endpt_cancel_timer(mgr->endpt, &tp->idle_timer);
949
tp->idle_timer.id = PJ_FALSE;
953
* Unregister from hash table (see Trac ticket #42).
955
key_len = sizeof(tp->key.type) + tp->addr_len;
957
entry = pj_hash_get(mgr->table, &tp->key, key_len, &hval);
958
if (entry == (void*)tp)
959
pj_hash_set(NULL, mgr->table, &tp->key, key_len, hval, NULL);
961
pj_lock_release(mgr->lock);
964
return tp->destroy(tp);
969
* Start graceful shutdown procedure for this transport.
971
PJ_DEF(pj_status_t) pjsip_transport_shutdown(pjsip_transport *tp)
976
TRACE_((THIS_FILE, "Transport %s shutting down", tp->obj_name));
978
pj_lock_acquire(tp->lock);
981
pj_lock_acquire(mgr->lock);
983
/* Do nothing if transport is being shutdown already */
984
if (tp->is_shutdown) {
985
pj_lock_release(tp->lock);
986
pj_lock_release(mgr->lock);
992
/* Instruct transport to shutdown itself */
994
status = tp->do_shutdown(tp);
996
if (status == PJ_SUCCESS)
997
tp->is_shutdown = PJ_TRUE;
999
/* If transport reference count is zero, start timer count-down */
1000
if (pj_atomic_get(tp->ref_cnt) == 0) {
1001
pjsip_transport_add_ref(tp);
1002
pjsip_transport_dec_ref(tp);
1005
pj_lock_release(tp->lock);
1006
pj_lock_release(mgr->lock);
1013
* Unregister transport.
1015
PJ_DEF(pj_status_t) pjsip_transport_destroy( pjsip_transport *tp)
1017
/* Must have no user. */
1018
PJ_ASSERT_RETURN(pj_atomic_get(tp->ref_cnt) == 0, PJSIP_EBUSY);
1021
return destroy_transport(tp->tpmgr, tp);
1026
/*****************************************************************************
1030
*****************************************************************************/
1033
PJ_DEF(pj_status_t) pjsip_tpmgr_register_tpfactory( pjsip_tpmgr *mgr,
1034
pjsip_tpfactory *tpf)
1039
pj_lock_acquire(mgr->lock);
1041
/* Check that no factory with the same type has been registered. */
1042
status = PJ_SUCCESS;
1043
for (p=mgr->factory_list.next; p!=&mgr->factory_list; p=p->next) {
1044
if (p->type == tpf->type) {
1045
status = PJSIP_ETYPEEXISTS;
1049
status = PJ_EEXISTS;
1054
if (status != PJ_SUCCESS) {
1055
pj_lock_release(mgr->lock);
1059
pj_list_insert_before(&mgr->factory_list, tpf);
1061
pj_lock_release(mgr->lock);
1068
* Unregister factory.
1070
PJ_DEF(pj_status_t) pjsip_tpmgr_unregister_tpfactory( pjsip_tpmgr *mgr,
1071
pjsip_tpfactory *tpf)
1073
pj_lock_acquire(mgr->lock);
1075
pj_assert(pj_list_find_node(&mgr->factory_list, tpf) == tpf);
1078
pj_lock_release(mgr->lock);
1084
/*****************************************************************************
1088
*****************************************************************************/
1091
* Create a new transport manager.
1093
PJ_DEF(pj_status_t) pjsip_tpmgr_create( pj_pool_t *pool,
1094
pjsip_endpoint *endpt,
1095
pjsip_rx_callback rx_cb,
1096
pjsip_tx_callback tx_cb,
1097
pjsip_tpmgr **p_mgr)
1102
PJ_ASSERT_RETURN(pool && endpt && rx_cb && p_mgr, PJ_EINVAL);
1104
/* Register mod_msg_print module. */
1105
status = pjsip_endpt_register_module(endpt, &mod_msg_print);
1106
if (status != PJ_SUCCESS)
1109
/* Create and initialize transport manager. */
1110
mgr = PJ_POOL_ZALLOC_T(pool, pjsip_tpmgr);
1112
mgr->on_rx_msg = rx_cb;
1113
mgr->on_tx_msg = tx_cb;
1114
pj_list_init(&mgr->factory_list);
1116
mgr->table = pj_hash_create(pool, PJSIP_TPMGR_HTABLE_SIZE);
1120
status = pj_lock_create_recursive_mutex(pool, "tmgr%p", &mgr->lock);
1121
if (status != PJ_SUCCESS)
1124
#if defined(PJ_DEBUG) && PJ_DEBUG!=0
1125
status = pj_atomic_create(pool, 0, &mgr->tdata_counter);
1126
if (status != PJ_SUCCESS)
1130
/* Set transport state callback */
1131
status = pjsip_tpmgr_set_state_cb(mgr, &tp_state_callback);
1132
if (status != PJ_SUCCESS)
1135
PJ_LOG(5, (THIS_FILE, "Transport manager created."));
1144
* Find out the appropriate local address info (IP address and port) to
1145
* advertise in Contact header based on the remote address to be
1146
* contacted. The local address info would be the address name of the
1147
* transport or listener which will be used to send the request.
1149
* In this implementation, it will only select the transport based on
1150
* the transport type in the request.
1152
PJ_DEF(pj_status_t) pjsip_tpmgr_find_local_addr( pjsip_tpmgr *tpmgr,
1154
pjsip_transport_type_e type,
1155
const pjsip_tpselector *sel,
1159
pj_status_t status = PJSIP_EUNSUPTRANSPORT;
1163
PJ_ASSERT_RETURN(tpmgr && pool && ip_addr && port, PJ_EINVAL);
1168
flag = pjsip_transport_get_flag_from_type(type);
1170
if (sel && sel->type == PJSIP_TPSELECTOR_TRANSPORT &&
1173
pj_strdup(pool, ip_addr, &sel->u.transport->local_name.host);
1174
*port = sel->u.transport->local_name.port;
1175
status = PJ_SUCCESS;
1177
} else if (sel && sel->type == PJSIP_TPSELECTOR_LISTENER &&
1180
pj_strdup(pool, ip_addr, &sel->u.listener->addr_name.host);
1181
*port = sel->u.listener->addr_name.port;
1182
status = PJ_SUCCESS;
1184
} else if ((flag & PJSIP_TRANSPORT_DATAGRAM) != 0) {
1188
pjsip_transport *tp;
1190
pj_bzero(&remote, sizeof(remote));
1191
if (type & PJSIP_TRANSPORT_IPV6) {
1192
addr_len = sizeof(pj_sockaddr_in6);
1193
remote.addr.sa_family = pj_AF_INET6();
1195
addr_len = sizeof(pj_sockaddr_in);
1196
remote.addr.sa_family = pj_AF_INET();
1199
status = pjsip_tpmgr_acquire_transport(tpmgr, type, &remote,
1200
addr_len, NULL, &tp);
1202
if (status == PJ_SUCCESS) {
1203
pj_strdup(pool, ip_addr, &tp->local_name.host);
1204
*port = tp->local_name.port;
1205
status = PJ_SUCCESS;
1207
pjsip_transport_dec_ref(tp);
1211
/* For connection oriented transport, enum the factories */
1214
pj_lock_acquire(tpmgr->lock);
1216
f = tpmgr->factory_list.next;
1217
while (f != &tpmgr->factory_list) {
1218
if (f->type == type)
1223
if (f != &tpmgr->factory_list) {
1224
pj_strdup(pool, ip_addr, &f->addr_name.host);
1225
*port = f->addr_name.port;
1226
status = PJ_SUCCESS;
1228
pj_lock_release(tpmgr->lock);
1235
* Return number of transports currently registered to the transport
1238
PJ_DEF(unsigned) pjsip_tpmgr_get_transport_count(pjsip_tpmgr *mgr)
1240
pj_hash_iterator_t itr_val;
1241
pj_hash_iterator_t *itr;
1242
int nr_of_transports = 0;
1244
pj_lock_acquire(mgr->lock);
1246
itr = pj_hash_first(mgr->table, &itr_val);
1249
itr = pj_hash_next(mgr->table, itr);
1252
pj_lock_release(mgr->lock);
1254
return nr_of_transports;
1258
* pjsip_tpmgr_destroy()
1260
* Destroy transport manager.
1262
PJ_DEF(pj_status_t) pjsip_tpmgr_destroy( pjsip_tpmgr *mgr )
1264
pj_hash_iterator_t itr_val;
1265
pj_hash_iterator_t *itr;
1266
pjsip_tpfactory *factory;
1267
pjsip_endpoint *endpt = mgr->endpt;
1269
PJ_LOG(5, (THIS_FILE, "Destroying transport manager"));
1271
pj_lock_acquire(mgr->lock);
1274
* Destroy all transports.
1276
itr = pj_hash_first(mgr->table, &itr_val);
1277
while (itr != NULL) {
1278
pj_hash_iterator_t *next;
1279
pjsip_transport *transport;
1281
transport = (pjsip_transport*) pj_hash_this(mgr->table, itr);
1283
next = pj_hash_next(mgr->table, itr);
1285
destroy_transport(mgr, transport);
1291
* Destroy all factories/listeners.
1293
factory = mgr->factory_list.next;
1294
while (factory != &mgr->factory_list) {
1295
pjsip_tpfactory *next = factory->next;
1297
factory->destroy(factory);
1302
pj_lock_release(mgr->lock);
1303
pj_lock_destroy(mgr->lock);
1305
/* Unregister mod_msg_print. */
1306
if (mod_msg_print.id != -1) {
1307
pjsip_endpt_unregister_module(endpt, &mod_msg_print);
1310
#if defined(PJ_DEBUG) && PJ_DEBUG!=0
1311
/* If you encounter assert error on this line, it means there are
1312
* leakings in transmit data (i.e. some transmit data have not been
1315
//pj_assert(pj_atomic_get(mgr->tdata_counter) == 0);
1316
if (pj_atomic_get(mgr->tdata_counter) != 0) {
1317
PJ_LOG(3,(THIS_FILE, "Warning: %d transmit buffer(s) not freed!",
1318
pj_atomic_get(mgr->tdata_counter)));
1327
* pjsip_tpmgr_receive_packet()
1329
* Called by tranports when they receive a new packet.
1331
PJ_DEF(pj_ssize_t) pjsip_tpmgr_receive_packet( pjsip_tpmgr *mgr,
1332
pjsip_rx_data *rdata)
1334
pjsip_transport *tr = rdata->tp_info.transport;
1337
pj_size_t remaining_len;
1338
pj_size_t total_processed = 0;
1341
pj_assert(rdata->pkt_info.len > 0);
1342
if (rdata->pkt_info.len <= 0)
1345
current_pkt = rdata->pkt_info.packet;
1346
remaining_len = rdata->pkt_info.len;
1348
/* Must NULL terminate buffer. This is the requirement of the
1351
current_pkt[remaining_len] = '\0';
1353
/* Process all message fragments. */
1354
while (remaining_len > 0) {
1359
pj_size_t msg_fragment_size;
1361
/* Skip leading newlines as pjsip_find_msg() currently can't
1362
* handle leading newlines.
1364
for (p=current_pkt, end=p+remaining_len; p!=end; ++p) {
1365
if (*p != '\r' && *p != '\n')
1368
if (p!=current_pkt) {
1369
remaining_len -= (p - current_pkt);
1370
total_processed += (p - current_pkt);
1372
if (remaining_len == 0) {
1373
return total_processed;
1377
/* Initialize default fragment size. */
1378
msg_fragment_size = remaining_len;
1380
/* Clear and init msg_info in rdata.
1381
* Endpoint might inspect the values there when we call the callback
1382
* to report some errors.
1384
pj_bzero(&rdata->msg_info, sizeof(rdata->msg_info));
1385
pj_list_init(&rdata->msg_info.parse_err);
1386
rdata->msg_info.msg_buf = current_pkt;
1387
rdata->msg_info.len = remaining_len;
1389
/* For TCP transport, check if the whole message has been received. */
1390
if ((tr->flag & PJSIP_TRANSPORT_DATAGRAM) == 0) {
1391
pj_status_t msg_status;
1392
msg_status = pjsip_find_msg(current_pkt, remaining_len, PJ_FALSE,
1393
&msg_fragment_size);
1394
if (msg_status != PJ_SUCCESS) {
1395
if (remaining_len == PJSIP_MAX_PKT_LEN) {
1396
mgr->on_rx_msg(mgr->endpt, PJSIP_ERXOVERFLOW, rdata);
1397
/* Exhaust all data. */
1398
return rdata->pkt_info.len;
1400
/* Not enough data in packet. */
1401
return total_processed;
1406
/* Update msg_info. */
1407
rdata->msg_info.len = msg_fragment_size;
1409
/* Null terminate packet */
1410
saved = current_pkt[msg_fragment_size];
1411
current_pkt[msg_fragment_size] = '\0';
1413
/* Parse the message. */
1414
rdata->msg_info.msg = msg =
1415
pjsip_parse_rdata( current_pkt, msg_fragment_size, rdata);
1417
/* Restore null termination */
1418
current_pkt[msg_fragment_size] = saved;
1420
/* Check for parsing syntax error */
1421
if (msg==NULL || !pj_list_empty(&rdata->msg_info.parse_err)) {
1422
pjsip_parser_err_report *err;
1426
/* Gather syntax error information */
1427
tmp.ptr = buf; tmp.slen = 0;
1428
err = rdata->msg_info.parse_err.next;
1429
while (err != &rdata->msg_info.parse_err) {
1431
len = pj_ansi_snprintf(tmp.ptr+tmp.slen, sizeof(buf)-tmp.slen,
1432
": %s exception when parsing '%.*s' "
1433
"header on line %d col %d",
1434
pj_exception_id_name(err->except_code),
1435
(int)err->hname.slen, err->hname.ptr,
1436
err->line, err->col);
1437
if (len > 0 && len < (int) (sizeof(buf)-tmp.slen)) {
1443
/* Only print error message if there's error.
1444
* Sometimes we receive blank packets (packets with only CRLF)
1445
* which were sent to keep NAT bindings.
1448
PJ_LOG(1, (THIS_FILE,
1449
"Error processing %d bytes packet from %s %s:%d %.*s:\n"
1451
"-- end of packet.",
1453
rdata->tp_info.transport->type_name,
1454
rdata->pkt_info.src_name,
1455
rdata->pkt_info.src_port,
1456
(int)tmp.slen, tmp.ptr,
1457
(int)msg_fragment_size,
1458
rdata->msg_info.msg_buf));
1461
goto finish_process_fragment;
1464
/* Perform basic header checking. */
1465
if (rdata->msg_info.cid == NULL ||
1466
rdata->msg_info.cid->id.slen == 0 ||
1467
rdata->msg_info.from == NULL ||
1468
rdata->msg_info.to == NULL ||
1469
rdata->msg_info.via == NULL ||
1470
rdata->msg_info.cseq == NULL)
1472
mgr->on_rx_msg(mgr->endpt, PJSIP_EMISSINGHDR, rdata);
1473
goto finish_process_fragment;
1477
if (rdata->msg_info.msg->type == PJSIP_REQUEST_MSG) {
1478
/* always add received parameter to the via. */
1479
pj_strdup2(rdata->tp_info.pool,
1480
&rdata->msg_info.via->recvd_param,
1481
rdata->pkt_info.src_name);
1484
* If message contains "rport" param, put the received port there.
1486
if (rdata->msg_info.via->rport_param == 0) {
1487
rdata->msg_info.via->rport_param = rdata->pkt_info.src_port;
1490
/* Drop malformed responses */
1491
if (rdata->msg_info.msg->line.status.code < 100 ||
1492
rdata->msg_info.msg->line.status.code >= 700)
1494
mgr->on_rx_msg(mgr->endpt, PJSIP_EINVALIDSTATUS, rdata);
1495
goto finish_process_fragment;
1499
/* Drop response message if it has more than one Via.
1501
/* This is wrong. Proxy DOES receive responses with multiple
1502
* Via headers! Thanks Aldo <acampi at deis.unibo.it> for pointing
1505
if (msg->type == PJSIP_RESPONSE_MSG) {
1507
hdr = (pjsip_hdr*)rdata->msg_info.via->next;
1508
if (hdr != &msg->hdr) {
1509
hdr = pjsip_msg_find_hdr(msg, PJSIP_H_VIA, hdr);
1511
mgr->on_rx_msg(mgr->endpt, PJSIP_EMULTIPLEVIA, rdata);
1512
goto finish_process_fragment;
1518
/* Call the transport manager's upstream message callback.
1520
mgr->on_rx_msg(mgr->endpt, PJ_SUCCESS, rdata);
1523
finish_process_fragment:
1524
total_processed += msg_fragment_size;
1525
current_pkt += msg_fragment_size;
1526
remaining_len -= msg_fragment_size;
1528
} /* while (rdata->pkt_info.len > 0) */
1531
return total_processed;
1536
* pjsip_tpmgr_acquire_transport()
1538
* Get transport suitable to communicate to remote. Create a new one
1541
PJ_DEF(pj_status_t) pjsip_tpmgr_acquire_transport(pjsip_tpmgr *mgr,
1542
pjsip_transport_type_e type,
1543
const pj_sockaddr_t *remote,
1545
const pjsip_tpselector *sel,
1546
pjsip_transport **tp)
1548
return pjsip_tpmgr_acquire_transport2(mgr, type, remote, addr_len, sel,
1553
* pjsip_tpmgr_acquire_transport2()
1555
* Get transport suitable to communicate to remote. Create a new one
1558
PJ_DEF(pj_status_t) pjsip_tpmgr_acquire_transport2(pjsip_tpmgr *mgr,
1559
pjsip_transport_type_e type,
1560
const pj_sockaddr_t *remote,
1562
const pjsip_tpselector *sel,
1563
pjsip_tx_data *tdata,
1564
pjsip_transport **tp)
1566
pjsip_tpfactory *factory;
1569
TRACE_((THIS_FILE,"Acquiring transport type=%s, remote=%s:%d",
1570
pjsip_transport_get_type_name(type),
1571
addr_string(remote),
1572
pj_sockaddr_get_port(remote)));
1574
pj_lock_acquire(mgr->lock);
1576
/* If transport is specified, then just use it if it is suitable
1577
* for the destination.
1579
if (sel && sel->type == PJSIP_TPSELECTOR_TRANSPORT &&
1582
pjsip_transport *seltp = sel->u.transport;
1584
/* See if the transport is (not) suitable */
1585
if (seltp->key.type != type) {
1586
pj_lock_release(mgr->lock);
1587
return PJSIP_ETPNOTSUITABLE;
1590
/* We could also verify that the destination address is reachable
1591
* from this transport (i.e. both are equal), but if application
1592
* has requested a specific transport to be used, assume that
1593
* it knows what to do.
1595
* In other words, I don't think destination verification is a good
1599
/* Transport looks to be suitable to use, so just use it. */
1600
pjsip_transport_add_ref(seltp);
1601
pj_lock_release(mgr->lock);
1604
TRACE_((THIS_FILE, "Transport %s acquired", seltp->obj_name));
1608
} else if (sel && sel->type == PJSIP_TPSELECTOR_LISTENER &&
1611
/* Application has requested that a specific listener is to
1612
* be used. In this case, skip transport hash table lookup.
1615
/* Verify that the listener type matches the destination type */
1616
if (sel->u.listener->type != type) {
1617
pj_lock_release(mgr->lock);
1618
return PJSIP_ETPNOTSUITABLE;
1621
/* We'll use this listener to create transport */
1622
factory = sel->u.listener;
1627
* This is the "normal" flow, where application doesn't specify
1628
* specific transport/listener to be used to send message to.
1629
* In this case, lookup the transport from the hash table.
1631
pjsip_transport_key key;
1633
pjsip_transport *transport;
1635
pj_bzero(&key, sizeof(key));
1636
key_len = sizeof(key.type) + addr_len;
1638
/* First try to get exact destination. */
1640
pj_memcpy(&key.rem_addr, remote, addr_len);
1642
transport = (pjsip_transport*)
1643
pj_hash_get(mgr->table, &key, key_len, NULL);
1645
if (transport == NULL) {
1646
unsigned flag = pjsip_transport_get_flag_from_type(type);
1647
const pj_sockaddr *remote_addr = (const pj_sockaddr*)remote;
1650
/* Ignore address for loop transports. */
1651
if (type == PJSIP_TRANSPORT_LOOP ||
1652
type == PJSIP_TRANSPORT_LOOP_DGRAM)
1654
pj_sockaddr *addr = &key.rem_addr;
1656
pj_bzero(addr, addr_len);
1657
key_len = sizeof(key.type) + addr_len;
1658
transport = (pjsip_transport*)
1659
pj_hash_get(mgr->table, &key, key_len, NULL);
1661
/* For datagram transports, try lookup with zero address.
1663
else if (flag & PJSIP_TRANSPORT_DATAGRAM)
1665
pj_sockaddr *addr = &key.rem_addr;
1667
pj_bzero(addr, addr_len);
1668
addr->addr.sa_family = remote_addr->addr.sa_family;
1670
key_len = sizeof(key.type) + addr_len;
1671
transport = (pjsip_transport*)
1672
pj_hash_get(mgr->table, &key, key_len, NULL);
1676
if (transport!=NULL && !transport->is_shutdown) {
1680
pjsip_transport_add_ref(transport);
1681
pj_lock_release(mgr->lock);
1684
TRACE_((THIS_FILE, "Transport %s acquired", transport->obj_name));
1689
* Transport not found!
1690
* Find factory that can create such transport.
1692
factory = mgr->factory_list.next;
1693
while (factory != &mgr->factory_list) {
1694
if (factory->type == type)
1696
factory = factory->next;
1699
if (factory == &mgr->factory_list) {
1700
/* No factory can create the transport! */
1701
pj_lock_release(mgr->lock);
1702
TRACE_((THIS_FILE, "No suitable factory was found either"));
1703
return PJSIP_EUNSUPTRANSPORT;
1707
TRACE_((THIS_FILE, "Creating new transport from factory"));
1709
/* Request factory to create transport. */
1710
if (factory->create_transport2) {
1711
status = factory->create_transport2(factory, mgr, mgr->endpt,
1712
(const pj_sockaddr*) remote,
1713
addr_len, tdata, tp);
1715
status = factory->create_transport(factory, mgr, mgr->endpt,
1716
(const pj_sockaddr*) remote,
1719
if (status == PJ_SUCCESS) {
1720
PJ_ASSERT_ON_FAIL(tp!=NULL,
1721
{pj_lock_release(mgr->lock); return PJ_EBUG;});
1722
pjsip_transport_add_ref(*tp);
1724
pj_lock_release(mgr->lock);
1729
* Dump transport info.
1731
PJ_DEF(void) pjsip_tpmgr_dump_transports(pjsip_tpmgr *mgr)
1733
#if PJ_LOG_MAX_LEVEL >= 3
1734
pj_hash_iterator_t itr_val;
1735
pj_hash_iterator_t *itr;
1736
pjsip_tpfactory *factory;
1738
pj_lock_acquire(mgr->lock);
1740
#if defined(PJ_DEBUG) && PJ_DEBUG!=0
1741
PJ_LOG(3,(THIS_FILE, " Outstanding transmit buffers: %d",
1742
pj_atomic_get(mgr->tdata_counter)));
1745
PJ_LOG(3, (THIS_FILE, " Dumping listeners:"));
1746
factory = mgr->factory_list.next;
1747
while (factory != &mgr->factory_list) {
1748
PJ_LOG(3, (THIS_FILE, " %s %s:%.*s:%d",
1751
(int)factory->addr_name.host.slen,
1752
factory->addr_name.host.ptr,
1753
(int)factory->addr_name.port));
1754
factory = factory->next;
1757
itr = pj_hash_first(mgr->table, &itr_val);
1759
PJ_LOG(3, (THIS_FILE, " Dumping transports:"));
1762
pjsip_transport *t = (pjsip_transport*)
1763
pj_hash_this(mgr->table, itr);
1765
PJ_LOG(3, (THIS_FILE, " %s %s (refcnt=%d%s)",
1768
pj_atomic_get(t->ref_cnt),
1769
(t->idle_timer.id ? " [idle]" : "")));
1771
itr = pj_hash_next(mgr->table, itr);
1775
pj_lock_release(mgr->lock);
1782
* Set callback of global transport state notification.
1784
PJ_DEF(pj_status_t) pjsip_tpmgr_set_state_cb(pjsip_tpmgr *mgr,
1785
pjsip_tp_state_callback cb)
1787
PJ_ASSERT_RETURN(mgr, PJ_EINVAL);
1789
mgr->tp_state_cb = cb;
1795
* Get callback of global transport state notification.
1797
PJ_DEF(pjsip_tp_state_callback) pjsip_tpmgr_get_state_cb(
1798
const pjsip_tpmgr *mgr)
1800
PJ_ASSERT_RETURN(mgr, NULL);
1802
return mgr->tp_state_cb;
1807
* Allocate and init transport data.
1809
static void init_tp_data(pjsip_transport *tp)
1811
transport_data *tp_data;
1813
pj_assert(tp && !tp->data);
1815
tp_data = PJ_POOL_ZALLOC_T(tp->pool, transport_data);
1816
pj_list_init(&tp_data->st_listeners);
1817
pj_list_init(&tp_data->st_listeners_empty);
1822
static void tp_state_callback(pjsip_transport *tp,
1823
pjsip_transport_state state,
1824
const pjsip_transport_state_info *info)
1826
transport_data *tp_data;
1828
pj_lock_acquire(tp->lock);
1830
tp_data = (transport_data*)tp->data;
1832
/* Notify the transport state listeners, if any. */
1833
if (!tp_data || pj_list_empty(&tp_data->st_listeners)) {
1836
pjsip_transport_state_info st_info;
1837
tp_state_listener *st_listener = tp_data->st_listeners.next;
1839
/* As we need to put the user data into the transport state info,
1840
* let's use a copy of transport state info.
1842
pj_memcpy(&st_info, info, sizeof(st_info));
1843
while (st_listener != &tp_data->st_listeners) {
1844
st_info.user_data = st_listener->user_data;
1845
(*st_listener->cb)(tp, state, &st_info);
1847
st_listener = st_listener->next;
1852
pj_lock_release(tp->lock);
1857
* Add a listener to the specified transport for transport state notification.
1859
PJ_DEF(pj_status_t) pjsip_transport_add_state_listener (
1860
pjsip_transport *tp,
1861
pjsip_tp_state_callback cb,
1863
pjsip_tp_state_listener_key **key)
1865
transport_data *tp_data;
1866
tp_state_listener *entry;
1868
PJ_ASSERT_RETURN(tp && cb && key, PJ_EINVAL);
1870
pj_lock_acquire(tp->lock);
1872
/* Init transport data, if it hasn't */
1876
tp_data = (transport_data*)tp->data;
1878
/* Init the new listener entry. Use available empty slot, if any,
1879
* otherwise allocate it using the transport pool.
1881
if (!pj_list_empty(&tp_data->st_listeners_empty)) {
1882
entry = tp_data->st_listeners_empty.next;
1883
pj_list_erase(entry);
1885
entry = PJ_POOL_ZALLOC_T(tp->pool, tp_state_listener);
1888
entry->user_data = user_data;
1890
/* Add the new listener entry to the listeners list */
1891
pj_list_push_back(&tp_data->st_listeners, entry);
1895
pj_lock_release(tp->lock);
1901
* Remove a listener from the specified transport for transport state
1904
PJ_DEF(pj_status_t) pjsip_transport_remove_state_listener (
1905
pjsip_transport *tp,
1906
pjsip_tp_state_listener_key *key,
1907
const void *user_data)
1909
transport_data *tp_data;
1910
tp_state_listener *entry;
1912
PJ_ASSERT_RETURN(tp && key, PJ_EINVAL);
1914
pj_lock_acquire(tp->lock);
1916
tp_data = (transport_data*)tp->data;
1918
/* Transport data is NULL or no registered listener? */
1919
if (!tp_data || pj_list_empty(&tp_data->st_listeners)) {
1920
pj_lock_release(tp->lock);
1921
return PJ_ENOTFOUND;
1924
entry = (tp_state_listener*)key;
1926
/* Validate the user data */
1927
if (entry->user_data != user_data) {
1928
pj_assert(!"Invalid transport state listener key");
1929
pj_lock_release(tp->lock);
1933
/* Reset the entry and move it to the empty list */
1935
entry->user_data = NULL;
1936
pj_list_erase(entry);
1937
pj_list_push_back(&tp_data->st_listeners_empty, entry);
1939
pj_lock_release(tp->lock);