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 _NiceStream NiceStream;
  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 #define NICE_TYPE_STREAM nice_stream_get_type()
  63 #define NICE_STREAM(obj) \
  64   (G_TYPE_CHECK_INSTANCE_CAST ((obj), NICE_TYPE_STREAM, NiceStream))
  65 #define NICE_STREAM_CLASS(klass) \
  66   (G_TYPE_CHECK_CLASS_CAST ((klass), NICE_TYPE_STREAM, NiceStreamClass))
  67 #define NICE_IS_STREAM(obj) \
  68   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NICE_TYPE_STREAM))
  69 #define NICE_IS_STREAM_CLASS(klass) \
  70   (G_TYPE_CHECK_CLASS_TYPE ((klass), NICE_TYPE_STREAM))
  71 #define NICE_STREAM_GET_CLASS(obj) \
  72   (G_TYPE_INSTANCE_GET_CLASS ((obj), NICE_TYPE_STREAM, NiceStreamClass))
  73
  74 struct _NiceStream {
  75   /*< private >*/
  76   GObject parent;
  77
  78   gchar *name;
  79   guint id;
  80   guint n_components;
  81   gboolean initial_binding_request_received;
  82   GSList *components; /* list of 'NiceComponent' objects */
  83   GSList *conncheck_list;         /* list of CandidateCheckPair items */
  84   gchar local_ufrag[NICE_STREAM_MAX_UFRAG];
  85   gchar local_password[NICE_STREAM_MAX_PWD];
  86   gchar remote_ufrag[NICE_STREAM_MAX_UFRAG];
  87   gchar remote_password[NICE_STREAM_MAX_PWD];
  88   gboolean gathering;
  89   gboolean gathering_started;
  90   gboolean peer_gathering_done;
  91   gint tos;
  92   guint tick_counter;
  93 };
  94
  95 typedef struct {
  96   GObjectClass parent_class;
  97 } NiceStreamClass;
  98
  99 GType nice_stream_get_type (void);
 100
 101 NiceStream *
 102 nice_stream_new (guint stream_id, guint n_components, NiceAgent *agent);
 103
 104 void
 105 nice_stream_close (NiceAgent *agent, NiceStream *stream);
 106
 107 NiceComponent *
 108 nice_stream_find_component_by_id (NiceStream *stream, guint id);
 109
 110 void
 111 nice_stream_initialize_credentials (NiceStream *stream, NiceRNG *rng);
 112
 113 void
 114 nice_stream_restart (NiceStream *stream, NiceAgent *agent);
 115
 116 G_END_DECLS
 117
 118 #endif /* _NICE_STREAM_H */
 119