Poster of Linux kernelThe best gift for a Linux geek
eXosip2 configuration API

eXosip2 configuration API

Section: libeXosip2 (3) Updated: Tue Sep 21 2010
Local index Up
 

NAME

eXosip2 configuration API -  

Functions


int eXosip_init (void)

void eXosip_quit (void)

int eXosip_execute (void)

int eXosip_set_option (eXosip_option opt, const void *value)

int eXosip_lock (void)

int eXosip_unlock (void)

int eXosip_get_srv_record (struct osip_srv_record *record, char *domain, char *protocol)

int eXosip_get_naptr (char *domain, char *protocol, char *srv_record, int max_length)

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

int eXosip_set_socket (int transport, int socket, int port)

void eXosip_set_user_agent (const char *user_agent)

const char * eXosip_get_version (void)

int eXosip_set_cbsip_message (CbSipCallback cbsipCallback)

void eXosip_enable_ipv6 (int ipv6_enable)

void eXosip_masquerade_contact (const char *public_address, int port)

int eXosip_find_free_port (int free_port, int transport)
 

Function Documentation

 

int eXosip_init (void)Initiate the eXtented oSIP library.

 

void eXosip_quit (void)Release ressource used by the eXtented oSIP library.

 

int eXosip_execute (void)Process (non-threaded mode ONLY) eXosip events.

 

int eXosip_set_option (eXosip_option opt, const void * value)Set eXosip options. See eXosip_option for available options.

Parameters:

opt option to configure.
value value for options.

 

int eXosip_lock (void)Lock the eXtented oSIP library.

 

int eXosip_unlock (void)UnLock the eXtented oSIP library.

 

int eXosip_get_srv_record (struct osip_srv_record * record, char * domain, char * protocol)Ask for SRV record.

Parameters:

record result structure.
domain domain name for SRV record
protocol protocol to use

 

int eXosip_get_naptr (char * domain, char * protocol, char * srv_record, int max_length)Ask for NAPTR request.

Parameters:

domain domain name for SRV record
protocol protocol to use
srv_record result structure.
max_length sizeof srv_record.

 

int eXosip_listen_addr (int transport, const char * addr, int port, int family, int secure)Listen on a specified socket.

Parameters:

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_set_socket (int transport, int socket, int port)Listen on a specified socket.

Parameters:

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 (const char * user_agent)Set the SIP User-Agent: header string.

Parameters:

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 (CbSipCallback cbsipCallback)Set a callback to get sent and received SIP messages.

Parameters:

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 (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:

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 (int free_port, int transport)This method is used to find out an free IPPROTO_UDP or IPPROTO_TCP port.

Parameters:

free_port initial port for search.
transport IPPROTO_UDP or IPPROTO_TCP protocol.

 

Author

Generated automatically by Doxygen for libeXosip2 from the source code.


 

Index

NAME
Functions
Function Documentation
int eXosip_init (void)Initiate the eXtented oSIP library.
void eXosip_quit (void)Release ressource used by the eXtented oSIP library.
int eXosip_execute (void)Process (non-threaded mode ONLY) eXosip events.
int eXosip_set_option (eXosip_option opt, const void * value)Set eXosip options. See eXosip_option for available options.
int eXosip_lock (void)Lock the eXtented oSIP library.
int eXosip_unlock (void)UnLock the eXtented oSIP library.
int eXosip_get_srv_record (struct osip_srv_record * record, char * domain, char * protocol)Ask for SRV record.
int eXosip_get_naptr (char * domain, char * protocol, char * srv_record, int max_length)Ask for NAPTR request.
int eXosip_listen_addr (int transport, const char * addr, int port, int family, int secure)Listen on a specified socket.
int eXosip_set_socket (int transport, int socket, int port)Listen on a specified socket.
void eXosip_set_user_agent (const char * user_agent)Set the SIP User-Agent: header string.
const char* eXosip_get_version (void)Get the eXosip version as a sring
int eXosip_set_cbsip_message (CbSipCallback cbsipCallback)Set a callback to get sent and received SIP messages.
void eXosip_enable_ipv6 (int ipv6_enable)Use IPv6 instead of IPv4.
void eXosip_masquerade_contact (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.
int eXosip_find_free_port (int free_port, int transport)This method is used to find out an free IPPROTO_UDP or IPPROTO_TCP port.
Author

This document was created by man2html, using the manual pages.
Time: 21:45:45 GMT, April 16, 2011