stun_sock.h

Go to the documentation of this file.

/* $Id: stun_sock.h 3553 2011-05-05 06:14:19Z nanang $ */
/* 
 * 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_SOCK_H__
#define __PJNATH_STUN_SOCK_H__

#include <pjnath/stun_config.h>
#include <pjlib-util/resolver.h>
#include <pj/ioqueue.h>
#include <pj/sock.h>
#include <pj/sock_qos.h>


PJ_BEGIN_DECL


typedef struct pj_stun_sock pj_stun_sock;

typedef enum pj_stun_sock_op
{
    PJ_STUN_SOCK_DNS_OP         = 1,

    PJ_STUN_SOCK_BINDING_OP,

    PJ_STUN_SOCK_KEEP_ALIVE_OP,

    PJ_STUN_SOCK_MAPPED_ADDR_CHANGE


} pj_stun_sock_op;


typedef struct pj_stun_sock_cb
{
    pj_bool_t (*on_rx_data)(pj_stun_sock *stun_sock,
                            void *pkt,
                            unsigned pkt_len,
                            const pj_sockaddr_t *src_addr,
                            unsigned addr_len);

    pj_bool_t (*on_data_sent)(pj_stun_sock *stun_sock,
                              pj_ioqueue_op_key_t *send_key,
                              pj_ssize_t sent);

    pj_bool_t   (*on_status)(pj_stun_sock *stun_sock, 
                             pj_stun_sock_op op,
                             pj_status_t status);

} pj_stun_sock_cb;


typedef struct pj_stun_sock_info
{
    pj_sockaddr     bound_addr;

    pj_sockaddr     srv_addr;

    pj_sockaddr     mapped_addr;

    unsigned        alias_cnt;

    pj_sockaddr     aliases[PJ_ICE_ST_MAX_CAND];

} pj_stun_sock_info;


typedef struct pj_stun_sock_cfg
{
    unsigned max_pkt_size;

    unsigned async_cnt;

    pj_sockaddr bound_addr;

    int ka_interval;

    pj_qos_type qos_type;

    pj_qos_params qos_params;

    pj_bool_t qos_ignore_error;

} pj_stun_sock_cfg;



PJ_DECL(const char*) pj_stun_sock_op_name(pj_stun_sock_op op);


PJ_DECL(void) pj_stun_sock_cfg_default(pj_stun_sock_cfg *cfg);


PJ_DECL(pj_status_t) pj_stun_sock_create(pj_stun_config *stun_cfg,
                                         const char *name,
                                         int af,
                                         const pj_stun_sock_cb *cb,
                                         const pj_stun_sock_cfg *cfg,
                                         void *user_data,
                                         pj_stun_sock **p_sock);


PJ_DECL(pj_status_t) pj_stun_sock_start(pj_stun_sock *stun_sock,
                                        const pj_str_t *domain,
                                        pj_uint16_t default_port,
                                        pj_dns_resolver *resolver);

PJ_DECL(pj_status_t) pj_stun_sock_destroy(pj_stun_sock *sock);


PJ_DECL(pj_status_t) pj_stun_sock_set_user_data(pj_stun_sock *stun_sock,
                                                void *user_data);

PJ_DECL(void*) pj_stun_sock_get_user_data(pj_stun_sock *stun_sock);


PJ_DECL(pj_status_t) pj_stun_sock_get_info(pj_stun_sock *stun_sock,
                                           pj_stun_sock_info *info);


PJ_DECL(pj_status_t) pj_stun_sock_sendto(pj_stun_sock *stun_sock,
                                         pj_ioqueue_op_key_t *send_key,
                                         const void *pkt,
                                         unsigned pkt_len,
                                         unsigned flag,
                                         const pj_sockaddr_t *dst_addr,
                                         unsigned addr_len);

PJ_END_DECL


#endif  /* __PJNATH_STUN_SOCK_H__ */