|
|
|
libnice Reference Manual | |
|---|---|---|---|---|
#include <agent.h>
NiceAgent;
enum NiceComponentState;
enum NiceComponentType;
enum NiceProxyType;
enum NiceCompatibility;
void (*NiceAgentRecvFunc) (NiceAgent *agent,
guint stream_id,
guint component_id,
guint len,
gchar *buf,
gpointer user_data);
#define NICE_AGENT_MAX_REMOTE_CANDIDATES
NiceAgent* nice_agent_new (GMainContext *ctx,
NiceCompatibility compat);
gboolean nice_agent_add_local_address (NiceAgent *agent,
NiceAddress *addr);
guint nice_agent_add_stream (NiceAgent *agent,
guint n_components);
void nice_agent_remove_stream (NiceAgent *agent,
guint stream_id);
gboolean nice_agent_set_relay_info (NiceAgent *agent,
guint stream_id,
guint component_id,
const gchar *server_ip,
guint server_port,
const gchar *username,
const gchar *password,
NiceRelayType type);
void nice_agent_gather_candidates (NiceAgent *agent,
guint stream_id);
gboolean nice_agent_set_remote_credentials (NiceAgent *agent,
guint stream_id,
const gchar *ufrag,
const gchar *pwd);
gboolean nice_agent_get_local_credentials (NiceAgent *agent,
guint stream_id,
gchar **ufrag,
gchar **pwd);
int nice_agent_set_remote_candidates (NiceAgent *agent,
guint stream_id,
guint component_id,
const GSList *candidates);
GSList* nice_agent_get_remote_candidates (NiceAgent *agent,
guint stream_id,
guint component_id);
GSList* nice_agent_get_local_candidates (NiceAgent *agent,
guint stream_id,
guint component_id);
gint nice_agent_send (NiceAgent *agent,
guint stream_id,
guint component_id,
guint len,
const gchar *buf);
gboolean nice_agent_attach_recv (NiceAgent *agent,
guint stream_id,
guint component_id,
GMainContext *ctx,
NiceAgentRecvFunc func,
gpointer data);
gboolean nice_agent_set_selected_pair (NiceAgent *agent,
guint stream_id,
guint component_id,
const gchar *lfoundation,
const gchar *rfoundation);
gboolean nice_agent_set_selected_remote_candidate
(NiceAgent *agent,
guint stream_id,
guint component_id,
NiceCandidate *candidate);
void nice_agent_set_stream_tos (NiceAgent *agent,
guint stream_id,
gint tos);
gboolean nice_agent_restart (NiceAgent *agent);
"compatibility" guint : Read / Write / Construct Only "controlling-mode" gboolean : Read / Write "full-mode" gboolean : Read / Write / Construct Only "main-context" gpointer : Read / Write / Construct Only "max-connectivity-checks" guint : Read / Write "proxy-ip" gchar* : Read / Write "proxy-password" gchar* : Read / Write "proxy-port" guint : Read / Write "proxy-type" guint : Read / Write "proxy-username" gchar* : Read / Write "stun-pacing-timer" guint : Read / Write / Construct Only "stun-server" gchar* : Read / Write "stun-server-port" guint : Read / Write "upnp" gboolean : Read / Write / Construct "upnp-timeout" guint : Read / Write / Construct
"candidate-gathering-done" : Run Last "component-state-changed" : Run Last "initial-binding-request-received" : Run Last "new-candidate" : Run Last "new-remote-candidate" : Run Last "new-selected-pair" : Run Last
The NiceAgent is your main object when using libnice. It is the agent that will take care of everything relating to ICE. It will take care of discovering your local candidates and do connectivity checks to create a stream of data between you and your peer.
Example 1. Simple example on how to use libnice
guint stream_id;
gchar buffer[] = "hello world!";
GSList *lcands = NULL;
// Create a nice agent
NiceAgent *agent = nice_agent_new (NULL, NICE_COMPATIBILITY_DRAFT19);
// Connect the signals
g_signal_connect (G_OBJECT (agent), "candidate-gathering-done",
G_CALLBACK (cb_candidate_gathering_done), NULL);
g_signal_connect (G_OBJECT (agent), "component-state-changed",
G_CALLBACK (cb_component_state_changed), NULL);
g_signal_connect (G_OBJECT (agent), "new-selected-pair",
G_CALLBACK (cb_new_selected_pair), NULL);
// Create a new stream with one component and start gathering candidates
stream_id = nice_agent_add_stream (agent, 1);
nice_agent_gather_candidates (agent, stream_id);
// Attach to the component to receive the data
nice_agent_attach_recv (agent, stream_id, 1, NULL,
cb_nice_recv, NULL);
// ... Wait until the signal candidate-gathering-done is fired ...
lcands = nice_agent_get_local_candidates(agent, stream_id, 1);
// ... Send local candidates to the peer and set the peer's remote candidates
nice_agent_set_remote_candidates (agent, stream_id, 1, rcands);
// ... Wait until the signal new-selected-pair is fired ...
// Send our message!
nice_agent_send (agent, stream_id, 1, sizeof(buffer), buffer);
// Anything received will be received through the cb_nice_recv callback
// Destroy the object
g_object_unref(agent);
typedef struct _NiceAgent NiceAgent;
The NiceAgent is the main GObject of the libnice library and represents the ICE agent.
typedef enum
{
NICE_COMPONENT_STATE_DISCONNECTED,
NICE_COMPONENT_STATE_GATHERING,
NICE_COMPONENT_STATE_CONNECTING,
NICE_COMPONENT_STATE_CONNECTED,
NICE_COMPONENT_STATE_READY,
NICE_COMPONENT_STATE_FAILED,
NICE_COMPONENT_STATE_LAST
} NiceComponentState;
An enum representing the state of a component.
See also: "component-state-changed"
typedef enum
{
NICE_COMPONENT_TYPE_RTP = 1,
NICE_COMPONENT_TYPE_RTCP = 2
} NiceComponentType;
Convenience enum representing the type of a component for use as the component_id for RTP/RTCP usages.
typedef enum
{
NICE_PROXY_TYPE_NONE = 0,
NICE_PROXY_TYPE_SOCKS5,
NICE_PROXY_TYPE_HTTP,
NICE_PROXY_TYPE_LAST = NICE_PROXY_TYPE_HTTP,
} NiceProxyType;
An enum to specify which proxy type to use for relaying. Note that the proxies will only be used with TCP TURN relaying.
See also: "proxy-type"
typedef enum
{
NICE_COMPATIBILITY_DRAFT19 = 0,
NICE_COMPATIBILITY_GOOGLE,
NICE_COMPATIBILITY_MSN,
NICE_COMPATIBILITY_WLM2009,
NICE_COMPATIBILITY_LAST = NICE_COMPATIBILITY_WLM2009
} NiceCompatibility;
An enum to specify which compatible specifications the NiceAgent should use.
Use with nice_agent_new()
void (*NiceAgentRecvFunc) (NiceAgent *agent, guint stream_id, guint component_id, guint len, gchar *buf, gpointer user_data);
Callback function when data is received on a component
agent : |
The NiceAgent Object |
stream_id : |
The id of the stream |
component_id : |
The id of the component of the stream which received the data |
len : |
The length of the data |
buf : |
The buffer containing the data received |
user_data : |
The user data set in nice_agent_attach_recv()
|
#define NICE_AGENT_MAX_REMOTE_CANDIDATES 25
A hard limit for the number of remote candidates. This limit is enforced to protect against malevolent remote clients.
NiceAgent* nice_agent_new (GMainContext *ctx, NiceCompatibility compat);
Create a new NiceAgent.
The returned object must be freed with g_object_unref()
ctx : |
The Glib Mainloop Context to use for timers |
compat : |
The compatibility mode of the agent |
| Returns : | The new agent GObject |
gboolean nice_agent_add_local_address (NiceAgent *agent, NiceAddress *addr);
Add a local address from which to derive local host candidates
agent : |
The NiceAgent Object |
addr : |
The address to listen to If the port is 0, then a random port will be chosen by the system |
| Returns : | TRUE on success, FALSE on fatal (memory allocation) errors
|
guint nice_agent_add_stream (NiceAgent *agent, guint n_components);
Adds a data stream to agent containing n_components components.
agent : |
The NiceAgent Object |
n_components : |
The number of components to add to the stream |
| Returns : | The ID of the new stream, 0 on failure |
void nice_agent_remove_stream (NiceAgent *agent, guint stream_id);
Remove and free a previously created data stream from agent
agent : |
The NiceAgent Object |
stream_id : |
The ID of the stream to remove |
gboolean nice_agent_set_relay_info (NiceAgent *agent, guint stream_id, guint component_id, const gchar *server_ip, guint server_port, const gchar *username, const gchar *password, NiceRelayType type);
Sets the settings for using a relay server during the candidate discovery.
agent : |
The NiceAgent Object |
stream_id : |
The ID of the stream |
component_id : |
The ID of the component |
server_ip : |
The IP address of the TURN server |
server_port : |
The port of the TURN server |
username : |
The TURN username to use for the allocate |
password : |
The TURN password to use for the allocate |
type : |
The type of relay to use |
| Returns : | TRUE if the TURN settings were accepted.
FALSE if the address was invalid.
|
void nice_agent_gather_candidates (NiceAgent *agent, guint stream_id);
Start the candidate gathering process. Once done, "candidate-gathering-done" is called for the stream
Local addresses can be previously set with nice_agent_add_local_address()
If no local address was previously added, then the nice agent will
automatically detect the local address using nice_interfaces_get_local_ips()
agent : |
The NiceAgent Object |
stream_id : |
The id of the stream to start |
gboolean nice_agent_set_remote_credentials (NiceAgent *agent, guint stream_id, const gchar *ufrag, const gchar *pwd);
Sets the remote credentials for stream stream_id.
Stream credentials do not override per-candidate credentials if set
agent : |
The NiceAgent Object |
stream_id : |
The ID of the stream |
ufrag : |
NULL-terminated string containing an ICE username fragment (length must be between 22 and 256 chars) |
pwd : |
NULL-terminated string containing an ICE password (length must be between 4 and 256 chars) |
| Returns : | TRUE on success, FALSE on error.
|
gboolean nice_agent_get_local_credentials (NiceAgent *agent, guint stream_id, gchar **ufrag, gchar **pwd);
Gets the local credentials for stream stream_id.
agent : |
The NiceAgent Object |
stream_id : |
The ID of the stream |
ufrag : |
a pointer to a NULL-terminated string containing
an ICE username fragment [OUT].
This string must be freed with g_free()
|
pwd : |
a pointer to a NULL-terminated string containing an ICE
password [OUT]
This string must be freed with g_free()
|
| Returns : | TRUE on success, FALSE on error.
|
int nice_agent_set_remote_candidates (NiceAgent *agent, guint stream_id, guint component_id, const GSList *candidates);
Sets, adds or updates the remote candidates for a component of a stream.
NICE_AGENT_MAX_REMOTE_CANDIDATES is the absolute maximum limit for remote candidates.
You must first call nice_agent_gather_candidates() and wait for the
"candidate-gathering-done" signale before
calling nice_agent_set_remote_candidates()
agent : |
The NiceAgent Object |
stream_id : |
The ID of the stream the candidates are for |
component_id : |
The ID of the component the candidates are for |
candidates : |
a GList of NiceCandidate items describing each candidate to add |
| Returns : | The number of candidates added, negative on errors (memory allocation or if the local candidates are not done gathering yet) |
GSList* nice_agent_get_remote_candidates (NiceAgent *agent, guint stream_id, guint component_id);
Get a list of the remote candidates set on a stream's component
The caller owns the returned GSList but not the candidates contained within it.
The list of remote candidates can change during processing. The client should register for the "new-remote-candidate" signal to get notified of new remote candidates.
agent : |
The NiceAgent Object |
stream_id : |
The ID of the stream |
component_id : |
The ID of the component |
| Returns : | a GSList of NiceCandidates objects representing
the remote candidates set on the agent
|
GSList* nice_agent_get_local_candidates (NiceAgent *agent, guint stream_id, guint component_id);
Retreive from the agent the list of all local candidates for a stream's component
The caller owns the returned GSList as well as the candidates contained within it. To get full results, the client should wait for the "candidates-gathering-done" signal.
agent : |
The NiceAgent Object |
stream_id : |
The ID of the stream |
component_id : |
The ID of the component |
| Returns : | a GSList of NiceCandidate objects representing
the local candidates of agent
|
gint nice_agent_send (NiceAgent *agent, guint stream_id, guint component_id, guint len, const gchar *buf);
Sends a data payload over a stream's component.
Component state MUST be NICE_COMPONENT_STATE_READY, or as a special case, in any state if component was in READY state before and was then restarted
agent : |
The NiceAgent Object |
stream_id : |
The ID of the stream to send to |
component_id : |
The ID of the component to send to |
len : |
The length of the buffer to send |
buf : |
The buffer of data to send |
| Returns : | The number of bytes sent, or negative error code |
gboolean nice_agent_attach_recv (NiceAgent *agent, guint stream_id, guint component_id, GMainContext *ctx, NiceAgentRecvFunc func, gpointer data);
Attaches the stream's component's sockets to the Glib Mainloop Context in order to be notified whenever data becomes available for a component.
agent : |
The NiceAgent Object |
stream_id : |
The ID of stream |
component_id : |
The ID of the component |
ctx : |
The Glib Mainloop Context to use for listening on the component |
func : |
The callback function to be called when data is received on the stream's component |
data : |
user data associated with the callback |
| Returns : | TRUE on success, FALSE if the stream or component IDs are invalid.
|
gboolean nice_agent_set_selected_pair (NiceAgent *agent, guint stream_id, guint component_id, const gchar *lfoundation, const gchar *rfoundation);
Sets the selected candidate pair for media transmission for a given stream's component. Calling this function will disable all further ICE processing (connection check, state machine updates, etc). Note that keepalives will continue to be sent.
agent : |
The NiceAgent Object |
stream_id : |
The ID of the stream |
component_id : |
The ID of the component |
lfoundation : |
The local foundation of the candidate to use |
rfoundation : |
The remote foundation of the candidate to use |
| Returns : | TRUE on success, FALSE if the candidate pair cannot be found
|
gboolean nice_agent_set_selected_remote_candidate
(NiceAgent *agent,
guint stream_id,
guint component_id,
NiceCandidate *candidate);
Sets the selected remote candidate for media transmission for a given stream's component. This is used to force the selection of a specific remote candidate even when connectivity checks are failing (e.g. non-ICE compatible candidates). Calling this function will disable all further ICE processing (connection check, state machine updates, etc). Note that keepalives will continue to be sent.
agent : |
The NiceAgent Object |
stream_id : |
The ID of the stream |
component_id : |
The ID of the component |
candidate : |
The NiceCandidate to select |
| Returns : | TRUE on success, FALSE on failure
|
void nice_agent_set_stream_tos (NiceAgent *agent, guint stream_id, gint tos);
Sets the IP_TOS and/or IPV6_TCLASS field on the stream's sockets' options
agent : |
The NiceAgent Object |
stream_id : |
The ID of the stream |
tos : |
The ToS to set |
gboolean nice_agent_restart (NiceAgent *agent);
Restarts the session as defined in ICE draft 19. This function needs to be called both when initiating (ICE spec section 9.1.1.1. "ICE Restarts"), as well as when reacting (spec section 9.2.1.1. "Detecting ICE Restart") to a restart.
agent : |
The NiceAgent Object |
| Returns : | TRUE on success FALSE on error
|
"compatibility" property"compatibility" guint : Read / Write / Construct Only
The Nice agent can work in various compatibility modes depending on what the application/peer needs.
See also: NiceCompatibility
Allowed values: <= 3
Default value: 0
"controlling-mode" property"controlling-mode" gboolean : Read / Write
Whether the agent is in controlling mode.
Default value: FALSE
"full-mode" property"full-mode" gboolean : Read / Write / Construct Only
Whether agent runs in ICE full mode.
Default value: TRUE
"main-context" property"main-context" gpointer : Read / Write / Construct Only
A GLib main context is needed for all timeouts used by libnice.
This is a property being set by the nice_agent_new() call.
"max-connectivity-checks" property"max-connectivity-checks" guint : Read / Write
Upper limit for the total number of connectivity checks performed.
Default value: 0
"proxy-ip" property"proxy-ip" gchar* : Read / Write
The proxy server used to bypass a proxy firewall.
Default value: NULL
"proxy-password" property"proxy-password" gchar* : Read / Write
The password used to authenticate with the proxy.
Default value: NULL
"proxy-port" property"proxy-port" guint : Read / Write
The Proxy server used to bypass a proxy firewall.
Allowed values: [1,65536]
Default value: 1
"proxy-type" property"proxy-type" guint : Read / Write
The type of proxy set in the proxy-ip property.
Allowed values: <= 2
Default value: 0
"proxy-username" property"proxy-username" gchar* : Read / Write
The username used to authenticate with the proxy.
Default value: NULL
"stun-pacing-timer" property"stun-pacing-timer" guint : Read / Write / Construct Only
Timer 'Ta' (msecs) used in the IETF ICE specification for pacing candidate gathering and sending of connectivity checks.
Allowed values: >= 1
Default value: 20
"stun-server" property"stun-server" gchar* : Read / Write
The STUN server used to obtain server-reflexive candidates.
Default value: NULL
"stun-server-port" property"stun-server-port" guint : Read / Write
The STUN server used to obtain server-reflexive candidates.
Allowed values: [1,65536]
Default value: 1
"upnp" property"upnp" gboolean : Read / Write / Construct
Whether the agent should use UPnP to open a port in the router and get the external IP.
Default value: TRUE
"candidate-gathering-done" signalvoid user_function (NiceAgent *stream_id, guint arg1, gpointer user_data) : Run Last
This signal is fired whenever a stream has finished gathering its
candidates after a call to nice_agent_gather_candidates()
stream_id : |
The ID of the stream |
user_data : |
user data set when the signal handler was connected. |
"component-state-changed" signalvoid user_function (NiceAgent *stream_id, guint component_id, guint state, guint arg3, gpointer user_data) : Run Last
This signal is fired whenever a component's state changes
stream_id : |
The ID of the stream |
component_id : |
The ID of the component |
state : |
The NiceComponentState of the component |
user_data : |
user data set when the signal handler was connected. |
"initial-binding-request-received" signalvoid user_function (NiceAgent *stream_id, guint arg1, gpointer user_data) : Run Last
This signal is fired when we received our first binding request from the peer.
stream_id : |
The ID of the stream |
user_data : |
user data set when the signal handler was connected. |
"new-candidate" signalvoid user_function (NiceAgent *stream_id, guint component_id, guint foundation, gchar *arg3, gpointer user_data) : Run Last
This signal is fired when the agent discovers a new candidate
See also: "candidates-gathering-done"
stream_id : |
The ID of the stream |
component_id : |
The ID of the component |
foundation : |
The foundation of the new candidate |
user_data : |
user data set when the signal handler was connected. |
"new-remote-candidate" signalvoid user_function (NiceAgent *stream_id, guint component_id, guint foundation, gchar *arg3, gpointer user_data) : Run Last
This signal is fired when the agent discovers a new remote candidate. This can happen with peer reflexive candidates.
See also: "candidates-gathering-done"
stream_id : |
The ID of the stream |
component_id : |
The ID of the component |
foundation : |
The foundation of the new candidate |
user_data : |
user data set when the signal handler was connected. |
"new-selected-pair" signalvoid user_function (NiceAgent *stream_id, guint component_id, guint lfoundation, gchar *rfoundation, gchar *arg4, gpointer user_data) : Run Last
This signal is fired once a candidate pair is selected for data transfer for a stream's component
stream_id : |
The ID of the stream |
component_id : |
The ID of the component |
lfoundation : |
The local foundation of the selected candidate pair |
rfoundation : |
The remote foundation of the selected candidate pair |
user_data : |
user data set when the signal handler was connected. |