agent.h 16.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/*
 * This file is part of the Nice GLib ICE library.
 *
 * (C) 2006, 2007 Collabora Ltd.
 *  Contact: Dafydd Harries
 * (C) 2006, 2007 Nokia Corporation. All rights reserved.
 *  Contact: Kai Vehmanen
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the Nice GLib ICE library.
 *
 * The Initial Developers of the Original Code are Collabora Ltd and Nokia
 * Corporation. All Rights Reserved.
 *
 * Contributors:
 *   Dafydd Harries, Collabora Ltd.
26
 *   Kai Vehmanen, Nokia
27 28 29 30 31 32 33 34 35 36 37
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
 * case the provisions of LGPL are applicable instead of those above. If you
 * wish to allow use of your version of this file only under the terms of the
 * LGPL and not to allow others to use your version of this file under the
 * MPL, indicate your decision by deleting the provisions above and replace
 * them with the notice and other provisions required by the LGPL. If you do
 * not delete the provisions above, a recipient may use your version of this
 * file under either the MPL or the LGPL.
 */
Dafydd Harries's avatar
Dafydd Harries committed
38 39 40 41

#ifndef _AGENT_H
#define _AGENT_H

42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
/**
 * SECTION:agent
 * @short_description:  ICE agent API implementation
 * @see_also: #NiceCandidate
 * @see_also: #NiceAddress
 * @include: agent.h
 * @stability: Stable
 *
 * 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>
   <title>Simple example on how to use libnice</title>
   <programlisting>
   NiceAddress base_addr;
   guint stream_id;
   gchar buffer[] = "hello world!";
   GSList *lcands = NULL;

   // Create a nice agent
   NiceAgent *agent = nice_agent_new (NULL, NICE_COMPATIBILITY_DRAFT19);

   // Specify which local interface to use
   nice_address_set_from_string (&base_addr, "127.0.0.1");
   nice_agent_add_local_address (agent, &base_addr);

   // Connect the signals
   g_signal_connect (G_OBJECT (agent), "candidate-gathering-done",
                     G_CALLBACK (cb_candidate_gathering_done), NULL);
   g_signal_connect (G_OBJECT (lagent), "component-state-changed",
                     G_CALLBACK (cb_component_state_changed), NULL);
   g_signal_connect (G_OBJECT (lagent), "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 (lagent, ls_id, 1, sizeof(buffer), buffer);

   // Anything received will be received through the cb_nice_recv callback

   // Destroy the object
   g_object_unref(agent);

   </programlisting>
 </example>
 */


Dafydd Harries's avatar
Dafydd Harries committed
106
#include <glib-object.h>
107

108 109 110 111 112 113
/**
 * NiceAgent:
 *
 * The #NiceAgent is the main GObject of the libnice library and represents
 * the ICE agent.
 */
114 115
typedef struct _NiceAgent NiceAgent;

116
#include "address.h"
Dafydd Harries's avatar
Dafydd Harries committed
117
#include "candidate.h"
118
#include "debug.h"
119

120

Dafydd Harries's avatar
Dafydd Harries committed
121
G_BEGIN_DECLS
122

Dafydd Harries's avatar
Dafydd Harries committed
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
#define NICE_TYPE_AGENT nice_agent_get_type()

#define NICE_AGENT(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
  NICE_TYPE_AGENT, NiceAgent))

#define NICE_AGENT_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST ((klass), \
  NICE_TYPE_AGENT, NiceAgentClass))

#define NICE_IS_AGENT(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
  NICE_TYPE_AGENT))

#define NICE_IS_AGENT_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), \
  NICE_TYPE_AGENT))

#define NICE_AGENT_GET_CLASS(obj) \
  (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  NICE_TYPE_AGENT, NiceAgentClass))

Youness Alaoui's avatar
Youness Alaoui committed
145 146 147 148 149 150 151 152 153 154 155 156 157 158
typedef struct _NiceAgentClass NiceAgentClass;

struct _NiceAgentClass
{
  GObjectClass parent_class;
};


GType nice_agent_get_type (void);


/**
 * NICE_AGENT_MAX_REMOTE_CANDIDATES:
 *
159
 * A hard limit for number for remote candidates. This
Youness Alaoui's avatar
Youness Alaoui committed
160
 * limit is enforced to protect against malevolent remote
161 162 163 164
 * clients.
 */
#define NICE_AGENT_MAX_REMOTE_CANDIDATES    25

