doubango/tinyBFCP/src/tbfcp_session.c
c732d49e
 #if HAVE_CRT
 #define _CRTDBG_MAP_ALLOC 
 #include <stdlib.h> 
 #include <crtdbg.h>
 #endif //HAVE_CRT
 /*
74ca6d11
 * Copyright (C) 2020, University of the Basque Country (UPV/EHU)
c732d49e
 * Contact for licensing options: <licensing-mcpttclient(at)mcopenplatform(dot)com>
 *
 * The original file was part of Open Source Doubango Framework
 * Copyright (C) 2010-2011 Mamadou Diop.
 * Copyright (C) 2012 Doubango Telecom <http://doubango.org>
 *
 * This file is part of Open Source Doubango Framework.
 *
 * DOUBANGO 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 3 of the License, or
 * (at your option) any later version.
 *
 * DOUBANGO 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 DOUBANGO.
 *
 */
 
 #include "tinybfcp/tbfcp_session.h"
 #include "tinybfcp/tbfcp_pkt.h"
 #include "tinybfcp/tbfcp_utils.h"
 
 #include "tsk_time.h"
 #include "tsk_timer.h"
 #include "tsk_object.h"
 #include "tsk_memory.h"
 #include "tsk_safeobj.h"
 #include "tsk_debug.h"
 
 typedef struct tbfcp_udp_pkt_s {
 	TSK_DECLARE_OBJECT;
 	struct {
 		tsk_timer_id_t u_id;
 		uint64_t u_timeout;
 	} timer;
 	tbfcp_pkt_t *p_pkt;
 } tbfcp_udp_pkt_t;
 typedef tsk_list_t tbfcp_udp_pkts_L_t;
 
 typedef struct tbfcp_session_s {
     TSK_DECLARE_OBJECT;
 
     tsk_bool_t b_started;
     tsk_bool_t b_stopping;
     tsk_bool_t b_prepared;
 
 	tbfcp_udp_pkts_L_t *p_list_udp_pkts;
 
 	struct {
 		tbfcp_session_callback_f f_fun;
 		struct tbfcp_session_event_xs e;
 	} cb;
 
 	// Values received from the server in the 200 OK. Attributes from rfc4583
 	struct {
 		uint32_t u_conf_id;
 		uint16_t u_user_id;
 		uint16_t u_floor_id;
 	} 
 	conf_ids;
 
 	enum tbfcp_role_e e_role_local;
 	enum tbfcp_role_e e_role_remote;
 
 	enum tbfcp_setup_e e_setup_local;
 	enum tbfcp_setup_e e_setup_remote;
 
     enum tnet_socket_type_e e_socket_type;
     char* p_local_ip;
     tnet_port_t u_local_port;
 
     char* p_local_public_ip;
     tnet_port_t u_local_public_port;
 
     char* p_remote_ip;
     tnet_port_t u_remote_port;
     struct sockaddr_storage remote_addr;
 
 	struct tnet_nat_ctx_s* p_natt_ctx;
     struct tnet_ice_ctx_s* p_ice_ctx;
     struct tnet_transport_s* p_transport;
 
     uint8_t* p_buff_send_ptr;
     tsk_size_t u_buff_send_size;
 
     struct {
         tsk_timer_manager_handle_t* ph_global;
         tsk_timer_id_t id_T1; // For UDP only
         uint64_t u_timeout_T1;
         tsk_timer_id_t id_T2; // For UDP only
         uint64_t u_timeout_T2;
         tsk_timer_id_t id_TcpReconnect; // For TCP/TLS only
         uint64_t u_timeout_TcpReconnect;
     } timer;
 
     TSK_DECLARE_SAFEOBJ;
 } tbfcp_session_t;
 
 typedef enum _bfcp_timer_type_e {
     _bfcp_timer_type_T1, // draft-ietf-bfcpbis-rfc4582bis-11 - 4.16.  Timer Values (8.3.3) - Initial request retransmission timer (0.5s)
     _bfcp_timer_type_T2, // draft-ietf-bfcpbis-rfc4582bis-11 - 4.16.  Timer Values (8.3.3) - Response retransmission timer (10s)
     _bfcp_timer_type_TcpReconnect, // Try to reconnect the TCP/TLS socket every X seconds if unexpectedly disconnected
 }
 _bfcp_timer_type_t;
 
 static int _tbfcp_udp_pkt_create(const tbfcp_pkt_t *pc_pkt, tbfcp_udp_pkt_t** pp_pkt);
 
 static int _tbfcp_session_send_pkt(tbfcp_session_t* p_self, const tbfcp_pkt_t* pc_pkt);
 static int _tbfcp_session_send_Hello(struct tbfcp_session_s* p_self);
 static int _tbfcp_session_send_HelloAck(struct tbfcp_session_s* p_self, const tbfcp_pkt_t *pc_hello);
 static int _tbfcp_session_send_FloorRequest(struct tbfcp_session_s* p_self);
 static int _tbfcp_session_process_incoming_pkt(struct tbfcp_session_s* p_self, const tbfcp_pkt_t *pc_pkt);
 static int _tbfcp_session_socket_type_make_valid(enum tnet_socket_type_e e_in_st, enum tnet_socket_type_e *pe_out_st);
 static int _tbfcp_session_timer_callback(const void* pc_arg, tsk_timer_id_t timer_id);
 static int _tbfcp_session_timer_schedule(struct tbfcp_session_s* p_self, _bfcp_timer_type_t e_timer, uint64_t u_timeout);
 static int _tbfcp_session_transport_layer_dgram_cb(const tnet_transport_event_t* e);
 static int _tbfcp_session_transport_layer_stream_cb(const tnet_transport_event_t* e);
 
 #define _tbfcp_session_raise(_p_self, _e_type, _pc_pkt) \
 	if ((_p_self)->cb.f_fun) { \
 		(_p_self)->cb.e.e_type = (_e_type); \
 		(_p_self)->cb.e.pc_pkt = (_pc_pkt); \
 		(_p_self)->cb.f_fun(&_p_self->cb.e); \
 	}
 #define _tbfcp_session_raise_inf_inc_msg(_p_self, _pc_pkt) _tbfcp_session_raise(_p_self, tbfcp_session_event_type_inf_inc_msg, _pc_pkt)
 #define _tbfcp_session_raise_err_send_timedout(_p_self, _pc_pkt) _tbfcp_session_raise(_p_self, tbfcp_session_event_type_err_send_timedout, _pc_pkt)
 
 static int __pred_find_udp_pkt_by_timer(const tsk_list_item_t *item, const void *u64_id) {
 	if (item && item->data) {
 		return (int)(((const struct tbfcp_udp_pkt_s *)item->data)->timer.u_id - *((const uint64_t*)u64_id));
 	}
 	return -1;
 }
 static int __pred_find_udp_pkt_by_transac_id(const tsk_list_item_t *item, const void *u16_transac_id) {
 	if (item && item->data) {
 		return (int)(((const struct tbfcp_udp_pkt_s *)item->data)->p_pkt->hdr.transac_id - *((const uint16_t*)u16_transac_id));
 	}
 	return -1;
 }
 
 int tbfcp_session_create(tnet_socket_type_t e_socket_type, const char* pc_local_ip, tbfcp_session_t** pp_self)
 {
     extern const tsk_object_def_t *tbfcp_session_def_t;
     int ret;
     tnet_socket_type_t e_st;
     tbfcp_session_t* p_self;
 
     if (!pp_self) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
     if ((ret = _tbfcp_session_socket_type_make_valid(e_socket_type, &e_st))) {
         return ret;
     }
     if (!(p_self = tsk_object_new(tbfcp_session_def_t))) {
         TSK_DEBUG_ERROR("Failed to create 'tbfcp_session_def_t' object");
         return -2;
     }
     p_self->e_socket_type = e_st;
     tsk_strupdate(&p_self->p_local_ip, pc_local_ip);
     *pp_self = p_self;
     return 0;
 }
 
 int tbfcp_session_create_2(struct tnet_ice_ctx_s* p_ice_ctx, tbfcp_session_t** pp_self)
 {
     tnet_socket_type_t e_st;
     const char* pc_local_ip;
     int ret;
     if (!pp_self || !p_ice_ctx) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 
     // TODO: ICE expect RTP and RTCP comp-ids only
     TSK_DEBUG_ERROR("Not supported yet");
     return -2;
 
     // TODO: For now ICE works with UDP (and DTLS) only
     e_st = tnet_ice_ctx_use_ipv6(p_ice_ctx) ? tnet_socket_type_udp_ipv4 : tnet_socket_type_udp_ipv6;
     pc_local_ip = tnet_ice_ctx_use_ipv6(p_ice_ctx) ? "::1" : "127.0.0.1";
     if ((ret = _tbfcp_session_socket_type_make_valid(e_st, &e_st))) {
         return ret;
     }
     if ((ret = tbfcp_session_create(e_st, pc_local_ip, pp_self))) {
         return ret;
     }
     (*pp_self)->p_ice_ctx = tsk_object_ref(p_ice_ctx);
     return 0;
 }
 
 int tbfcp_session_set_callback(struct tbfcp_session_s* p_self, tbfcp_session_callback_f f_fun, const void* pc_usr_data)
 {
 	if (!p_self) {
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 	p_self->cb.f_fun = f_fun;
 	p_self->cb.e.pc_usr_data = pc_usr_data;
 	return 0;
 }
 
 int tbfcp_session_set_ice_ctx(tbfcp_session_t* p_self, struct tnet_ice_ctx_s* p_ice_ctx)
 {
     if (!p_self) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
     TSK_OBJECT_SAFE_FREE(p_self->p_ice_ctx);
     if (p_ice_ctx) {
         p_self->p_ice_ctx = tsk_object_ref(p_ice_ctx);
     }
     return 0;
 }
 
 int tbfcp_session_prepare(tbfcp_session_t* p_self)
 {
     int ret = 0;
     const char *bfcp_local_ip;
     tnet_port_t bfcp_local_port;
 
     if (!p_self) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 
     // lock()
     tsk_safeobj_lock(p_self);
 
     if (p_self->b_prepared) {
         TSK_DEBUG_INFO("BFCP session already prepared");
         goto bail;
     }
     if (p_self->p_transport) {
         TSK_DEBUG_ERROR("BFCP session already has a transport. Unexpected.");
         ret = -2;
         goto bail;
     }
 
     bfcp_local_ip = TNET_SOCKET_HOST_ANY;
     bfcp_local_port = TNET_SOCKET_PORT_ANY;
 
     /*if (p_self->p_ice_ctx) {
         // Get Sockets when the transport is started
         bfcp_local_ip = tnet_ice_ctx_use_ipv6(p_self->p_ice_ctx) ? "::1" : "127.0.0.1";
     }
     else*/ {
         // create transport
         if (!p_self->p_transport && !(p_self->p_transport = tnet_transport_create(p_self->p_local_ip, p_self->u_local_port, p_self->e_socket_type, kBfcpTransportFriendlyName))) {
             TSK_DEBUG_ERROR("Failed to create %s Transport", kBfcpTransportFriendlyName);
             return -3;
         }
         // set transport callback
 		if ((ret = tnet_transport_set_callback(p_self->p_transport, TNET_SOCKET_TYPE_IS_DGRAM(p_self->e_socket_type) ? _tbfcp_session_transport_layer_dgram_cb : _tbfcp_session_transport_layer_stream_cb, p_self))) {
             goto bail;
         }
         bfcp_local_ip = p_self->p_transport->master->ip;
         bfcp_local_port = p_self->p_transport->master->port;
     }
 
     tsk_strupdate(&p_self->p_local_public_ip, bfcp_local_ip);
     p_self->u_local_public_port = bfcp_local_port;
 
     p_self->b_prepared = tsk_true;
 
 bail:
     // unlock()
     tsk_safeobj_unlock(p_self);
     return ret;
 }
 
 int tbfcp_session_start(tbfcp_session_t* p_self)
 {
     int ret;
     if (!p_self) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 
     // lock()
     tsk_safeobj_lock(p_self);
 
     if (p_self->b_started) {
         TSK_DEBUG_INFO("BFCP session already started");
         ret = 0;
         goto bail;
     }
 
     if (!p_self->b_prepared) {
         TSK_DEBUG_ERROR("BFCP session not prepared yet");
         ret = -2;
         goto bail;
     }
 
     // start global timer manager - nothing will be done if already started by another component
     if ((ret = tsk_timer_manager_start(p_self->timer.ph_global))) {
         TSK_DEBUG_ERROR("Failed to start timer");
         goto bail;
     }
 
     // check remote IP address validity
     if ((tsk_striequals(p_self->p_remote_ip, "0.0.0.0") || tsk_striequals(p_self->p_remote_ip, "::"))) { // most likely loopback testing
         tnet_ip_t source = {0};
         tsk_bool_t updated = tsk_false;
         if (p_self->p_transport && p_self->p_transport->master) {
             updated = (tnet_getbestsource(p_self->p_transport->master->ip, p_self->p_transport->master->port, p_self->p_transport->master->type, &source) == 0);
         }
         // Not allowed to send data to "0.0.0.0"
         TSK_DEBUG_INFO("BFCP remote IP contains not allowed value ...changing to '%s'", updated ? source : "oops");
         if (updated) {
             tsk_strupdate(&p_self->p_remote_ip, source);
         }
     }
     // init remote remote addr
     if ((ret = tnet_sockaddr_init(p_self->p_remote_ip, p_self->u_remote_port, p_self->p_transport->master->type, &p_self->remote_addr))) {
         tnet_transport_shutdown(p_self->p_transport);
         TSK_OBJECT_SAFE_FREE(p_self->p_transport);
         TSK_DEBUG_ERROR("Invalid BFCP host:port [%s:%u]", p_self->p_remote_ip, p_self->u_remote_port);
         goto bail;
     }
 	if ((ret = tnet_transport_set_natt_ctx(p_self->p_transport, p_self->p_natt_ctx))) {
 		TSK_DEBUG_ERROR("Failed to start to set NATT ctx for the %s transport", kBfcpTransportFriendlyName);
 		goto bail;
 	}
 
     // start the transport
     if ((ret = tnet_transport_start(p_self->p_transport))) {
         TSK_DEBUG_ERROR("Failed to start the %s transport", kBfcpTransportFriendlyName);
         goto bail;
     }
 
     p_self->b_started = tsk_true;
 
 	// Send hello now if UDP/DTLS. Otherwise (TCP/TLS), wait for the connection to complete.
 	//if (TNET_SOCKET_TYPE_IS_DGRAM(p_self->e_socket_type)) {
 	//	if ((ret = _tbfcp_session_send_Hello(p_self))) {
 	//		goto bail;
 	//	}
 	//}
 
 bail:
     // unlock()
     tsk_safeobj_unlock(p_self);
     return ret;
 }
 
 int tbfcp_session_pause(tbfcp_session_t* p_self)
 {
 	int ret = 0;
     if (!p_self) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 
 	// lock()
     tsk_safeobj_lock(p_self);
 
 	goto bail;
 
 bail:
 	// unlock()
     tsk_safeobj_unlock(p_self);
     return ret;
 }
 
 int tbfcp_session_stop(tbfcp_session_t* p_self)
 {
     int ret = 0;
     if (!p_self) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 
 	// FIXME: send FloorRelease if a FloorRequest is pending
 
     // lock()
     tsk_safeobj_lock(p_self);
 
     // stop the session if not already done
     if (!p_self->b_started) {
         TSK_DEBUG_INFO("BFCP session already stopped");
         goto bail;
     }
 
 	// remove all pending udp packets
 	tsk_list_clear_items(p_self->p_list_udp_pkts);
 
     p_self->b_stopping = tsk_true;
     // this is a global timer shared by many components -> stopping it won't remove
     // all scheduled items as it could continue running if still used
     if (TSK_TIMER_ID_IS_VALID(p_self->timer.id_T1)) {
         tsk_timer_manager_cancel(p_self->timer.ph_global, p_self->timer.id_T1);
         p_self->timer.id_T1 = TSK_INVALID_TIMER_ID;
     }
     if (TSK_TIMER_ID_IS_VALID(p_self->timer.id_T2)) {
         tsk_timer_manager_cancel(p_self->timer.ph_global, p_self->timer.id_T2);
         p_self->timer.id_T2 = TSK_INVALID_TIMER_ID;
     }
     if (TSK_TIMER_ID_IS_VALID(p_self->timer.id_TcpReconnect)) {
         tsk_timer_manager_cancel(p_self->timer.ph_global, p_self->timer.id_TcpReconnect);
         p_self->timer.id_TcpReconnect = TSK_INVALID_TIMER_ID;
     }
 
     // free transport to force next call to start() to create new one with new sockets
     if (p_self->p_transport) {
         tnet_transport_shutdown(p_self->p_transport);
         TSK_OBJECT_SAFE_FREE(p_self->p_transport);
     }
 
     p_self->b_started = tsk_false;
     p_self->b_stopping = tsk_false;
 	p_self->b_prepared = tsk_false;
 
 bail:
     // unlock()
     tsk_safeobj_unlock(p_self);
     return ret;
 }
 
 int tbfcp_session_set_natt_ctx(tbfcp_session_t* p_self, struct tnet_nat_ctx_s* p_natt_ctx)
 {
 	if (!p_self) {
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 	TSK_OBJECT_SAFE_FREE(p_self->p_natt_ctx);
 	p_self->p_natt_ctx = tsk_object_ref(p_natt_ctx);
 	return 0;
 }
 
 int tbfcp_session_set_remote_address(tbfcp_session_t* p_self, const char* pc_ip, tnet_port_t u_port)
 {
     if (!p_self || !pc_ip /*|| u_port < 1024*/) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
     // if ICE is enabled then, these values will be updated when the session start()s and call ice_init()
     tsk_strupdate(&p_self->p_remote_ip, pc_ip);
     p_self->u_remote_port = u_port;
     return 0;
 }
 
 int tbfcp_session_set_remote_role(tbfcp_session_t* p_self, enum tbfcp_role_e e_role_remote)
 {
 	tsk_bool_t b_is_role_acceptable;
 	int ret;
 	if (!p_self) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 	if ((ret = tbfcp_utils_is_role_acceptable(p_self->e_role_local, e_role_remote, &b_is_role_acceptable))) {
 		return ret;
 	}
 	if (!b_is_role_acceptable) {
 		TSK_DEBUG_ERROR("%d not acceptable as remote role because local role = %d", e_role_remote, p_self->e_role_local);
 		return -2;
 	}
 	p_self->e_role_remote = e_role_remote;
 	return 0;
 }
 
 int tbfcp_session_set_remote_setup(struct tbfcp_session_s* p_self, enum tbfcp_setup_e e_setup_remote)
 {
 	tsk_bool_t b_is_setup_acceptable;
 	int ret;
 	if (!p_self) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 	if ((ret = tbfcp_utils_is_setup_acceptable(p_self->e_setup_local, e_setup_remote, &b_is_setup_acceptable))) {
 		return ret;
 	}
 	if (!b_is_setup_acceptable) {
 		TSK_DEBUG_ERROR("%d not acceptable as remote setup because local setup = %d", e_setup_remote, p_self->e_setup_local);
 		return -2;
 	}
 	p_self->e_setup_remote = e_setup_remote;
 	return 0;
 }
 
 int tbfcp_session_set_conf_ids(tbfcp_session_t* p_self, uint32_t u_conf_id, uint16_t u_user_id, uint16_t u_floor_id)
 {
 	if (!p_self) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 	p_self->conf_ids.u_conf_id = u_conf_id;
 	p_self->conf_ids.u_user_id = u_user_id;
 	p_self->conf_ids.u_floor_id = u_floor_id;
 	return 0;
 }
 
 int tbfcp_session_get_profile(const tbfcp_session_t* pc_self, const char** ppc_profile)
 {
     if (!pc_self) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
     return tbfcp_utils_get_profile(pc_self->e_socket_type, ppc_profile);
 }
 
 int tbfcp_session_get_local_role(const tbfcp_session_t* pc_self, enum tbfcp_role_e *pe_role_local)
 {
 	if (!pc_self || !pe_role_local) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 	*pe_role_local = pc_self->e_role_local;
 	return 0;
 }
 
 int tbfcp_session_get_local_setup(const struct tbfcp_session_s* pc_self, enum tbfcp_setup_e *pe_setup_local)
 {
 	if (!pc_self || !pe_setup_local) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 	*pe_setup_local = pc_self->e_setup_local;
 	return 0;
 }
 
 int tbfcp_session_get_local_address(const tbfcp_session_t* pc_self, const char** ppc_ip, tnet_port_t *pu_port)
 {
 	if (!pc_self || !ppc_ip || !pu_port) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 	*ppc_ip = pc_self->p_local_public_ip;
 	*pu_port = pc_self->u_local_public_port;
 	return 0;
 }
 
 int tbfcp_session_create_pkt_Hello(struct tbfcp_session_s* p_self, struct tbfcp_pkt_s** pp_pkt)
 {
 	int ret;
 	if (!p_self || !pp_pkt) {
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 	// lock()
     tsk_safeobj_lock(p_self);
 	if ((ret = tbfcp_pkt_create_Hello(p_self->conf_ids.u_conf_id, tbfcp_utils_rand_u16(), p_self->conf_ids.u_user_id, pp_pkt))) {
 		goto bail;
 	}
 
 bail:
 	// lock()
     tsk_safeobj_unlock(p_self);
 	return ret;
 }
 
 int tbfcp_session_create_pkt_FloorRequest(struct tbfcp_session_s* p_self, struct tbfcp_pkt_s** pp_pkt)
 {
 	int ret;
 	if (!p_self || !pp_pkt) {
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 	// lock()
     tsk_safeobj_lock(p_self);
 	if ((ret = tbfcp_pkt_create_FloorRequest_2(p_self->conf_ids.u_conf_id, tbfcp_utils_rand_u16(), p_self->conf_ids.u_user_id, p_self->conf_ids.u_floor_id, pp_pkt))) {
 		goto bail;
 	}
 
 bail:
 	// lock()
     tsk_safeobj_unlock(p_self);
 	return ret;
 }
 
 int tbfcp_session_create_pkt_FloorRelease(struct tbfcp_session_s* p_self, struct tbfcp_pkt_s** pp_pkt)
 {
 		int ret;
 	if (!p_self || !pp_pkt) {
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 	// lock()
     tsk_safeobj_lock(p_self);
 	if ((ret = tbfcp_pkt_create_FloorRelease_2(p_self->conf_ids.u_conf_id, tbfcp_utils_rand_u16(), p_self->conf_ids.u_user_id, p_self->conf_ids.u_floor_id, pp_pkt))) {
 		goto bail;
 	}
 
 bail:
 	// lock()
     tsk_safeobj_unlock(p_self);
 	return ret;
 }
 
 static int _tbfcp_session_send_buff(tbfcp_session_t* p_self, const void* pc_buff_ptr, tsk_size_t u_buff_size)
 {
     int ret = 0;
     tsk_size_t u_sent_bytes = 0;
     if (!p_self || !pc_buff_ptr || !u_buff_size) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 
     // lock()
     tsk_safeobj_lock(p_self);
 
     if (!p_self->b_started) {
         TSK_DEBUG_ERROR("BFCP session not started");
         ret = -2;
         goto bail;
     }
 
     if (TNET_SOCKET_TYPE_IS_DGRAM(p_self->e_socket_type)) {
         u_sent_bytes = tnet_transport_sendto(p_self->p_transport, p_self->p_transport->master->fd, (const struct sockaddr *)&p_self->remote_addr, pc_buff_ptr, u_buff_size);
     }
     else {
 		TSK_DEBUG_ERROR("Not implemented yet");
 		ret = -3;
 		goto bail;
     }
 
     if (u_sent_bytes != u_buff_size) {
         TSK_DEBUG_ERROR("Failed to send %u bytes. Only %u sent", u_buff_size, u_sent_bytes);
         ret = -2;
         goto bail;
     }
 
 bail:
     // unlock()
     tsk_safeobj_unlock(p_self);
     return ret;
 }
 
 int tbfcp_session_send_pkt(tbfcp_session_t* p_self, const tbfcp_pkt_t* pc_pkt)
 {
     int ret = 0;
 	tbfcp_udp_pkt_t *p_udp_pkt = tsk_null;
     if (!p_self || !pc_pkt) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 
     // lock()
     tsk_safeobj_lock(p_self);
 
     if (TNET_SOCKET_TYPE_IS_DGRAM(p_self->e_socket_type)) {
 		const tsk_list_item_t* pc_item = tsk_list_find_item_by_pred(p_self->p_list_udp_pkts, __pred_find_udp_pkt_by_transac_id, &pc_pkt->hdr.transac_id);
 		if (pc_item) {
 			p_udp_pkt = tsk_object_ref(TSK_OBJECT(pc_item->data));
 		} else {
 			tbfcp_udp_pkt_t *_p_udp_pkt = tsk_null;
 			if ((ret = _tbfcp_udp_pkt_create(pc_pkt, &_p_udp_pkt))) {
 				goto bail;
 			}
 			p_udp_pkt = tsk_object_ref(_p_udp_pkt);
 			tsk_list_push_back_data(p_self->p_list_udp_pkts, (void**)&_p_udp_pkt);
 		}
 	}
 	else {
 	}
 
 	if ((ret = _tbfcp_session_send_pkt(p_self, pc_pkt))) {
 		goto bail;
 	}
 	if (p_udp_pkt) {
 		p_udp_pkt->timer.u_id = tsk_timer_manager_schedule(p_self->timer.ph_global, p_udp_pkt->timer.u_timeout, _tbfcp_session_timer_callback, p_self);
 		p_udp_pkt->timer.u_timeout += kBfcpTimerT1;
 	}
 
 bail:
 	TSK_OBJECT_SAFE_FREE(p_udp_pkt);
     // unlock()
     tsk_safeobj_unlock(p_self);
     return ret;
 }
 
 int _tbfcp_session_send_pkt(tbfcp_session_t* p_self, const tbfcp_pkt_t* pc_pkt)
 {
     int ret;
     tsk_size_t u_min_size;
     if (!p_self || !pc_pkt) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 
     // lock()
     tsk_safeobj_lock(p_self);
 
     if (!p_self->b_started) {
         TSK_DEBUG_ERROR("BFCP session not started");
         ret = -2;
         goto bail;
     }
     if ((ret = tbfcp_pkt_get_size_in_octetunits_with_padding(pc_pkt, &u_min_size))) {
         goto bail;
     }
     u_min_size += kBfcpBuffMinPad;
     if (p_self->u_buff_send_size < u_min_size) {
         if (!(p_self->p_buff_send_ptr = tsk_realloc(p_self->p_buff_send_ptr, u_min_size))) {
             TSK_DEBUG_ERROR("Failed to allocate buffer with size = %u", u_min_size);
             ret = -3;
             p_self->u_buff_send_size = 0;
             goto bail;
         }
         p_self->u_buff_send_size = u_min_size;
     }
 
     if ((ret = tbfcp_pkt_write_with_padding(pc_pkt, p_self->p_buff_send_ptr, p_self->u_buff_send_size, &u_min_size))) {
         goto bail;
     }
     if ((ret = _tbfcp_session_send_buff(p_self, p_self->p_buff_send_ptr, u_min_size))) {
         goto bail;
     }
 
 bail:
     // unlock()
     tsk_safeobj_unlock(p_self);
     return ret;
 }
 
 int _tbfcp_session_send_Hello(tbfcp_session_t* p_self)
 {
 	tbfcp_pkt_t* p_pkt = tsk_null;
 	int ret;
 	if (!p_self) {
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 	if ((ret = tbfcp_pkt_create_Hello(p_self->conf_ids.u_conf_id, tbfcp_utils_rand_u16(), p_self->conf_ids.u_user_id, &p_pkt))) {
 		goto bail;
 	}
 	if ((ret = tbfcp_session_send_pkt(p_self, p_pkt))) {
 		goto bail;
 	}
 	
 bail:
 	TSK_OBJECT_SAFE_FREE(p_pkt);
 	return ret;
 }
 
 int _tbfcp_session_send_HelloAck(tbfcp_session_t* p_self, const tbfcp_pkt_t *pc_hello)
 {
 	tbfcp_pkt_t* p_pkt = tsk_null;
 	int ret;
 	if (!p_self || !pc_hello) {
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 	if ((ret = tbfcp_pkt_create_HelloAck_2(pc_hello->hdr.conf_id, pc_hello->hdr.transac_id, pc_hello->hdr.user_id, &p_pkt))) {
 		goto bail;
 	}
 	if ((ret = _tbfcp_session_send_pkt(p_self, p_pkt))) {
 		goto bail;
 	}
 	
 bail:
 	TSK_OBJECT_SAFE_FREE(p_pkt);
 	return ret;
 }
 
 static int _tbfcp_session_send_FloorRequest(tbfcp_session_t* p_self)
 {
 	tbfcp_pkt_t* p_pkt = tsk_null;
 	int ret;
 	if (!p_self) {
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 	if ((ret = tbfcp_pkt_create_FloorRequest_2(p_self->conf_ids.u_conf_id, tbfcp_utils_rand_u16(), p_self->conf_ids.u_user_id, p_self->conf_ids.u_floor_id, &p_pkt))) {
 		goto bail;
 	}
 	if ((ret = tbfcp_session_send_pkt(p_self, p_pkt))) {
 		goto bail;
 	}
 	
 bail:
 	TSK_OBJECT_SAFE_FREE(p_pkt);
 	return ret;
 }
 
 static int _tbfcp_session_process_incoming_pkt(tbfcp_session_t* p_self, const tbfcp_pkt_t *pc_pkt)
 {
 	int ret = 0;
     if (!p_self || !pc_pkt) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 
     // lock()
     tsk_safeobj_lock(p_self);
 
 	switch (pc_pkt->hdr.primitive) {
 		case tbfcp_primitive_Hello:
 			if ((ret = _tbfcp_session_send_HelloAck(p_self, pc_pkt))) {
 				goto bail;
 			}
 			break;
 		case tbfcp_primitive_HelloAck:
         default:
 			break;
 	}
 
 	// raise event
 	_tbfcp_session_raise_inf_inc_msg(p_self, pc_pkt);
 	// remove request
 	tsk_list_remove_item_by_pred(p_self->p_list_udp_pkts, __pred_find_udp_pkt_by_transac_id, &pc_pkt->hdr.transac_id);
 
 bail:
     // unlock()
     tsk_safeobj_unlock(p_self);
     return ret;
 }
 
 // clear junks (e.g. IPSec)
 static int _tbfcp_session_socket_type_make_valid(enum tnet_socket_type_e e_in_st, enum tnet_socket_type_e *pe_out_st)
 {
     if (!pe_out_st) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
     if (TNET_SOCKET_TYPE_IS_DTLS(e_in_st) || TNET_SOCKET_TYPE_IS_UDP(e_in_st) || TNET_SOCKET_TYPE_IS_TLS(e_in_st) || TNET_SOCKET_TYPE_IS_TCP(e_in_st)) {
         *pe_out_st = e_in_st;
     }
     else {
         *pe_out_st = kBfcpTransportDefault;
     }
     return 0;
 }
 
 static int _tbfcp_session_timer_schedule(tbfcp_session_t* p_self, _bfcp_timer_type_t e_timer, uint64_t u_timeout)
 {
     int ret = 0;
     if (!p_self) {
         TSK_DEBUG_ERROR("Invalid parameter");
         return -1;
     }
 
     tsk_safeobj_lock(p_self); // must
     switch (e_timer) {
     case _bfcp_timer_type_T1:
         if (!TSK_TIMER_ID_IS_VALID(p_self->timer.id_T1)) {
             p_self->timer.id_T1 = tsk_timer_mgr_global_schedule(u_timeout, _tbfcp_session_timer_callback, p_self);
         }
         else {
             TSK_DEBUG_ERROR("T1 timer is still valid");
             ret = -3;
         }
         break;
     case _bfcp_timer_type_T2:
         if (!TSK_TIMER_ID_IS_VALID(p_self->timer.id_T2)) {
             p_self->timer.id_T2 = tsk_timer_mgr_global_schedule(u_timeout, _tbfcp_session_timer_callback, p_self);
         }
         else {
             TSK_DEBUG_ERROR("T2 timer is still valid");
             ret = -3;
         }
         break;
     case _bfcp_timer_type_TcpReconnect:
         if (!TSK_TIMER_ID_IS_VALID(p_self->timer.id_TcpReconnect)) {
             p_self->timer.id_TcpReconnect = tsk_timer_mgr_global_schedule(u_timeout, _tbfcp_session_timer_callback, p_self);
         }
         else {
             TSK_DEBUG_ERROR("TcpReconnect timer is still valid");
             ret = -3;
         }
         break;
     default:
         TSK_DEBUG_ERROR("%d not valid BFCP timer", e_timer);
         ret = -2;
         break;
     }
     tsk_safeobj_unlock(p_self);
     return ret;
 }
 
 static int _tbfcp_session_timer_callback(const void* pc_arg, tsk_timer_id_t timer_id)
 {
     tbfcp_session_t* p_session = (tbfcp_session_t*)pc_arg;
 	const tsk_list_item_t* pc_item;
     tsk_safeobj_lock(p_session); // must
 	if (!p_session->b_started) goto bail;
 	pc_item = tsk_list_find_item_by_pred(p_session->p_list_udp_pkts, __pred_find_udp_pkt_by_timer, &timer_id);
 	if (pc_item) {
 		tbfcp_udp_pkt_t* pc_udp_pkt = (tbfcp_udp_pkt_t*)pc_item->data;
 		if (pc_udp_pkt->timer.u_timeout <= kBfcpTimerT1Max) {
 			tbfcp_session_send_pkt(p_session, pc_udp_pkt->p_pkt);
 		}
 		else {
 			// raise event
 			_tbfcp_session_raise_err_send_timedout(p_session, pc_udp_pkt->p_pkt);
 			// remove pkt
 			tsk_list_remove_item_by_pred(p_session->p_list_udp_pkts, __pred_find_udp_pkt_by_timer, &timer_id);
 		}
 	}
 #if 0
     if (p_session->timer.id_T1 == timer_id) {
         p_session->timer.id_T1 = TSK_INVALID_TIMER_ID;
         // OnExpire(session, EVENT_BYE);
     }
     else if (p_session->timer.id_T2 == timer_id) {
         p_session->timer.id_T2 = TSK_INVALID_TIMER_ID;
         // OnExpire(session, EVENT_REPORT);
     }
 #endif
 bail:
     tsk_safeobj_unlock(p_session);
     return 0;
 }
 
 static int _tbfcp_session_transport_layer_dgram_cb(const tnet_transport_event_t* e)
 {
     tbfcp_session_t* p_session = (tbfcp_session_t*)e->callback_data;
 	int ret;
 	tbfcp_pkt_t* p_pkt = tsk_null;
 	switch(e->type){
 		case event_data: {
 				break;
 			}
 		case event_closed:
 		case event_connected:
 		default:{
 				return 0;
 			}
 	}
 
 	if ((ret = tbfcp_pkt_read(e->data, e->size, &p_pkt))) {
 		goto bail;
 	}
 	if ((ret = _tbfcp_session_process_incoming_pkt(p_session, p_pkt))) {
 		goto bail;
 	}
 
 bail:
 	TSK_OBJECT_SAFE_FREE(p_pkt);
     return ret;
 }
 
 static int _tbfcp_session_transport_layer_stream_cb(const tnet_transport_event_t* e)
 {
 	// tbfcp_session_t* p_session = (tbfcp_session_t*)e->callback_data;
 	TSK_DEBUG_ERROR("Not implemented yet");
 	return -1;
 }
 
 static tsk_object_t* tbfcp_session_ctor(tsk_object_t * self, va_list * app)
 {
     tbfcp_session_t *p_session = (tbfcp_session_t *)self;
     if (p_session) {
         p_session->timer.id_T1 = TSK_INVALID_TIMER_ID;
         p_session->timer.id_T2 = TSK_INVALID_TIMER_ID;
 		if (!(p_session->p_list_udp_pkts = tsk_list_create())) {
 			TSK_DEBUG_ERROR("Failed to create en empty list");
 			return tsk_null;
 		}
         // get a handle for the global timer manager
         if (!(p_session->timer.ph_global = tsk_timer_mgr_global_ref())) {
             TSK_DEBUG_ERROR("Failed to get a reference to the global timer");
             return tsk_null;
         }
         p_session->u_local_port = TNET_SOCKET_PORT_ANY;
 		p_session->e_role_local = kBfcpRoleDefault;
 		p_session->e_setup_local = kBfcpSetupDefault;
         tsk_safeobj_init(p_session);
     }
     return self;
 }
 static tsk_object_t* tbfcp_session_dtor(tsk_object_t * self)
 {
     tbfcp_session_t *p_session = (tbfcp_session_t *)self;
     if (p_session) {
         TSK_DEBUG_INFO("*** BFCP session destroyed ***");
         // stop the session if not already done
         tbfcp_session_stop(p_session);
         // release the handle for the global timer manager
         tsk_timer_mgr_global_unref(&p_session->timer.ph_global);
         
         TSK_FREE(p_session->p_local_ip);
         TSK_FREE(p_session->p_local_public_ip);
         TSK_FREE(p_session->p_remote_ip);
         TSK_FREE(p_session->p_buff_send_ptr);
 		TSK_OBJECT_SAFE_FREE(p_session->p_natt_ctx);
         TSK_OBJECT_SAFE_FREE(p_session->p_ice_ctx);
         TSK_OBJECT_SAFE_FREE(p_session->p_transport);
 		TSK_OBJECT_SAFE_FREE(p_session->p_list_udp_pkts);
         tsk_safeobj_deinit(p_session);
     }
 
     return self;
 }
 static int tbfcp_session_cmp(const tsk_object_t *_pss1, const tsk_object_t *_pss2)
 {
     const tbfcp_session_t *pc_ss1 = (const tbfcp_session_t *)_pss1;
     const tbfcp_session_t *pc_ss2 = (const tbfcp_session_t *)_pss2;
     return (int)(pc_ss1 - pc_ss2);
 }
 static const tsk_object_def_t tbfcp_session_def_s = {
     sizeof(tbfcp_session_t),
     tbfcp_session_ctor,
     tbfcp_session_dtor,
     tbfcp_session_cmp,
 };
 const tsk_object_def_t *tbfcp_session_def_t = &tbfcp_session_def_s;
 
 
 
 static int _tbfcp_udp_pkt_create(const tbfcp_pkt_t *pc_pkt, tbfcp_udp_pkt_t** pp_pkt)
 {
 	extern const tsk_object_def_t *tbfcp_udp_pkt_def_t;
 	if (!pc_pkt || !pp_pkt) {
 		TSK_DEBUG_ERROR("Invalid parameter");
 		return -1;
 	}
 	*pp_pkt = tsk_object_new(tbfcp_udp_pkt_def_t);
 	if (!(*pp_pkt)) {
 		TSK_DEBUG_ERROR("Failed to create object with type= 'tbfcp_udp_pkt_def_t'");
 		return -2;
 	}
 	(*pp_pkt)->p_pkt = tsk_object_ref(TSK_OBJECT(pc_pkt));
 	return 0;
 }
 
 static tsk_object_t* tbfcp_udp_pkt_ctor(tsk_object_t * self, va_list * app)
 {
     tbfcp_udp_pkt_t *p_udp_pkt = (tbfcp_udp_pkt_t *)self;
     if (p_udp_pkt) {
         p_udp_pkt->timer.u_timeout = kBfcpTimerT1;
 		p_udp_pkt->timer.u_id = TSK_INVALID_TIMER_ID;
     }
     return self;
 }
 static tsk_object_t* tbfcp_udp_pkt_dtor(tsk_object_t * self)
 {
     tbfcp_udp_pkt_t *p_udp_pkt = (tbfcp_udp_pkt_t *)self;
     if (p_udp_pkt) {
 		TSK_OBJECT_SAFE_FREE(p_udp_pkt->p_pkt);
 		TSK_DEBUG_INFO("*** tbfcp_udp_pkt_t destroyed ***");
     }
     return self;
 }
 static const tsk_object_def_t tbfcp_udp_pkt_def_s = {
     sizeof(tbfcp_udp_pkt_t),
     tbfcp_udp_pkt_ctor,
     tbfcp_udp_pkt_dtor,
     tsk_null,
 };
 const tsk_object_def_t *tbfcp_udp_pkt_def_t = &tbfcp_udp_pkt_def_s;