turn_session.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 * Copyright (C) 2003-2008 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 __PJNATH_TURN_SESSION_H__
#define __PJNATH_TURN_SESSION_H__
 
#include <pjnath/stun_session.h>
#include <pjlib-util/resolver.h>
 
 
PJ_BEGIN_DECL
 
 
/* **************************************************************************/
typedef struct pj_turn_session pj_turn_session;
 
 
typedef enum pj_turn_tp_type
{
    PJ_TURN_TP_UDP = 17,
 
    PJ_TURN_TP_TCP = 6,
 
    PJ_TURN_TP_TLS = 56
 
} pj_turn_tp_type;
 
 
typedef enum pj_turn_state_t
{
    PJ_TURN_STATE_NULL,
 
    PJ_TURN_STATE_RESOLVING,
 
    PJ_TURN_STATE_RESOLVED,
 
    PJ_TURN_STATE_ALLOCATING,
 
    PJ_TURN_STATE_READY,
 
    PJ_TURN_STATE_DEALLOCATING,
 
    PJ_TURN_STATE_DEALLOCATED,
 
    PJ_TURN_STATE_DESTROYING
 
} pj_turn_state_t;
 
 
#pragma pack(1)
 
typedef struct pj_turn_channel_data
{
    pj_uint16_t ch_number;      
    pj_uint16_t length;         
} pj_turn_channel_data;
 
 
#pragma pack()
 
 
typedef struct pj_turn_session_cb
{
    pj_status_t (*on_send_pkt)(pj_turn_session *sess,
                               const pj_uint8_t *pkt,
                               unsigned pkt_len,
                               const pj_sockaddr_t *dst_addr,
                               unsigned addr_len);
 
    pj_status_t (*on_stun_send_pkt)(pj_turn_session *sess,
                                    const pj_uint8_t *pkt,
                                    unsigned pkt_len,
                                    const pj_sockaddr_t *dst_addr,
                                    unsigned addr_len);
 
    void (*on_channel_bound)(pj_turn_session *sess,
                             const pj_sockaddr_t *peer_addr,
                             unsigned addr_len,
                             unsigned ch_num);
 
    void (*on_rx_data)(pj_turn_session *sess,
                       void *pkt,
                       unsigned pkt_len,
                       const pj_sockaddr_t *peer_addr,
                       unsigned addr_len);
 
    void (*on_state)(pj_turn_session *sess, 
                     pj_turn_state_t old_state,
                     pj_turn_state_t new_state);
 
    void (*on_connection_attempt)(pj_turn_session *sess,
                                  pj_uint32_t conn_id,
                                  const pj_sockaddr_t *peer_addr,
                                  unsigned addr_len);
 
    void (*on_connection_bind_status)(pj_turn_session *sess,
                                      pj_status_t status,
                                      pj_uint32_t conn_id,
                                      const pj_sockaddr_t *peer_addr,
                                      unsigned addr_len);
 
    void (*on_connect_complete)(pj_turn_session *sess,
                       pj_status_t status,
                       pj_uint32_t conn_id,
                       const pj_sockaddr_t *peer_addr,
                       unsigned addr_len);
 
} pj_turn_session_cb;
 
 
typedef struct pj_turn_alloc_param
{
    int     bandwidth;
 
    int     lifetime;
 
    int     ka_interval;
 
    int     af;
 
    pj_turn_tp_type peer_conn_type;
 
} pj_turn_alloc_param;
 
 
typedef struct pj_turn_session_info
{
    pj_turn_state_t state;
 
    pj_status_t     last_status;
 
    pj_turn_tp_type conn_type;
 
    pj_sockaddr     server;
 
    pj_sockaddr     mapped_addr;
 
    pj_sockaddr     relay_addr;
 
    int             lifetime;
 
} pj_turn_session_info;
 
 
typedef struct pj_turn_session_on_rx_pkt_param
{
    void                *pkt;
 
    pj_size_t            pkt_len;
 
    pj_size_t            parsed_len;
 
    const pj_sockaddr_t *src_addr;
 
    unsigned             src_addr_len;
 
} pj_turn_session_on_rx_pkt_param;
 
 
PJ_DECL(void) pj_turn_alloc_param_default(pj_turn_alloc_param *prm);
 
 
PJ_DECL(void) pj_turn_alloc_param_copy(pj_pool_t *pool, 
                                       pj_turn_alloc_param *dst,
                                       const pj_turn_alloc_param *src);
 
