stream.h 3.76 KB
Newer Older
1 2 3
/*
 * This file is part of the Nice GLib ICE library.
 *
4 5 6
 * (C) 2006-2010 Collabora Ltd.
 *  Contact: Youness Alaoui
 * (C) 2006-2010 Nokia Corporation. All rights reserved.
7
 *  Contact: Kai Vehmanen
8

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * 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.
27
 *   Youness Alaoui, Collabora Ltd.
28 29 30 31 32 33 34 35 36 37 38
 *
 * 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.
 */
39 40 41 42 43 44

#ifndef _NICE_STREAM_H
#define _NICE_STREAM_H

#include <glib.h>

45
typedef struct _NiceStream NiceStream;
46

47
#include "component.h"
48
#include "random.h"
49 50 51

G_BEGIN_DECLS

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 57 58 59 60
#define NICE_STREAM_MAX_UFRAG   256 + 1  /* ufrag + NULL */
#define NICE_STREAM_MAX_UNAME   256 * 2 + 1 + 1 /* 2*ufrag + colon + NULL */
#define NICE_STREAM_MAX_PWD     256 + 1  /* pwd + NULL */
#define NICE_STREAM_DEF_UFRAG   4 + 1    /* ufrag + NULL */
#define NICE_STREAM_DEF_PWD     22 + 1   /* pwd + NULL */
61

62 63 64 65 66 67 68 69 70 71 72 73
#define NICE_TYPE_STREAM nice_stream_get_type()
#define NICE_STREAM(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), NICE_TYPE_STREAM, NiceStream))
#define NICE_STREAM_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST ((klass), NICE_TYPE_STREAM, NiceStreamClass))
#define NICE_IS_STREAM(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NICE_TYPE_STREAM))
#define NICE_IS_STREAM_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), NICE_TYPE_STREAM))
#define NICE_STREAM_GET_CLASS(obj) \
  (G_TYPE_INSTANCE_GET_CLASS ((obj), NICE_TYPE_STREAM, NiceStreamClass))

74
struct _NiceStream {
75 76 77
  /*< private >*/
  GObject parent;

78
  gchar *name;
79
  guint id;
80 81
  guint n_components;
  gboolean initial_binding_request_received;
82
  GSList *components; /* list of 'NiceComponent' objects */
83
  GSList *conncheck_list;         /* list of CandidateCheckPair items */
84 85 86 87
  gchar local_ufrag[NICE_STREAM_MAX_UFRAG];
  gchar local_password[NICE_STREAM_MAX_PWD];
  gchar remote_ufrag[NICE_STREAM_MAX_UFRAG];
  gchar remote_password[NICE_STREAM_MAX_PWD];
88
  gboolean gathering;
89
  gboolean gathering_started;
90
  gint tos;
91
  guint tick_counter;
92 93
};

94 95 96 97 98
typedef struct {
  GObjectClass parent_class;
} NiceStreamClass;

GType nice_stream_get_type (void);
99

100
NiceStream *
101
nice_stream_new (guint stream_id, guint n_components, NiceAgent *agent);
102

103
void
104
nice_stream_close (NiceAgent *agent, NiceStream *stream);
105

106
NiceComponent *
107
nice_stream_find_component_by_id (NiceStream *stream, guint id);
108

109
void
110
nice_stream_initialize_credentials (NiceStream *stream, NiceRNG *rng);
111

112
void
113
nice_stream_restart (NiceStream *stream, NiceAgent *agent);
114

115 116 117 118
G_END_DECLS

#endif /* _NICE_STREAM_H */