Youness Alaoui's avatar
Youness Alaoui committed
165 166 167 168 169 170 171 172 173 174
/**
 * NiceComponentState:
 * @NICE_COMPONENT_STATE_DISCONNECTED: No activity scheduled
 * @NICE_COMPONENT_STATE_GATHERING: Gathering local candidates
 * @NICE_COMPONENT_STATE_CONNECTING: Establishing connectivity
 * @NICE_COMPONENT_STATE_CONNECTED: At least one working candidate pair
 * @NICE_COMPONENT_STATE_READY: ICE concluded, candidate pair selection
 * is now final
 * @NICE_COMPONENT_STATE_FAILED: Connectivity checks have been completed,
 * but connectivity was not established
175
 * @NICE_COMPONENT_STATE_LAST: Dummy state
Youness Alaoui's avatar
Youness Alaoui committed
176 177 178 179
 *
 * An enum representing the state of a component.
 * See #NiceAgent::component-state-changed
 */
180 181
typedef enum
{
Youness Alaoui's avatar
Youness Alaoui committed
182 183 184 185 186 187
  NICE_COMPONENT_STATE_DISCONNECTED,
  NICE_COMPONENT_STATE_GATHERING,
  NICE_COMPONENT_STATE_CONNECTING,
  NICE_COMPONENT_STATE_CONNECTED,
  NICE_COMPONENT_STATE_READY,
  NICE_COMPONENT_STATE_FAILED,
Youness Alaoui's avatar
Youness Alaoui committed
188
  NICE_COMPONENT_STATE_LAST
189 190
} NiceComponentState;

Youness Alaoui's avatar
Youness Alaoui committed
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

/**
 * NiceComponentType:
 * @NICE_COMPONENT_TYPE_RTP: RTP Component type
 * @NICE_COMPONENT_TYPE_RTCP: RTCP Component type
 *
 * Convenience enum representing the type of a component for use as the
 * component_id for RTP/RTCP usages.
 <example>
   <title>Example of use.</title>
   <programlisting>
   nice_agent_send (agent, stream_id, NICE_COMPONENT_TYPE_RTP, len, buf);
   </programlisting>
  </example>
 */
206 207 208 209 210 211
typedef enum
{
  NICE_COMPONENT_TYPE_RTP = 1,
  NICE_COMPONENT_TYPE_RTCP = 2
} NiceComponentType;

212

Youness Alaoui's avatar
Youness Alaoui committed
213 214 215 216 217
/**
 * NiceCompatibility:
 * @NICE_COMPATIBILITY_DRAFT19: Use compatibility for ICE Draft 19 specs
 * @NICE_COMPATIBILITY_GOOGLE: Use compatibility for Google Talk specs
 * @NICE_COMPATIBILITY_MSN: Use compatibility for MSN Messenger specs
218
 * @NICE_COMPATIBILITY_LAST: Dummy last compatibility mode
Youness Alaoui's avatar
Youness Alaoui committed
219 220 221 222
 *
 * An enum to specify which compatible specifications the #NiceAgent should use.
 * Use with nice_agent_new()
 */
223 224
typedef enum
{
225
  NICE_COMPATIBILITY_DRAFT19 = 0,
226 227
  NICE_COMPATIBILITY_GOOGLE,
  NICE_COMPATIBILITY_MSN,
228
  NICE_COMPATIBILITY_LAST = NICE_COMPATIBILITY_MSN
229 230
} NiceCompatibility;

Youness Alaoui's avatar
Youness Alaoui committed
231 232 233 234 235 236 237 238 239 240 241 242 243
/**
 * NiceAgentRecvFunc:
 * @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()
 *
 * Callback function when data is received on a component
 *
 */
244 245 246 247
typedef void (*NiceAgentRecvFunc) (
  NiceAgent *agent, guint stream_id, guint component_id, guint len,
  gchar *buf, gpointer user_data);

Dafydd Harries's avatar
Dafydd Harries committed
248

Youness Alaoui's avatar
Youness Alaoui committed
249 250 251 252 253 254
/**
 * nice_agent_new:
 * @ctx: The Glib Mainloop Context to use for timers
 * @compat: The compatibility mode of the agent
 *
 * Create a new #NiceAgent.
255
 * The returned object must be freed with g_object_unref()
Youness Alaoui's avatar
Youness Alaoui committed
256
 *
257
 * Returns: The new agent GObject
Youness Alaoui's avatar
Youness Alaoui committed
258
 */
259
NiceAgent *
260
nice_agent_new (GMainContext *ctx, NiceCompatibility compat);
261

Youness Alaoui's avatar
Youness Alaoui committed
262 263 264 265 266 267 268 269 270 271
/**
 * nice_agent_add_local_address:
 * @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
 *
 * Add a local address from which to derive local host candidates
 *
 * Returns: %TRUE on success, %FALSE on fatal (memory allocation) errors
 */
272
gboolean
273
nice_agent_add_local_address (NiceAgent *agent, NiceAddress *addr);
274

