libnice/agent/stream.h
Olivier Crête 7d0b3ab421 agent: Move UPnP handling to each stream
Also rewrite the logic a little, and try to make the code a little clearer.
2020-10-21 01:24:39 +00:00

125 lines
4 KiB
C

/*
* This file is part of the Nice GLib ICE library.
*
* (C) 2006-2010 Collabora Ltd.
* Contact: Youness Alaoui
* (C) 2006-2010 Nokia Corporation. All rights reserved.
* Contact: Kai Vehmanen
*
* 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.
* Youness Alaoui, Collabora Ltd.
*
* 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.
*/
#ifndef _NICE_STREAM_H
#define _NICE_STREAM_H
#include <glib.h>
typedef struct _NiceStream NiceStream;
#include "component.h"
#include "random.h"
G_BEGIN_DECLS
/* Maximum and default sizes for ICE attributes,
* last updated from ICE ID-19
* (the below sizes include the terminating NULL): */
#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 */
#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))
struct _NiceStream {
/*< private >*/
GObject parent;
gchar *name;
guint id;
guint n_components;
gboolean initial_binding_request_received;
GSList *components; /* list of 'NiceComponent' objects */
GSList *conncheck_list; /* list of CandidateCheckPair items */
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];
gboolean gathering;
gboolean gathering_started;
gboolean peer_gathering_done;
gint tos;
guint tick_counter;
#ifdef HAVE_GUPNP
GSList *upnp_mapping; /* NiceCandidate being mapped */
GSList *upnp_mapped; /* NiceCandidate mapped with UPnP */
GSource *upnp_timer_source; /* source of upnp timeout timer */
#endif
};
typedef struct {
GObjectClass parent_class;
} NiceStreamClass;
GType nice_stream_get_type (void);
NiceStream *
nice_stream_new (guint stream_id, guint n_components, NiceAgent *agent);
void
nice_stream_close (NiceAgent *agent, NiceStream *stream);
NiceComponent *
nice_stream_find_component_by_id (NiceStream *stream, guint id);
void
nice_stream_initialize_credentials (NiceStream *stream, NiceRNG *rng);
void
nice_stream_restart (NiceStream *stream, NiceAgent *agent);
G_END_DECLS
#endif /* _NICE_STREAM_H */