eXosip2 configuration API

General purpose API.

Data Structures

struct  
eXosip_dns_cache

struct  
eXosip_tls_credentials_s

struct  
eXosip_tls_ctx_s

Macros

#define 
EXOSIP_OPT_UDP_KEEP_ALIVE   (EXOSIP_OPT_BASE_OPTION+1)

#define 
EXOSIP_OPT_UDP_LEARN_PORT   (EXOSIP_OPT_BASE_OPTION+2)

#define 
EXOSIP_OPT_USE_RPORT   (EXOSIP_OPT_BASE_OPTION+7)

#define 
EXOSIP_OPT_SET_IPV4_FOR_GATEWAY   (EXOSIP_OPT_BASE_OPTION+8)

#define 
EXOSIP_OPT_ADD_DNS_CACHE   (EXOSIP_OPT_BASE_OPTION+9)

#define 
EXOSIP_OPT_DELETE_DNS_CACHE   (EXOSIP_OPT_BASE_OPTION+10)

#define 
EXOSIP_OPT_SET_IPV6_FOR_GATEWAY   (EXOSIP_OPT_BASE_OPTION+12)

#define 
EXOSIP_OPT_ADD_ACCOUNT_INFO   (EXOSIP_OPT_BASE_OPTION+13)

#define 
EXOSIP_OPT_DNS_CAPABILITIES   (EXOSIP_OPT_BASE_OPTION+14)

#define 
EXOSIP_OPT_SET_DSCP   (EXOSIP_OPT_BASE_OPTION+15)

#define 
EXOSIP_OPT_REGISTER_WITH_DATE   (EXOSIP_OPT_BASE_OPTION+16)

#define 
EXOSIP_OPT_SET_HEADER_USER_AGENT   (EXOSIP_OPT_BASE_OPTION+17)

#define 
EXOSIP_OPT_SET_TLS_VERIFY_CERTIFICATE   (EXOSIP_OPT_BASE_OPTION+500)

#define 
EXOSIP_OPT_SET_TLS_CERTIFICATES_INFO   (EXOSIP_OPT_BASE_OPTION+501)

#define 
EXOSIP_OPT_SET_TLS_CLIENT_CERTIFICATE_NAME   (EXOSIP_OPT_BASE_OPTION+502)

#define 
EXOSIP_OPT_SET_TLS_SERVER_CERTIFICATE_NAME   (EXOSIP_OPT_BASE_OPTION+503)

Enumerations

enum  
eXosip_tls_ctx_error {
TLS_OK = 0,
TLS_ERR_NO_RAND = -1,
TLS_ERR_NO_DH_PARAM = -2,
TLS_ERR_NO_PW = -3,
TLS_ERR_NO_ROOT_CA = -4,
TLS_ERR_MISSING_AUTH_PART = -5
}

Functions

struct eXosip_t * 
eXosip_malloc (void)

int 
eXosip_init (struct eXosip_t *excontext)

void 
eXosip_quit (struct eXosip_t *excontext)

int 
eXosip_lock (struct eXosip_t *excontext)

int 
eXosip_unlock (struct eXosip_t *excontext)

int 
eXosip_execute (struct eXosip_t *excontext)

int 
eXosip_set_option (struct eXosip_t *excontext, int opt, const void *value)

struct osip_naptr * 
eXosip_dnsutils_naptr (struct eXosip_t *excontext, const char *domain, const char *protocol, const char *transport, int keep_in_cache)

int 
eXosip_dnsutils_dns_process (struct osip_naptr *output_record, int force)

int 
eXosip_dnsutils_rotate_srv (struct osip_srv_record *output_record)

int 
eXosip_listen_addr (struct eXosip_t *excontext, int transport, const char *addr, int port, int family, int secure)

int 
eXosip_reset_transports (struct eXosip_t *excontext)

int 
eXosip_set_socket (struct eXosip_t *excontext, int transport, int socket, int port)

void 
eXosip_set_user_agent (struct eXosip_t *excontext, const char *user_agent)

const char * 
eXosip_get_version (void)

int 
eXosip_set_cbsip_message (struct eXosip_t *excontext, CbSipCallback cbsipCallback)

void 
eXosip_enable_ipv6 (int ipv6_enable)

