agent-priv.h 11.4 KB
Newer Older
1 2 3
/*
 * This file is part of the Nice GLib ICE library.
 *
4 5 6
 * (C) 2006-2009 Collabora Ltd.
 *  Contact: Youness Alaoui
 * (C) 2006-2009 Nokia Corporation. All rights reserved.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 *  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.
26
 *   Youness Alaoui, Collabora Ltd.
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
 *   Kai Vehmanen, Nokia
 *
 * 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_AGENT_PRIV_H
#define _NICE_AGENT_PRIV_H

/* note: this is a private header part of agent.h */

Youness Alaoui's avatar
Youness Alaoui committed
45 46 47 48 49 50 51

#ifdef HAVE_CONFIG_H
# include <config.h>
#else
#define NICEAPI_EXPORT
#endif

52 53 54
#include <glib.h>

#include "agent.h"
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

/**
 * NiceInputMessageIter:
 * @message: index of the message currently being written into
 * @buffer: index of the buffer currently being written into
 * @offset: byte offset into the buffer
 *
 * Iterator for sequentially writing into an array of #NiceInputMessages,
 * tracking the current write position (i.e. the index of the next byte to be
 * written).
 *
 * If @message is equal to the number of messages in the associated
 * #NiceInputMessage array, and @buffer and @offset are zero, the iterator is at
 * the end of the messages array, and the array is (presumably) full.
 *
 * Since: 0.1.5
 */
typedef struct {
  guint message;
  guint buffer;
  gsize offset;
} NiceInputMessageIter;

void
nice_input_message_iter_reset (NiceInputMessageIter *iter);
gboolean
nice_input_message_iter_is_at_end (NiceInputMessageIter *iter,
    NiceInputMessage *messages, guint n_messages);
guint
nice_input_message_iter_get_n_valid_messages (NiceInputMessageIter *iter);
85 86 87
gboolean
nice_input_message_iter_compare (const NiceInputMessageIter *a,
    const NiceInputMessageIter *b);
88 89


90
#include "socket.h"
91 92 93
#include "candidate.h"
#include "stream.h"
#include "conncheck.h"
94
#include "component.h"
95
#include "random.h"
96
#include "stun/stunagent.h"
97 98
#include "stun/usages/turn.h"
#include "stun/usages/ice.h"
99

Youness Alaoui's avatar
Youness Alaoui committed
100
#ifdef HAVE_GUPNP
101
#include <libgupnp-igd/gupnp-simple-igd-thread.h>
Youness Alaoui's avatar
Youness Alaoui committed
102 103
#endif

104 105 106
/* XXX: starting from ICE ID-18, Ta SHOULD now be set according
 *      to session bandwidth -> this is not yet implemented in NICE */

Kai Vehmanen's avatar
Kai Vehmanen committed
107
#define NICE_AGENT_TIMER_TA_DEFAULT 20      /* timer Ta, msecs (impl. defined) */
108
#define NICE_AGENT_TIMER_TR_DEFAULT 25000   /* timer Tr, msecs (impl. defined) */
109
#define NICE_AGENT_MAX_CONNECTIVITY_CHECKS_DEFAULT 100 /* see spec 5.7.3 (ID-19) */
110

111

112
/* An upper limit to size of STUN packets handled (based on Ethernet
113 114 115
 * MTU and estimated typical sizes of ICE STUN packet */
#define MAX_STUN_DATAGRAM_PAYLOAD    1300

116 117
#define NICE_COMPONENT_MAX_VALID_CANDIDATES 50 /* maximum number of validates remote candidates to keep, the number is arbitrary but hopefully large enough */

118 119 120 121 122 123 124
/* A convenient macro to test if the agent is compatible with RFC5245
 * or OC2007R2. Specifically these two modes share the support
 * of the regular or aggressive nomination mode */
#define NICE_AGENT_IS_COMPATIBLE_WITH_RFC5245_OR_OC2007R2(obj) \
  ((obj)->compatibility == NICE_COMPATIBILITY_RFC5245 || \
  (obj)->compatibility == NICE_COMPATIBILITY_OC2007R2)

