agent/stream.h

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