amsip network interface
[General purpose API.]


Functions

int am_network_start (const char *transport, int port)
int am_network_start_http_tunnel (int port)
int am_network_start_automatic (const char *identity, const char *proxy, int port)
int am_network_test_registration (const char *sip_identity, const char *sip_proxy, int sip_port, struct auto_setup *autosetup)
int am_network_ping_server (const char *identity, const char *proxy, struct auto_setup *autosetup)
int am_network_connection_tests (struct stun_test *stuntest, char *stun_server, int srcport)
int am_network_add_local_candidates (struct SdpCandidate *_candidates, int srcport)
int am_network_add_stun_candidates (struct SdpCandidate *candidates, char *stun_server, int srcport)
int am_network_add_turn_candidates (struct SdpCandidate *candidates, char *turn_server, int srcport)
int am_network_add_relay_candidates (struct SdpCandidate *candidates, char *relay_server, int srcport)
char * am_network_test_nat (const char *stun_server, int port, const char *proxy)
char * am_network_get_nat_info (char *stun_server, int srcport)
int am_network_get_nat (char *stun_server, int srcport)

Function Documentation

int am_network_start ( const char *  transport,
int  port 
)

Configure amsip to listen on a specific transport layer.

Parameters:
transport Transport Protocol to use ("UDP" or "TCP")
port Local port to use for socket. (0 for random port)

int am_network_start_http_tunnel ( int  port  ) 

Configure amsip to listen on a specific transport layer.

Parameters:
port Local port to use for socket. (0 for random port)

int am_network_start_automatic ( const char *  identity,
const char *  proxy,
int  port 
)

Configure amsip to detect and start network connection to proxy.

Parameters:
identity identity to use for test message to proxy
proxy proxy to use for test message
port Local port to use for socket. (0 for random port)

int am_network_test_registration ( const char *  sip_identity,
const char *  sip_proxy,
int  sip_port,
struct auto_setup *  autosetup 
)

Send a SIP message to server and see if response is received. This test automatically detects: IP/PORT of firewall to use in Contact headers of REGISTER and INVITE. realm used on proxy.

This test will not give proper results if outbound proxy is used.

Parameters:
sip_identity identity to use for From and To header.
sip_proxy proxy to use for SIP message.
sip_port port to use for local agent.
autosetup --futur use--.

int am_network_ping_server ( const char *  identity,
const char *  proxy,
struct auto_setup *  autosetup 
)

Send a SIP message to server and see if response is received.

Parameters:
identity identity to use for From and To header.
proxy proxy to use for SIP message.
autosetup --futur use--.

int am_network_connection_tests ( struct stun_test *  stuntest,
char *  stun_server,
int  srcport 
)

Test NAT type.

Parameters:
stuntest element to receive all stun test.
stun_server Stun server to use for NAT traversal solution.
srcport Local port to use for socket. (0 for random port)

int am_network_add_local_candidates ( struct SdpCandidate *  _candidates,
int  srcport 
)

Add local candidates.

Parameters:
_candidates Table for 10 local candidates.
srcport Local port to use for socket. (0 for random port)

int am_network_add_stun_candidates ( struct SdpCandidate *  candidates,
char *  stun_server,
int  srcport 
)

Add Stun candidate.

Parameters:
candidates candidates to receive all stun candidates.
stun_server Stun server to use for NAT traversal solution.
srcport Local port to use for socket. (0 for random port)

int am_network_add_turn_candidates ( struct SdpCandidate *  candidates,
char *  turn_server,
int  srcport 
)

Add TURN candidate.

Parameters:
candidates candidates to receive all turn candidates.
turn_server TURN server to use for NAT traversal solution.
srcport Local port to use for socket. (0 for random port)

int am_network_add_relay_candidates ( struct SdpCandidate *  candidates,
char *  relay_server,
int  srcport 
)

Add RELAY candidate.

Parameters:
candidates candidates to receive all turn candidates.
relay_server STUN server to use for NAT traversal solution.
srcport Local port to use for socket. (0 for random port)

char* am_network_test_nat ( const char *  stun_server,
int  port,
const char *  proxy 
)

Test NAT type.

Parameters:
stun_server Stun server to use for NAT traversal solution.
port Local port to use for socket. (0 for random port)
proxy SIP Proxy Address (used to determine which interface to test)

char* am_network_get_nat_info ( char *  stun_server,
int  srcport 
)

Return text information on NAT type.

Parameters:
stun_server Stun server to use for NAT traversal solution.
srcport Local port to use for socket. (0 for random port)

int am_network_get_nat ( char *  stun_server,
int  srcport 
)

Return binary information on NAT type.

Parameters:
stun_server Stun server to use for NAT traversal solution.
srcport Local port to use for socket. (0 for random port)


Generated on Sun Dec 10 18:54:29 2006 for libamsip by  doxygen 1.4.7