125 126 127 128 129 130 131 132 133 134 135 136
/* A grace period before declaring a component as failed, in msecs. This
 * delay is added to reduce the chance to see the agent receiving new
 * stun activity just after the conncheck list has been declared failed,
 * reactiviting conncheck activity, and causing a (valid) state
 * transitions like that: connecting -> failed -> connecting ->
 * connected -> ready.
 * Such transitions are not buggy per-se, but may break the
 * test-suite, that counts precisely the number of time each state
 * has been set, and doesnt expect these transcient failed states.
 */
#define NICE_AGENT_MAX_TIMER_GRACE_PERIOD 1000

137 138
struct _NiceAgent
{
139
  GObject parent;                 /* gobject pointer */
140

141 142 143 144 145 146 147 148 149 150 151
  gboolean full_mode;             /* property: full-mode */
  gchar *stun_server_ip;          /* property: STUN server IP */
  guint stun_server_port;         /* property: STUN server port */
  gchar *proxy_ip;                /* property: Proxy server IP */
  guint proxy_port;               /* property: Proxy server port */
  NiceProxyType proxy_type;       /* property: Proxy type */
  gchar *proxy_username;          /* property: Proxy username */
  gchar *proxy_password;          /* property: Proxy password */
  gboolean controlling_mode;      /* property: controlling-mode */
  guint timer_ta;                 /* property: timer Ta */
  guint max_conn_checks;          /* property: max connectivity checks */
152
  gboolean force_relay;           /* property: force relay */
153 154 155
  guint stun_max_retransmissions; /* property: stun max retransmissions, Rc */
  guint stun_initial_timeout;     /* property: stun initial timeout, RTO */
  guint stun_reliable_timeout;    /* property: stun reliable timeout */
156
  NiceNominationMode nomination_mode; /* property: Nomination mode */
157

158
  GSList *local_addresses;        /* list of NiceAddresses for local
159
				     interfaces */
160 161 162 163 164 165
  GSList *streams;                /* list of Stream objects */
  GMainContext *main_context;     /* main context pointer */
  guint next_candidate_id;        /* id of next created candidate */
  guint next_stream_id;           /* id of next created candidate */
  NiceRNG *rng;                   /* random number generator */
  GSList *discovery_list;         /* list of CandidateDiscovery items */
166
  GSList *triggered_check_queue;  /* pairs in the triggered check list */
167 168 169 170 171 172
  guint discovery_unsched_items;  /* number of discovery items unscheduled */
  GSource *discovery_timer_source; /* source of discovery timer */
  GSource *conncheck_timer_source; /* source of conncheck timer */
  GSource *keepalive_timer_source; /* source of keepalive timer */
  GSList *refresh_list;         /* list of CandidateRefresh items */
  guint64 tie_breaker;            /* tie breaker (ICE sect 5.2
173
				     "Determining Role" ID-19) */
174
  NiceCompatibility compatibility; /* property: Compatibility mode */
175
  gboolean media_after_tick;       /* Received media after keepalive tick */
Youness Alaoui's avatar
Youness Alaoui committed
176
#ifdef HAVE_GUPNP
177
  GUPnPSimpleIgdThread* upnp;	   /* GUPnP Single IGD agent */
Youness Alaoui's avatar
Youness Alaoui committed
178 179
  gboolean upnp_enabled;           /* whether UPnP discovery is enabled */
  guint upnp_timeout;              /* UPnP discovery timeout */
180
  GSList *upnp_mapping;            /* NiceAddresses of cands being mapped */
Youness Alaoui's avatar
Youness Alaoui committed
181 182
  GSource *upnp_timer_source;      /* source of upnp timeout timer */
#endif
183
  gchar *software_attribute;       /* SOFTWARE attribute */
184
  gboolean reliable;               /* property: reliable */
185
  gboolean keepalive_conncheck;    /* property: keepalive_conncheck */
186 187

  GQueue pending_signals;
188
  guint16 rfc4571_expecting_length;
Youness Alaoui's avatar
Youness Alaoui committed
189 190
  gboolean use_ice_udp;
  gboolean use_ice_tcp;
191 192

  guint conncheck_timer_grace_period; /* ongoing delay before timer stop */
193 194 195 196 197 198 199 200
  /* XXX: add pointer to internal data struct for ABI-safe extensions */
};

gboolean
agent_find_component (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
201
  NiceStream **stream,
202
  NiceComponent **component) G_GNUC_WARN_UNUSED_RESULT;
203

204
NiceStream *agent_find_stream (NiceAgent *agent, guint stream_id);
205