void 
eXosip_masquerade_contact (struct eXosip_t *excontext, const char *public_address, int port)

int 
eXosip_find_free_port (struct eXosip_t *excontext, int free_port, int transport)

Detailed Description

Macro Definition Documentation

#define EXOSIP_OPT_UDP_KEEP_ALIVE   (EXOSIP_OPT_BASE_OPTION+1)

int *: interval for keep alive packets (UDP, TCP, TLS, DTLS)

#define EXOSIP_OPT_UDP_LEARN_PORT   (EXOSIP_OPT_BASE_OPTION+2)

int *: specific re-usage of "rport"

#define EXOSIP_OPT_USE_RPORT   (EXOSIP_OPT_BASE_OPTION+7)

int *: enable or disable rport in via

#define EXOSIP_OPT_SET_IPV4_FOR_GATEWAY   (EXOSIP_OPT_BASE_OPTION+8)

char *: usually, this is the proxy address

#define EXOSIP_OPT_ADD_DNS_CACHE   (EXOSIP_OPT_BASE_OPTION+9)

struct eXosip_dns_cache *: force some cache entry to avoid DNS

#define EXOSIP_OPT_DELETE_DNS_CACHE   (EXOSIP_OPT_BASE_OPTION+10)

struct eXosip_dns_cache *: force removal of some cache entry to avoid DNS

#define EXOSIP_OPT_SET_IPV6_FOR_GATEWAY   (EXOSIP_OPT_BASE_OPTION+12)

char *: usually, this is the proxy address

#define EXOSIP_OPT_ADD_ACCOUNT_INFO   (EXOSIP_OPT_BASE_OPTION+13)

struct eXosip_account_info *: internal stuff

#define EXOSIP_OPT_DNS_CAPABILITIES   (EXOSIP_OPT_BASE_OPTION+14)

int *: 0 to disable, 2 to use NAPTR/SRV record

#define EXOSIP_OPT_SET_DSCP   (EXOSIP_OPT_BASE_OPTION+15)

int *: set a dscp value for SIP socket

#define EXOSIP_OPT_REGISTER_WITH_DATE   (EXOSIP_OPT_BASE_OPTION+16)

int *: enable usage of Date header in REGISTER

#define EXOSIP_OPT_SET_HEADER_USER_AGENT   (EXOSIP_OPT_BASE_OPTION+17)

char *: set the User-Agent header

#define EXOSIP_OPT_SET_TLS_VERIFY_CERTIFICATE   (EXOSIP_OPT_BASE_OPTION+500)

int *: enable verification of certificate for TLS connection

#define EXOSIP_OPT_SET_TLS_CERTIFICATES_INFO   (EXOSIP_OPT_BASE_OPTION+501)

eXosip_tls_ctx_t *: client and/or server certificate/ca-root/key info

#define EXOSIP_OPT_SET_TLS_CLIENT_CERTIFICATE_NAME   (EXOSIP_OPT_BASE_OPTION+502)

char*: user can choose a specific certifcate present in Windows Certificate Store

#define EXOSIP_OPT_SET_TLS_SERVER_CERTIFICATE_NAME   (EXOSIP_OPT_BASE_OPTION+503)

char*: user can choose a specific certifcate present in Windows Certificate Store

Enumeration Type Documentation

enum eXosip_tls_ctx_error

An enumeration which describes the error which can occur while setting the eXosip_tls_ctx

Enumerator:

TLS_OK

yippieh, everything is fine :)

TLS_ERR_NO_RAND

no absolute path to the random file was specified

TLS_ERR_NO_DH_PARAM

no absolute path to the diifie hellman file was specified

TLS_ERR_NO_PW

no password was specified

TLS_ERR_NO_ROOT_CA

no absolute path to the rootCA file was specified

TLS_ERR_MISSING_AUTH_PART

something is missing: the private key or the certificate

Function Documentation

struct eXosip_t* eXosip_malloc
(
void 
)

read

Allocate an eXosip context.

Returns
a new allocated eXosip_t instance.

int eXosip_init
(
struct eXosip_t * 
excontext
)

Initiate the eXtented oSIP library.

Parameters

excontext
eXosip_t instance.

void eXosip_quit
(
struct eXosip_t * 
excontext
)

Release ressource used by the eXtented oSIP library.

Parameters

excontext
eXosip_t instance.

