agent/stream.h

   1 /*
   2  * This file is part of the Nice GLib ICE library.
   3  *
   4  * (C) 2006-2010 Collabora Ltd.
   5  *  Contact: Youness Alaoui
   6  * (C) 2006-2010 Nokia Corporation. All rights reserved.
   7  *  Contact: Kai Vehmanen
   8
   9  *
  10  * The contents of this file are subject to the Mozilla Public License Version
  11  * 1.1 (the "License"); you may not use this file except in compliance with
  12  * the License. You may obtain a copy of the License at
  13  * http://www.mozilla.org/MPL/
  14  *
  15  * Software distributed under the License is distributed on an "AS IS" basis,
  16  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17  * for the specific language governing rights and limitations under the
  18  * License.
  19  *
  20  * The Original Code is the Nice GLib ICE library.
  21  *
  22  * The Initial Developers of the Original Code are Collabora Ltd and Nokia
  23  * Corporation. All Rights Reserved.
  24  *
  25  * Contributors:
  26  *   Dafydd Harries, Collabora Ltd.
  27  *   Youness Alaoui, Collabora Ltd.
  28  *
  29  * Alternatively, the contents of this file may be used under the terms of the
  30  * the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
  31  * case the provisions of LGPL are applicable instead of those above. If you
  32  * wish to allow use of your version of this file only under the terms of the
  33  * LGPL and not to allow others to use your version of this file under the
  34  * MPL, indicate your decision by deleting the provisions above and replace
  35  * them with the notice and other provisions required by the LGPL. If you do
  36  * not delete the provisions above, a recipient may use your version of this
  37  * file under either the MPL or the LGPL.
  38  */
  39
  40 #ifndef _NICE_STREAM_H
  41 #define _NICE_STREAM_H
  42
  43 #include <glib.h>
  44
  45 typedef struct _Stream Stream;
  46
  47 #include "component.h"
  48 #include "random.h"
  49
  50 G_BEGIN_DECLS
  51
  52 /* Maximum and default sizes for ICE attributes,
  53  * last updated from ICE ID-19
  54  * (the below sizes include the terminating NULL): */
  55
  56 #define NICE_STREAM_MAX_UFRAG   256 + 1  /* ufrag + NULL */
  57 #define NICE_STREAM_MAX_UNAME   256 * 2 + 1 + 1 /* 2*ufrag + colon + NULL */
  58 #define NICE_STREAM_MAX_PWD     256 + 1  /* pwd + NULL */
  59 #define NICE_STREAM_DEF_UFRAG   4 + 1    /* ufrag + NULL */
  60 #define NICE_STREAM_DEF_PWD     22 + 1   /* pwd + NULL */
  61
  62 /*
  63  * Checklist states. These match the definition given in
  64  * the ICE spec sect 5.7.4. "Computing States" (ID-19).
  65  */
  66 typedef enum
  67 {
  68   NICE_CHECKLIST_NOT_STARTED = 1,
  69   NICE_CHECKLIST_RUNNING,
  70   NICE_CHECKLIST_COMPLETED,
  71   NICE_CHECKLIST_FAILED
  72 } NiceCheckListState;
  73
  74
  75 struct _Stream
  76 {
  77   guint id;
  78   guint n_components;
  79   gboolean initial_binding_request_received;
  80   GSList *components; /* list of 'Component' structs */
  81   GSList *conncheck_list;         /* list of CandidatePair items */
  82   NiceCheckListState conncheck_state; /* checklist state */
  83   gchar local_ufrag[NICE_STREAM_MAX_UFRAG];
  84   gchar local_password[NICE_STREAM_MAX_PWD];
  85   gchar remote_ufrag[NICE_STREAM_MAX_UFRAG];
  86   gchar remote_password[NICE_STREAM_MAX_PWD];
  87   gboolean gathering;
  88   gint tos;
  89 };
  90
  91
  92 Stream *
  93 stream_new (guint n_components);
  94
  95 void
  96 stream_free (Stream *stream);
  97
  98 gboolean
  99 stream_all_components_ready (const Stream *stream);
 100
 101 Component *
 102 stream_find_component_by_id (const Stream *stream, guint id);
 103
 104 void
 105 stream_initialize_credentials (Stream *stream, NiceRNG *rng);
 106
 107 gboolean
 108 stream_restart (Stream *stream, NiceRNG *rng);
 109
 110 G_END_DECLS
 111
 112 #endif /* _NICE_STREAM_H */
 113