PJ_DECL(const char*) pj_turn_state_name(pj_turn_state_t state);
 
 
PJ_DECL(pj_status_t) pj_turn_session_create(const pj_stun_config *cfg,
                                            const char *name,
                                            int af,
                                            pj_turn_tp_type conn_type,
                                            pj_grp_lock_t *grp_lock,
                                            const pj_turn_session_cb *cb,
                                            unsigned options,
                                            void *user_data,
                                            pj_turn_session **p_sess);
 
PJ_DECL(pj_status_t) pj_turn_session_shutdown(pj_turn_session *sess);
 
 
PJ_DECL(pj_status_t) pj_turn_session_destroy(pj_turn_session *sess,
                                             pj_status_t last_err);
 
 
PJ_DECL(pj_status_t) pj_turn_session_get_info(pj_turn_session *sess,
                                              pj_turn_session_info *info);
 
PJ_DECL(pj_status_t) pj_turn_session_set_user_data(pj_turn_session *sess,
                                                   void *user_data);
 
PJ_DECL(void*) pj_turn_session_get_user_data(pj_turn_session *sess);
 
 
PJ_DECL(pj_grp_lock_t *) pj_turn_session_get_grp_lock(pj_turn_session *sess);
 
 
PJ_DECL(void) pj_turn_session_set_log(pj_turn_session *sess,
                                      unsigned flags);
 
 
PJ_DECL(pj_status_t) pj_turn_session_set_software_name(pj_turn_session *sess,
                                                       const pj_str_t *sw);
 
 
PJ_DECL(pj_status_t) pj_turn_session_set_server(pj_turn_session *sess,
                                                const pj_str_t *domain,
                                                int default_port,
                                                pj_dns_resolver *resolver);
 
 
PJ_DECL(pj_status_t) pj_turn_session_set_credential(pj_turn_session *sess,
                                              const pj_stun_auth_cred *cred);
 
 
PJ_DECL(pj_status_t) pj_turn_session_alloc(pj_turn_session *sess,
                                           const pj_turn_alloc_param *param);
 
 
PJ_DECL(pj_status_t) pj_turn_session_set_perm(pj_turn_session *sess,
                                              unsigned addr_cnt,
                                              const pj_sockaddr addr[],
                                              unsigned options);
 
 
PJ_DECL(pj_status_t) pj_turn_session_sendto(pj_turn_session *sess,
                                            const pj_uint8_t *pkt,
                                            unsigned pkt_len,
                                            const pj_sockaddr_t *peer_addr,
                                            unsigned addr_len);
 
PJ_DECL(pj_status_t) pj_turn_session_bind_channel(pj_turn_session *sess,
                                                  const pj_sockaddr_t *peer,
                                                  unsigned addr_len);
 
PJ_DECL(pj_status_t) pj_turn_session_on_rx_pkt(pj_turn_session *sess,
                                               void *pkt,
                                               pj_size_t pkt_len,
                                               pj_size_t *parsed_len);
 
PJ_DECL(pj_status_t) pj_turn_session_on_rx_pkt2(
                                    pj_turn_session *sess,
                                    pj_turn_session_on_rx_pkt_param *prm);
 
PJ_DECL(pj_status_t) pj_turn_session_connection_bind(
                                            pj_turn_session *sess,
                                            pj_pool_t *pool,
                                            pj_uint32_t conn_id,
                                            const pj_sockaddr_t *peer_addr,
                                            unsigned addr_len);
PJ_DECL(pj_status_t) pj_turn_session_connect(pj_turn_session *sess,
                        const pj_sockaddr_t *peer_addr,
                        unsigned addr_len);
 
PJ_END_DECL
 
 
#endif  /* __PJNATH_TURN_SESSION_H__ */