Youness Alaoui's avatar
Youness Alaoui committed
275 276 277 278 279 280 281 282 283 284

/**
 * nice_agent_add_stream:
 * @agent: The #NiceAgent Object
 * @n_components: The number of components to add to the stream
 *
 * Adds a data stream to @agent containing @n_components components.
 *
 * Returns: The ID of the new stream, 0 on failure
 **/
Dafydd Harries's avatar
Dafydd Harries committed
285
guint
286 287
nice_agent_add_stream (
  NiceAgent *agent,
288
  guint n_components);
289

Youness Alaoui's avatar
Youness Alaoui committed
290 291 292 293 294 295 296 297
/**
 * nice_agent_remove_stream:
 * @agent: The #NiceAgent Object
 * @stream_id: The ID of the stream to remove
 *
 * Remove and free a previously created data stream from @agent
 *
 **/
Dafydd Harries's avatar
Dafydd Harries committed
298 299 300 301 302
void
nice_agent_remove_stream (
  NiceAgent *agent,
  guint stream_id);

Youness Alaoui's avatar
Youness Alaoui committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
/**
 * nice_agent_set_relay_info:
 * @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
 *
 * Sets the settings for using a relay server during the candidate discovery.
 *
 * Returns: %TRUE if the TURN settings were accepted.
 * %FALSE if the address was invalid.
 */
319
gboolean nice_agent_set_relay_info(
320 321 322 323 324 325
    NiceAgent *agent,
    guint stream_id,
    guint component_id,
    const gchar *server_ip,
    guint server_port,
    const gchar *username,
326 327
    const gchar *password,
    NiceRelayType type);
328

Youness Alaoui's avatar
Youness Alaoui committed
329 330 331 332 333 334 335 336 337 338 339 340 341 342
/**
 * nice_agent_gather_candidates:
 * @agent: The #NiceAgent Object
 * @stream_id: The id of the stream to start
 *
 * Start the candidate gathering process.
 * Once done, #NiceAgent::candidate-gathering-done is called for the stream
 *
 <note>
   <para>
    Local addresses must be previously set with nice_agent_add_local_address()
   </para>
 </note>
 */
343 344 345 346 347
void
nice_agent_gather_candidates (
  NiceAgent *agent,
  guint stream_id);

Youness Alaoui's avatar
Youness Alaoui committed
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
/**
 * nice_agent_set_remote_credentials:
 * @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)
 *
 * Sets the remote credentials for stream @stream_id.
 *
 <note>
   <para>
     Stream credentials do not override per-candidate credentials if set
   </para>
 </note>
 *
 * Returns: %TRUE on success, %FALSE on error.
 */
367 368 369 370 371 372
gboolean
nice_agent_set_remote_credentials (
  NiceAgent *agent,
  guint stream_id,
  const gchar *ufrag, const gchar *pwd);

Youness Alaoui's avatar
Youness Alaoui committed
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389


/**
 * nice_agent_get_local_credentials:
 * @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()
 *
 * Gets the local credentials for stream @stream_id.
 *
 * Returns: %TRUE on success, %FALSE on error.
 */
390 391 392 393 394 395
gboolean
nice_agent_get_local_credentials (
  NiceAgent *agent,
  guint stream_id,
  const gchar **ufrag, const gchar **pwd);

Youness Alaoui's avatar
Youness Alaoui committed
396 397 398 399 400 401 402 403 404 405 406 407
/**
 * 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
 *
 * Sets the remote candidates for a component of a stream.
 * Replaces any existing remote candidates.
 *
 <note>
   <para>
408 409
    NICE_AGENT_MAX_REMOTE_CANDIDATES is the absolute maximum limit
    for remote candidates
Youness Alaoui's avatar
Youness Alaoui committed
410 411 412
   </para>
 </note>
 *
413 414
 * Returns: The number of candidates added,
 * negative on fatal (memory allocs) errors
Youness Alaoui's avatar
Youness Alaoui committed
415
 **/
416
int
417 418 419 420
nice_agent_set_remote_candidates (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
421
  const GSList *candidates);
422

Youness Alaoui's avatar
Youness Alaoui committed
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442

/**
 * nice_agent_send:
 * @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
 *
 * Sends a data payload over a stream's component.
 *
 <note>
   <para>
     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
   </para>
 </note>
 *
 * Returns: The number of bytes sent, or negative error code
 */
443
gint
Dafydd Harries's avatar
Dafydd Harries committed
444 445 446 447 448
nice_agent_send (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
  guint len,
449
  const gchar *buf);
Dafydd Harries's avatar
Dafydd Harries committed
450

