agent-priv.h 5.49 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/*
 * This file is part of the Nice GLib ICE library.
 *
 * (C) 2006, 2007 Collabora Ltd.
 *  Contact: Dafydd Harries
 * (C) 2006, 2007 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.
 *   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 */

#include <glib.h>

#include "agent.h"
#include "candidate.h"
#include "stream.h"
#include "conncheck.h"
50
#include "component.h"
51
#include "stun/stunagent.h"
52

53
54
55
/* 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
56
#define NICE_AGENT_TIMER_TA_DEFAULT 20      /* timer Ta, msecs (impl. defined) */
57
#define NICE_AGENT_TIMER_TR_DEFAULT 25000   /* timer Tr, msecs (impl. defined) */
58
59
#define NICE_AGENT_TIMER_TR_MIN     15000   /* timer Tr, msecs (ICE ID-19) */
#define NICE_AGENT_MAX_CONNECTIVITY_CHECKS_DEFAULT 100 /* see spec 5.7.3 (ID-19) */
60

61
62
63
64
65
66
67
68

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

struct _NiceAgent
{
  GObject parent;                 /**< gobject pointer */
69

70
  gboolean full_mode;             /**< property: full-mode */
71
72
  NiceUDPSocketFactory udp_socket_factory; /**< property: socket factory */
  NiceUDPSocketFactory relay_socket_factory; /**< property: socket factory */
73
74
75
76
  GTimeVal next_check_tv;         /**< property: next conncheck timestamp */
  gchar *stun_server_ip;          /**< property: STUN server IP */
  guint stun_server_port;         /**< property: STUN server port */
  gboolean controlling_mode;      /**< property: controlling-mode */
77
  guint timer_ta;                 /**< property: timer Ta */
78
  guint max_conn_checks;          /**< property: max connectivity checks */
79

80
81
82
83
84
85
86
87
88
89
90
  GSList *local_addresses;        /**< list of NiceAddresses for local
				     interfaces */
  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 */
  guint discovery_unsched_items;  /**< number of discovery items unscheduled */
  guint discovery_timer_id;       /**< id of discovery timer */
  guint conncheck_timer_id;       /**< id of discovery timer */
91
  guint keepalive_timer_id;       /**< id of keepalive timer */
Kai Vehmanen's avatar
Kai Vehmanen committed
92
  guint64 tie_breaker;            /**< tie breaker (ICE sect 5.2
93
				     "Determining Role" ID-19) */
94
  GStaticRecMutex mutex;                 /* Mutex used for thread-safe lib */
95
  NiceCompatibility compatibility; /* property: Compatibility mode */
96
  StunAgent stun_agent;            /* STUN agent */
97
98
99
100
101
102
103
104
105
106
107
108
109
  /* XXX: add pointer to internal data struct for ABI-safe extensions */
};

gboolean
agent_find_component (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
  Stream **stream,
  Component **component);

Stream *agent_find_stream (NiceAgent *agent, guint stream_id);

110
void agent_gathering_done (NiceAgent *agent);
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
void agent_signal_gathering_done (NiceAgent *agent);

void agent_signal_new_selected_pair (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
  const gchar *local_foundation,
  const gchar *remote_foundation);

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);

130
131
void agent_signal_new_remote_candidate (NiceAgent *agent, NiceCandidate *candidate);

132
133
void agent_signal_initial_binding_request_received (NiceAgent *agent, Stream *stream);

134
guint64 agent_candidate_pair_priority (NiceAgent *agent, NiceCandidate *local, NiceCandidate *remote);
135

136
137
guint agent_timeout_add_with_context (NiceAgent *agent, guint interval, GSourceFunc function, gpointer data);

138
139
140
141
142
void priv_attach_stream_component_socket (NiceAgent *agent,
    Stream *stream,
    Component *component,
    NiceUDPSocket *udp_socket);

143
#endif /*_NICE_AGENT_PRIV_H */