ice_strans.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_ICE_STRANS_H__
#define __PJNATH_ICE_STRANS_H__
 
 
#include <pjnath/ice_session.h>
#include <pjnath/stun_sock.h>
#include <pjnath/turn_sock.h>
#include <pjlib-util/resolver.h>
#include <pj/ioqueue.h>
#include <pj/timer.h>
 
 
PJ_BEGIN_DECL
 
 
#ifndef DEPRECATED_FOR_TICKET_2229
#  define DEPRECATED_FOR_TICKET_2229    0
#endif
 
typedef struct pj_ice_strans pj_ice_strans;
 
typedef enum pj_ice_strans_op
{
    PJ_ICE_STRANS_OP_INIT,
 
    PJ_ICE_STRANS_OP_NEGOTIATION,
 
    PJ_ICE_STRANS_OP_KEEP_ALIVE,
 
    PJ_ICE_STRANS_OP_ADDR_CHANGE
 
} pj_ice_strans_op;
 
typedef struct pj_ice_strans_cb
{
    void    (*on_rx_data)(pj_ice_strans *ice_st,
                          unsigned comp_id, 
                          void *pkt, pj_size_t size,
                          const pj_sockaddr_t *src_addr,
                          unsigned src_addr_len);
 
    void    (*on_data_sent)(pj_ice_strans *sock,
                            pj_ssize_t sent);
 
    void (*on_valid_pair)(pj_ice_strans *ice_st);
 
    void    (*on_ice_complete)(pj_ice_strans *ice_st, 
                               pj_ice_strans_op op,
                               pj_status_t status);
 
    void    (*on_new_candidate)(pj_ice_strans *ice_st,
                                const pj_ice_sess_cand *cand,
                                pj_bool_t end_of_cand);
 
} pj_ice_strans_cb;
 
 
typedef struct pj_ice_strans_stun_cfg
{
    int                  af;
 
    pj_stun_sock_cfg     cfg;
 
    unsigned             max_host_cands;
 
    pj_bool_t            loop_addr;
 
    pj_str_t             server;
 
    pj_uint16_t          port;
 
    pj_bool_t            ignore_stun_error;
 
} pj_ice_strans_stun_cfg;
 
 
typedef struct pj_ice_strans_turn_cfg
{
    int                  af;
 
    pj_turn_sock_cfg     cfg;
 
    pj_str_t             server;
 
    pj_uint16_t          port;
 
    pj_turn_tp_type      conn_type;
 
    pj_stun_auth_cred    auth_cred;
 
    pj_turn_alloc_param  alloc_param;
 
} pj_ice_strans_turn_cfg;
 
 
typedef struct pj_ice_strans_cfg
{
    int                  af;
 
    pj_stun_config       stun_cfg;
 
    pj_dns_resolver     *resolver;
 
    pj_ice_sess_options  opt;
 
    pj_ice_strans_stun_cfg stun;
 
    unsigned             stun_tp_cnt;
 
    pj_ice_strans_stun_cfg stun_tp[PJ_ICE_MAX_STUN];
 
    pj_ice_strans_turn_cfg turn;
 
    unsigned             turn_tp_cnt;
 
    pj_ice_strans_turn_cfg turn_tp[PJ_ICE_MAX_TURN];
 
    unsigned             num_send_buf;
 
    unsigned             send_buf_size;
 
    struct {
        pj_qos_type qos_type;
 
        pj_qos_params qos_params;
 
        unsigned so_rcvbuf_size;
 
        unsigned so_sndbuf_size;
 
    } comp[PJ_ICE_MAX_COMP];
 
} pj_ice_strans_cfg;
 
 
typedef enum pj_ice_strans_state
{
    PJ_ICE_STRANS_STATE_NULL,
 
    PJ_ICE_STRANS_STATE_INIT,
 
    PJ_ICE_STRANS_STATE_READY,
 
    PJ_ICE_STRANS_STATE_SESS_READY,
 
    PJ_ICE_STRANS_STATE_NEGO,
 
    PJ_ICE_STRANS_STATE_RUNNING,
 
    PJ_ICE_STRANS_STATE_FAILED
 
} pj_ice_strans_state;
 
 
PJ_DECL(void) pj_ice_strans_cfg_default(pj_ice_strans_cfg *cfg);
 
 
PJ_DECL(void) pj_ice_strans_stun_cfg_default(pj_ice_strans_stun_cfg *cfg);
 
 
PJ_DECL(void) pj_ice_strans_turn_cfg_default(pj_ice_strans_turn_cfg *cfg);
 
 
PJ_DECL(void) pj_ice_strans_cfg_copy(pj_pool_t *pool,
                                     pj_ice_strans_cfg *dst,
                                     const pj_ice_strans_cfg *src);
 
 
PJ_DECL(pj_status_t) pj_ice_strans_create(const char *name,
                                          const pj_ice_strans_cfg *cfg,
                                          unsigned comp_cnt,
                                          void *user_data,
                                          const pj_ice_strans_cb *cb,
                                          pj_ice_strans **p_ice_st);
 