int eXosip_lock
(
struct eXosip_t * 
excontext
)

Lock the eXtented oSIP library.

Parameters

excontext
eXosip_t instance.

int eXosip_unlock
(
struct eXosip_t * 
excontext
)

UnLock the eXtented oSIP library.

Parameters

excontext
eXosip_t instance.

int eXosip_execute
(
struct eXosip_t * 
excontext
)

Process (non-threaded mode ONLY) eXosip events.

Parameters

excontext
eXosip_t instance.

int eXosip_set_option
(
struct eXosip_t * 
excontext,

int 
opt,

const void * 
value

)

Set eXosip options. See eXosip_option for available options.

Parameters

excontext
eXosip_t instance.

opt
option to configure.

value
value for options.

struct osip_naptr* eXosip_dnsutils_naptr
(
struct eXosip_t * 
excontext,

const char * 
domain,

const char * 
protocol,

const char * 
transport,

int 
keep_in_cache

)

read

Start and return osip_naptr context. Note that DNS results might not yet be available.

Parameters

excontext
eXosip_t instance.

domain
domain name for NAPTR record

protocol
protocol to use ("SIP")

transport
transport to use ("UDP")

keep_in_cache
keep result in cache if >0

int eXosip_dnsutils_dns_process
(
struct osip_naptr * 
output_record,

int 
force

)

Continue to process asynchronous DNS request (if implemented).

Parameters

output_record
result structure.

force
force waiting for final answer if >0

int eXosip_dnsutils_rotate_srv
(
struct osip_srv_record * 
output_record
)

Rotate first SRV entry to last SRV entry.

Parameters

output_record
result structure.

int eXosip_listen_addr
(
struct eXosip_t * 
excontext,

int 
transport,

const char * 
addr,

int 
port,

int 
family,

int 
secure

)

Listen on a specified socket.

Parameters

excontext
eXosip_t instance.

transport
IPPROTO_UDP for udp. (soon to come: TCP/TLS?)

addr
the address to bind (NULL for all interface)

port
the listening port. (0 for random port)

family
the IP family (AF_INET or AF_INET6).

secure
0 for UDP or TCP, 1 for TLS (with TCP).

int eXosip_reset_transports
(
struct eXosip_t * 
excontext
)

Reset transport sockets.

Parameters

excontext
eXosip_t instance.

int eXosip_set_socket
(
struct eXosip_t * 
excontext,

int 
transport,

int 
socket,

int 
port

)

Listen on a specified socket.

Parameters

excontext
eXosip_t instance.

transport
IPPROTO_UDP for udp. (soon to come: TCP/TLS?)

socket
socket to use for listening to UDP sip messages.

port
the listening port for masquerading.

void eXosip_set_user_agent
(
struct eXosip_t * 
excontext,

const char * 
user_agent

)

Set the SIP User-Agent: header string.

Parameters

excontext
eXosip_t instance.

user_agent
the User-Agent header to insert in messages.

const char* eXosip_get_version
(
void 
)

Get the eXosip version as a sring

int eXosip_set_cbsip_message
(
struct eXosip_t * 
excontext,

CbSipCallback 
cbsipCallback

)

Set a callback to get sent and received SIP messages.

Parameters

excontext
eXosip_t instance.

cbsipCallback
the callback to retreive messages.

void eXosip_enable_ipv6
(
int 
ipv6_enable
)

Use IPv6 instead of IPv4.

Parameters

ipv6_enable
This paramter should be set to 1 to enable IPv6 mode.

void eXosip_masquerade_contact
(
struct eXosip_t * 
excontext,

const char * 
public_address,

int 
port

)

This method is used to replace contact address with the public address of your NAT. The ip address should be retreived manually (fixed IP address) or with STUN. This address will only be used when the remote correspondant appears to be on an DIFFERENT LAN.

Parameters

excontext
eXosip_t instance.

public_address
the ip address.

port
the port for masquerading.

If set to NULL, then the local ip address will be guessed automatically (returns to default mode).

int eXosip_find_free_port
(
struct eXosip_t * 
excontext,

int 
free_port,

int 
transport

)

This method is used to find out an free IPPROTO_UDP or IPPROTO_TCP port.

Parameters

excontext
eXosip_t instance.

free_port
initial port for search.

