stream.h 3.03 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 46
typedef struct _Stream Stream;

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
struct _Stream
{
64
  gchar *name;
65
  guint id;
66 67
  guint n_components;
  gboolean initial_binding_request_received;
68
  GSList *components; /* list of 'Component' structs */
69
  GSList *conncheck_list;         /* list of CandidatePair items */
70 71 72 73
  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];
74
  gboolean gathering;
75
  gboolean gathering_started;
76
  gint tos;
77 78
};

79

80
Stream *
81
stream_new (guint n_components, NiceAgent *agent);
82 83 84 85

void
stream_free (Stream *stream);

86 87 88 89 90 91
gboolean
stream_all_components_ready (const Stream *stream);

Component *
stream_find_component_by_id (const Stream *stream, guint id);

92 93 94 95 96 97
void
stream_initialize_credentials (Stream *stream, NiceRNG *rng);

gboolean 
stream_restart (Stream *stream, NiceRNG *rng);

98 99 100 101
G_END_DECLS

#endif /* _NICE_STREAM_H */