PJ_DECL(pj_ice_strans_state) pj_ice_strans_get_state(pj_ice_strans *ice_st);
 
 
PJ_DECL(const char*) pj_ice_strans_state_name(pj_ice_strans_state state);
 
 
PJ_DECL(pj_status_t) pj_ice_strans_destroy(pj_ice_strans *ice_st);
 
 
PJ_DECL(void*) pj_ice_strans_get_user_data(pj_ice_strans *ice_st);
 
 
PJ_DECL(pj_status_t) pj_ice_strans_get_options(pj_ice_strans *ice_st,
                                               pj_ice_sess_options *opt);
 
PJ_DECL(pj_status_t) pj_ice_strans_set_options(pj_ice_strans *ice_st,
                                               const pj_ice_sess_options *opt);
 
PJ_DECL(pj_status_t) pj_ice_strans_update_comp_cnt(pj_ice_strans *ice_st,
                                                   unsigned comp_cnt);
 
PJ_DECL(pj_grp_lock_t *) pj_ice_strans_get_grp_lock(pj_ice_strans *ice_st);
 
PJ_DECL(pj_status_t) pj_ice_strans_init_ice(pj_ice_strans *ice_st,
                                            pj_ice_sess_role role,
                                            const pj_str_t *local_ufrag,
                                            const pj_str_t *local_passwd);
 
PJ_DECL(pj_bool_t) pj_ice_strans_has_sess(pj_ice_strans *ice_st);
 
 
PJ_DECL(pj_bool_t) pj_ice_strans_sess_is_running(pj_ice_strans *ice_st);
 
 
PJ_DECL(pj_bool_t) pj_ice_strans_sess_is_complete(pj_ice_strans *ice_st);
 
 
PJ_DECL(unsigned) pj_ice_strans_get_running_comp_cnt(pj_ice_strans *ice_st);
 
 
PJ_DECL(pj_status_t) pj_ice_strans_get_ufrag_pwd(pj_ice_strans *ice_st,
                                                 pj_str_t *loc_ufrag,
                                                 pj_str_t *loc_pwd,
                                                 pj_str_t *rem_ufrag,
                                                 pj_str_t *rem_pwd);
 
 
PJ_DECL(unsigned) pj_ice_strans_get_cands_count(pj_ice_strans *ice_st,
                                                unsigned comp_id);
 
PJ_DECL(pj_status_t) pj_ice_strans_enum_cands(pj_ice_strans *ice_st,
                                              unsigned comp_id,
                                              unsigned *count,
                                              pj_ice_sess_cand cand[]);
 
PJ_DECL(pj_status_t) pj_ice_strans_get_def_cand(pj_ice_strans *ice_st,
                                                unsigned comp_id,
                                                pj_ice_sess_cand *cand);
 
PJ_DECL(pj_ice_sess_role) pj_ice_strans_get_role(pj_ice_strans *ice_st);
 
 
PJ_DECL(pj_status_t) pj_ice_strans_change_role(pj_ice_strans *ice_st,
                                               pj_ice_sess_role new_role);
 
 
PJ_DECL(pj_status_t) pj_ice_strans_start_ice(pj_ice_strans *ice_st,
                                             const pj_str_t *rem_ufrag,
                                             const pj_str_t *rem_passwd,
                                             unsigned rcand_cnt,
                                             const pj_ice_sess_cand rcand[]);
 
 
PJ_DECL(pj_status_t) pj_ice_strans_update_check_list(
                                             pj_ice_strans *ice_st,
                                             const pj_str_t *rem_ufrag,
                                             const pj_str_t *rem_passwd,
                                             unsigned rcand_cnt,
                                             const pj_ice_sess_cand rcand[],
                                             pj_bool_t rcand_end);
 
PJ_DECL(const pj_ice_sess_check*) 
pj_ice_strans_get_valid_pair(const pj_ice_strans *ice_st,
                             unsigned comp_id);
 
PJ_DECL(pj_status_t) pj_ice_strans_stop_ice(pj_ice_strans *ice_st);
 
 
#if !DEPRECATED_FOR_TICKET_2229
PJ_DECL(pj_status_t) pj_ice_strans_sendto(pj_ice_strans *ice_st,
                                          unsigned comp_id,
                                          const void *data,
                                          pj_size_t data_len,
                                          const pj_sockaddr_t *dst_addr,
                                          int dst_addr_len);
#endif
 
 
PJ_DECL(pj_status_t) pj_ice_strans_sendto2(pj_ice_strans *ice_st,
                                           unsigned comp_id,
                                           const void *data,
                                           pj_size_t data_len,
                                           const pj_sockaddr_t *dst_addr,
                                           int dst_addr_len);
 
 
PJ_END_DECL
 
 
 
#endif  /* __PJNATH_ICE_STRANS_H__ */