transport
IPPROTO_UDP or IPPROTO_TCP protocol.

libeXosip2(2-1) -- eXosip2 configuration API的更多相关文章

  1. libeXosip2(2-3) -- eXosip2 event API

    eXosip2 event API General purpose API. Data Structures struct   eXosip_event Enumerations enum   eXo ...

  2. libeXosip2(2-2) -- eXosip2 network API

    eXosip2 network API General purpose API. Functions int  eXosip_transport_set (osip_message_t *msg, c ...

  3. ASP.NET Web.config文件的配置(Configuration API)

    本次我们讨论主要聚焦在以下Web.config配置文件的设置值的读取. 1.<connectionString />连接字符串的读取. 2.<appSettings />应用程 ...

  4. libeXosip2(2) -- General purpose API.

    General purpose API. general purpose API in libeXosip2-4.0.0. More... Modules eXosip2 configuration ...

  5. libeXosip2(1) -- Modules

    Modules Here is a list of all modules: [detail level 12] The eXtented eXosip stack LibeXosip2 Versio ...

  6. libeXosip2(3) -- SIP messages and call control API

    SIP messages and call control API The SIP messages and call control API. More... Modules eXosip2 INV ...

  7. Hadoop源码之Configuration

    本文hadoop版本为最新版本2.6.Configuration做为Hadoop的一个基础功能承担着重要的责任,为Yarn.HSFS.MapReduce.NFS.调度器等提供参数的配置.配置文件的分布 ...

  8. asp.net core 系列 10 配置configuration (上)

    一.  ASP.NET Core 中的配置概述 ASP.NET Core 中的应用配置是基于键值对,由configuration 程序提供. configuration  将从各种配置源提供程序操作键 ...

  9. asp.net core 系列之Configuration

    在ASP.NET Core中的App configuration 是通过configuration providers基于key-value对建立的.Configuration providers读取 ...

随机推荐

  1. .net常考面试题

    1. 简述 private. protected. public. internal 修饰符的访问权限. 答 . private : 私有成员, 在类的内部才可以访问. protected : 保护成 ...

  2. windows 查看端口被占用

    C:\Users\xxxx> 根据端口找到进程14716 C:\Users\xxxx>tasklist|findstr "14716"node.exe 14716 Co ...

  3. 关于win8开发的一点小总结

    我今天做画面的时候,发现了一点小问题. 我在xmal文件里面加了一个CheckBox控件,设置IsChecked属性为True,并添加了Checked事件.Checked事件里面有对另外一个TextB ...

  4. NetAnalyzer笔记 之 一. 开篇语

    [创建时间:2015-08-26 22:00:12] NetAnalyzer下载地址 第一次写技术相关的博客,不足之处还请担待并告知. 在开始之前,先简单介绍一下NetAnalyzer, NetAna ...

  5. hdu1047(模拟大量的循环添加)

    标题信息:总结多个大整数,(使用add循环相加的功能) http://acm.hdu.edu.cn/showproblem.php? pid=1047 AC代码: /**  *大数的循环加法,转化为字 ...

  6. 解决如何让AsyncTask终止操作

    受到这个的启发终于结局了如何在AsyncTask运行中终止其操作. 单纯的onCancelled(true)是不行的 下面把代码贴出来~实现了登陆功能. AsyncTask简介,它使创建需要与用户界面 ...

  7. fread(),fwrite() 读/写流

    C 库函数 - fread() 描述 C 库函数 size_t fread(void *ptr, size_t size, size_t nmemb, FILE *stream) 从给定流 strea ...

  8. oracle学习笔记(二)表的查询

    --oracle表的管理 --创建表 )); --删除表 drop table users; --创建表 ),xm ),sex ),birthday date,sal ,)); ),cnmae )); ...

  9. [原创]旧事重提:只配置参数实现OAuth2登录

    其实这个组件写出来很长时间了,有几个月吧,一直在 MrHuo工作室  上放着,一直说要整理,太忙没时间. 另外,关于OAuth2的一些基础内容还请从网上找找资料,太多了,写的累赘. 废话不多说,先上图 ...

  10. poj3258 二分 最小值最大化问题

    River Hopscotch Time Limit: 2000MS   Memory Limit: 65536K Total Submissions: 10842   Accepted: 4654 ...