206
void agent_gathering_done (NiceAgent *agent);
207 208
void agent_signal_gathering_done (NiceAgent *agent);

209 210
void agent_lock (void);
void agent_unlock (void);
211
void agent_unlock_and_emit (NiceAgent *agent);
212

213 214 215 216
void agent_signal_new_selected_pair (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
217 218
  NiceCandidate *lcandidate,
  NiceCandidate *rcandidate);
219 220 221 222 223 224 225 226 227 228 229

void agent_signal_component_state_change (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
  NiceComponentState state);

void agent_signal_new_candidate (
  NiceAgent *agent,
  NiceCandidate *candidate);

230 231
void agent_signal_new_remote_candidate (NiceAgent *agent, NiceCandidate *candidate);

232
void agent_signal_initial_binding_request_received (NiceAgent *agent, NiceStream *stream);
233

234
guint64 agent_candidate_pair_priority (NiceAgent *agent, NiceCandidate *local, NiceCandidate *remote);
235

236 237
void agent_timeout_add_with_context (NiceAgent *agent, GSource **out,
    const gchar *name, guint interval, GSourceFunc function, gpointer data);
238

239 240 241 242
StunUsageIceCompatibility agent_to_ice_compatibility (NiceAgent *agent);
StunUsageTurnCompatibility agent_to_turn_compatibility (NiceAgent *agent);
NiceTurnSocketCompatibility agent_to_turn_socket_compatibility (NiceAgent *agent);

243 244 245
void agent_remove_local_candidate (NiceAgent *agent,
    NiceCandidate *candidate);

246 247
void nice_agent_init_stun_agent (NiceAgent *agent, StunAgent *stun_agent);

248 249
void _priv_set_socket_tos (NiceAgent *agent, NiceSocket *sock, gint tos);

250 251
void _tcp_sock_is_writable (NiceSocket *sock, gpointer user_data);

252 253 254 255 256 257
gboolean
component_io_cb (
  GSocket *gsocket,
  GIOCondition condition,
  gpointer data);

258 259 260 261
gsize
memcpy_buffer_to_input_message (NiceInputMessage *message,
    const guint8 *buffer, gsize buffer_length);
guint8 *
262
compact_input_message (const NiceInputMessage *message, gsize *buffer_length);
263

264 265 266
guint8 *
compact_output_message (const NiceOutputMessage *message, gsize *buffer_length);

267 268 269
gsize
output_message_get_size (const NiceOutputMessage *message);

270 271 272
gssize agent_socket_send (NiceSocket *sock, const NiceAddress *addr, gsize len,
    const gchar *buf);

273 274 275 276 277 278 279 280 281 282 283 284 285 286 287

guint32
nice_candidate_jingle_priority (NiceCandidate *candidate);

guint32
nice_candidate_msn_priority (NiceCandidate *candidate);

guint32
nice_candidate_ice_priority_full (guint type_pref, guint local_pref,
    guint component_id);

guint32
nice_candidate_ice_priority (const NiceCandidate *candidate,
    gboolean reliable, gboolean nat_assisted);

288 289 290 291
guint32
nice_candidate_ms_ice_priority (const NiceCandidate *candidate,
    gboolean reliable, gboolean nat_assisted);

292 293 294
guint64
nice_candidate_pair_priority (guint32 o_prio, guint32 a_prio);

295 296 297 298 299 300 301 302 303 304
/*
 * nice_debug_init:
 *
 * Initialize the debugging system. Uses the NICE_DEBUG environment variable
 * to set the appropriate debugging flags
 */
void nice_debug_init (void);


#ifdef NDEBUG
305
static inline gboolean nice_debug_is_enabled (void) { return FALSE; }
306
static inline gboolean nice_debug_is_verbose (void) { return FALSE; }
307
static inline void nice_debug (const char *fmt, ...) { }
308
static inline void nice_debug_verbose (const char *fmt, ...) { }
309 310
#else
gboolean nice_debug_is_enabled (void);
311
gboolean nice_debug_is_verbose (void);
312
void nice_debug (const char *fmt, ...) G_GNUC_PRINTF (1, 2);
313
void nice_debug_verbose (const char *fmt, ...) G_GNUC_PRINTF (1, 2);
314
#endif
315

316
#endif /*_NICE_AGENT_PRIV_H */