stun_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_STUN_SESSION_H__
#define __PJNATH_STUN_SESSION_H__
 
#include <pjnath/stun_msg.h>
#include <pjnath/stun_auth.h>
#include <pjnath/stun_config.h>
#include <pjnath/stun_transaction.h>
#include <pj/list.h>
#include <pj/lock.h>
#include <pj/timer.h>
 
PJ_BEGIN_DECL
 
 
/* **************************************************************************/
typedef struct pj_stun_tx_data pj_stun_tx_data;
 
typedef struct pj_stun_rx_data pj_stun_rx_data;
 
typedef struct pj_stun_session pj_stun_session;
 
 
typedef struct pj_stun_session_cb
{
    pj_status_t (*on_send_msg)(pj_stun_session *sess,
                               void *token,
                               const void *pkt,
                               pj_size_t pkt_size,
                               const pj_sockaddr_t *dst_addr,
                               unsigned addr_len);
 
    pj_status_t (*on_rx_request)(pj_stun_session *sess,
                                 const pj_uint8_t *pkt,
                                 unsigned pkt_len,
                                 const pj_stun_rx_data *rdata,
                                 void *token,
                                 const pj_sockaddr_t *src_addr,
                                 unsigned src_addr_len);
 
    void (*on_request_complete)(pj_stun_session *sess,
                                pj_status_t status,
                                void *token,
                                pj_stun_tx_data *tdata,
                                const pj_stun_msg *response,
                                const pj_sockaddr_t *src_addr,
                                unsigned src_addr_len);
 
 
    pj_status_t (*on_rx_indication)(pj_stun_session *sess,
                                    const pj_uint8_t *pkt,
                                    unsigned pkt_len,
                                    const pj_stun_msg *msg,
                                    void *token,
                                    const pj_sockaddr_t *src_addr,
                                    unsigned src_addr_len);
 
} pj_stun_session_cb;
 
 
struct pj_stun_rx_data
{
    pj_stun_msg             *msg;
 
    pj_stun_req_cred_info   info;
};
 
 
struct pj_stun_tx_data
{
    PJ_DECL_LIST_MEMBER(struct pj_stun_tx_data);
 
    pj_pool_t           *pool;          
    pj_stun_session     *sess;          
    pj_stun_msg         *msg;           
    pj_bool_t            is_destroying; 
    void                *token;         
    pj_stun_client_tsx  *client_tsx;    
    pj_bool_t            retransmit;    
    pj_uint32_t          msg_magic;     
    pj_uint8_t           msg_key[12];   
    pj_grp_lock_t       *grp_lock;      
    pj_stun_req_cred_info auth_info;    
    void                *pkt;           
    unsigned             max_len;       
    pj_size_t            pkt_size;      
    unsigned             addr_len;      
    const pj_sockaddr_t *dst_addr;      
    pj_timer_entry       res_timer;     
};
 
 
typedef enum pj_stun_sess_msg_log_flag
{
    PJ_STUN_SESS_LOG_TX_REQ=1,  
    PJ_STUN_SESS_LOG_TX_RES=2,  
    PJ_STUN_SESS_LOG_TX_IND=4,  
    PJ_STUN_SESS_LOG_RX_REQ=8,  
    PJ_STUN_SESS_LOG_RX_RES=16, 
    PJ_STUN_SESS_LOG_RX_IND=32  
} pj_stun_sess_msg_log_flag;
 
 
PJ_DECL(pj_status_t) pj_stun_session_create(pj_stun_config *cfg,
                                            const char *name,
                                            const pj_stun_session_cb *cb,
                                            pj_bool_t fingerprint,
                                            pj_grp_lock_t *grp_lock,
                                            pj_stun_session **p_sess);
 
PJ_DECL(pj_status_t) pj_stun_session_destroy(pj_stun_session *sess);
 
PJ_DECL(pj_status_t) pj_stun_session_set_user_data(pj_stun_session *sess,
                                                   void *user_data);
 
PJ_DECL(void*) pj_stun_session_get_user_data(pj_stun_session *sess);
 
PJ_DECL(pj_grp_lock_t *) pj_stun_session_get_grp_lock(pj_stun_session *sess);
 
PJ_DECL(pj_status_t) pj_stun_session_set_software_name(pj_stun_session *sess,
                                                       const pj_str_t *sw);
 
PJ_DECL(pj_status_t) pj_stun_session_set_credential(pj_stun_session *sess,
                                                pj_stun_auth_type auth_type,
                                                const pj_stun_auth_cred *cred);
PJ_DECL(void) pj_stun_session_set_log(pj_stun_session *sess,
                                      unsigned flags);
PJ_DECL(pj_bool_t) pj_stun_session_use_fingerprint(pj_stun_session *sess,
                                                   pj_bool_t use);
 
PJ_DECL(pj_status_t) pj_stun_session_create_req(pj_stun_session *sess,
                                                int msg_type,
                                                pj_uint32_t magic,
                                                const pj_uint8_t tsx_id[12],
                                                pj_stun_tx_data **p_tdata);
 
PJ_DECL(pj_status_t) pj_stun_session_create_ind(pj_stun_session *sess,
                                                int msg_type,
                                                pj_stun_tx_data **p_tdata);
 
PJ_DECL(pj_status_t) pj_stun_session_create_res(pj_stun_session *sess,
                                                const pj_stun_rx_data *rdata,
                                                unsigned err_code,
                                                const pj_str_t *err_msg,
                                                pj_stun_tx_data **p_tdata);
 
PJ_DECL(pj_status_t) pj_stun_session_send_msg(pj_stun_session *sess,
                                              void *token,
                                              pj_bool_t cache_res,
                                              pj_bool_t retransmit,
                                              const pj_sockaddr_t *dst_addr,
                                              unsigned addr_len,
                                              pj_stun_tx_data *tdata);
 
PJ_DECL(pj_status_t) pj_stun_session_respond(pj_stun_session *sess, 
                                             const pj_stun_rx_data *rdata,
                                             unsigned code, 
                                             const char *err_msg,
                                             void *token,
                                             pj_bool_t cache, 
                                             const pj_sockaddr_t *dst_addr, 
                                             unsigned addr_len);
 
PJ_DECL(pj_status_t) pj_stun_session_cancel_req(pj_stun_session *sess,
                                                pj_stun_tx_data *tdata,
                                                pj_bool_t notify,
                                                pj_status_t status);
 
PJ_DECL(pj_status_t) pj_stun_session_retransmit_req(pj_stun_session *sess,
                                                    pj_stun_tx_data *tdata,
                                                    pj_bool_t mod_count);
 
 
PJ_DECL(pj_status_t) pj_stun_session_on_rx_pkt(pj_stun_session *sess,
                                               const void *packet,
                                               pj_size_t pkt_size,
                                               unsigned options,
                                               void *token,
                                               pj_size_t *parsed_len,
                                               const pj_sockaddr_t *src_addr,
                                               unsigned src_addr_len);
 
PJ_DECL(void) pj_stun_msg_destroy_tdata(pj_stun_session *sess,
                                        pj_stun_tx_data *tdata);
 
 
PJ_END_DECL
 
#endif  /* __PJNATH_STUN_SESSION_H__ */