eXosip2 configuration API
[General purpose API.]


Functions

int eXosip_init (void)
void eXosip_quit (void)
int eXosip_set_option (eXosip_option opt, const void *value)
int eXosip_lock (void)
int eXosip_unlock (void)
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)
void eXosip_enable_ipv6 (int ipv6_enable)
void eXosip_masquerade_contact (const char *public_address, int port)

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_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_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.

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).


Generated on Wed Jun 21 00:44:53 2006 for libeXosip2 by  doxygen 1.4.6