Youness Alaoui's avatar
Youness Alaoui committed
451 452 453 454 455 456
/**
 * nice_agent_get_local_candidates:
 * @agent: The #NiceAgent Object
 * @stream_id: The ID of the stream
 * @component_id: The ID of the component
 *
457 458
 * Retreive from the agent the list of all local candidates
 * for a stream's component
Youness Alaoui's avatar
Youness Alaoui committed
459 460 461 462 463 464 465 466 467 468 469 470 471
 *
 <note>
   <para>
     The caller owns the returned GSList as well as the candidates contained
     within it.
     To get full results, the client should wait for the
     #NiceAgent::candidates-gathering-done signal.
   </para>
 </note>
 *
 * Returns: a #GSList of #NiceCandidate objects representing
 * the local candidates of @agent
 **/
472
GSList *
473
nice_agent_get_local_candidates (
474 475 476
  NiceAgent *agent,
  guint stream_id,
  guint component_id);
Dafydd Harries's avatar
Dafydd Harries committed
477

Youness Alaoui's avatar
Youness Alaoui committed
478 479 480 481 482 483 484 485 486 487 488

/**
 * nice_agent_get_remote_candidates:
 * @agent: The #NiceAgent Object
 * @stream_id: The ID of the stream
 * @component_id: The ID of the component
 *
 * Get a list of the remote candidates set on a stream's component
 *
 <note>
   <para>
489 490
     The caller owns the returned GSList but not the candidates
     contained within it.
Youness Alaoui's avatar
Youness Alaoui committed
491 492 493
   </para>
   <para>
     The list of remote candidates can change during processing.
494 495
     The client should register for the #NiceAgent::new-remote-candidate signal
     to get notified of new remote candidates.
Youness Alaoui's avatar
Youness Alaoui committed
496 497 498 499 500 501
   </para>
 </note>
 *
 * Returns: a #GSList of #NiceCandidates objects representing
 * the remote candidates set on the @agent
 **/
502 503 504 505 506 507
GSList *
nice_agent_get_remote_candidates (
  NiceAgent *agent,
  guint stream_id,
  guint component_id);

Youness Alaoui's avatar
Youness Alaoui committed
508 509 510 511 512 513 514 515 516 517 518 519
/**
 * nice_agent_restart:
 * @agent: The #NiceAgent Object
 *
 * 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.
 *
 * Returns: %TRUE on success %FALSE on error
 **/
gboolean
520 521 522
nice_agent_restart (
  NiceAgent *agent);

Youness Alaoui's avatar
Youness Alaoui committed
523 524 525 526 527 528 529

/**
 * nice_agent_attach_recv:
 * @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
530 531
 * @func: The callback function to be called when data is received on
 * the stream's component
Youness Alaoui's avatar
Youness Alaoui committed
532 533
 * @data: user data associated with the callback
 *
534 535
 * Attaches the stream's component's sockets to the Glib Mainloop Context in
 * order to be notified whenever data becomes available for a component.
Youness Alaoui's avatar
Youness Alaoui committed
536 537 538
 *
 * Returns: %TRUE on success, %FALSE if the stream or component IDs are invalid.
 */
539
gboolean
540
nice_agent_attach_recv (
541
  NiceAgent *agent,
542 543
  guint stream_id,
  guint component_id,
544 545 546 547
  GMainContext *ctx,
  NiceAgentRecvFunc func,
  gpointer data);

Youness Alaoui's avatar
Youness Alaoui committed
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565

/**
 * nice_agent_set_selected_pair:
 * @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
 *
 * 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.
 *
 * Returns: %TRUE on success, %FALSE if the candidate pair cannot be found
 */
gboolean
566 567 568 569 570 571 572
nice_agent_set_selected_pair (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
  const gchar *lfoundation,
  const gchar *rfoundation);

Youness Alaoui's avatar
Youness Alaoui committed
573 574 575 576 577 578 579 580 581 582 583
/**
 * nice_agent_set_selected_remote_candidate:
 * @agent: The #NiceAgent Object
 * @stream_id: The ID of the stream
 * @component_id: The ID of the component
 * @candidate: The #NiceCandidate to select
 *
 * 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).
584 585
 * Calling this function will disable all further ICE processing
 * (connection check, state machine updates, etc). Note that keepalives will
Youness Alaoui's avatar
Youness Alaoui committed
586 587 588 589
 * continue to be sent.
 *
 * Returns: %TRUE on success, %FALSE on failure
 */
590 591 592 593 594 595 596
gboolean
nice_agent_set_selected_remote_candidate (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
  NiceCandidate *candidate);

Dafydd Harries's avatar
Dafydd Harries committed
597 598
G_END_DECLS

Dafydd Harries's avatar
Dafydd Harries committed
599 600
#endif /* _AGENT_H */