agent.h 5.45 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
/*
 * 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.
 *
 * 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.
 */
Dafydd Harries's avatar
Dafydd Harries committed
37 38 39 40

#ifndef _AGENT_H
#define _AGENT_H

Dafydd Harries's avatar
Dafydd Harries committed
41
#include <glib-object.h>
42 43

#include "udp.h"
44
#include "address.h"
Dafydd Harries's avatar
Dafydd Harries committed
45
#include "candidate.h"
Dafydd Harries's avatar
Dafydd Harries committed
46
#include "random.h"
47

Dafydd Harries's avatar
Dafydd Harries committed
48
G_BEGIN_DECLS
49

Dafydd Harries's avatar
Dafydd Harries committed
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
#define NICE_TYPE_AGENT nice_agent_get_type()

#define NICE_AGENT(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
  NICE_TYPE_AGENT, NiceAgent))

#define NICE_AGENT_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST ((klass), \
  NICE_TYPE_AGENT, NiceAgentClass))

#define NICE_IS_AGENT(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
  NICE_TYPE_AGENT))

#define NICE_IS_AGENT_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), \
  NICE_TYPE_AGENT))

#define NICE_AGENT_GET_CLASS(obj) \
  (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  NICE_TYPE_AGENT, NiceAgentClass))

72 73
typedef enum
{
74 75 76 77 78 79 80 81
  NICE_COMPONENT_STATE_DISCONNECTED, /* no activity scheduled */
  NICE_COMPONENT_STATE_GATHERING,    /* gathering local candidates */
  NICE_COMPONENT_STATE_CONNECTING,   /* establishing connectivity */
  NICE_COMPONENT_STATE_CONNECTED,    /* at least one working candidate pair */
  NICE_COMPONENT_STATE_READY,        /* ICE concluded, candidate pair
					selection is now final */
  NICE_COMPONENT_STATE_FAILED        /* connectivity checks have been completed, 
					but connectivity was not established */
82 83
} NiceComponentState;

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
typedef enum
{
  NICE_COMPONENT_TYPE_RTP = 1,
  NICE_COMPONENT_TYPE_RTCP = 2
} NiceComponentType;

typedef struct _NiceCandidateDesc NiceCandidateDesc;

struct _NiceCandidateDesc {
  const gchar *foundation;         
  guint component_id;
  NiceCandidateTransport transport;
  guint32 priority;
  const NiceAddress *addr;
  NiceCandidateType type;
  const NiceAddress *related_addr;  /* optional */
};

102
typedef struct _NiceAgent NiceAgent;
Dafydd Harries's avatar
Dafydd Harries committed
103

104 105 106 107
typedef void (*NiceAgentRecvFunc) (
  NiceAgent *agent, guint stream_id, guint component_id, guint len,
  gchar *buf, gpointer user_data);

108
struct _NiceAgent
Dafydd Harries's avatar
Dafydd Harries committed
109
{
Dafydd Harries's avatar
Dafydd Harries committed
110
  GObject parent;
Dafydd Harries's avatar
Dafydd Harries committed
111
  guint next_candidate_id;
Dafydd Harries's avatar
Dafydd Harries committed
112
  guint next_stream_id;
113
  gboolean full_mode;
Dafydd Harries's avatar
Dafydd Harries committed
114
  NiceUDPSocketFactory *socket_factory;
Dafydd Harries's avatar
Dafydd Harries committed
115 116
  GSList *local_addresses;
  GSList *streams;
117 118 119 120
  gboolean main_context_set;
  GMainContext *main_context;
  NiceAgentRecvFunc read_func;
  gpointer read_func_data;
121 122 123 124 125 126 127 128
  GSList *discovery_list;
  guint discovery_unsched_items;
  GSList *conncheck_list;
  gchar *stun_server_ip;
  guint stun_server_port;
  gchar *turn_server_ip;
  guint turn_server_port;
  GTimeVal next_check_tv;
Dafydd Harries's avatar
Dafydd Harries committed
129
  NiceRNG *rng;
Dafydd Harries's avatar
Dafydd Harries committed
130 131
};

Dafydd Harries's avatar
Dafydd Harries committed
132 133 134 135 136 137 138 139 140
typedef struct _NiceAgentClass NiceAgentClass;

struct _NiceAgentClass
{
  GObjectClass parent_class;
};

GType nice_agent_get_type (void);

141
NiceAgent *
Dafydd Harries's avatar
Dafydd Harries committed
142
nice_agent_new (NiceUDPSocketFactory *factory);
143

Dafydd Harries's avatar
Dafydd Harries committed
144
void
145
nice_agent_add_local_address (NiceAgent *agent, NiceAddress *addr);
146

Dafydd Harries's avatar
Dafydd Harries committed
147
guint
148 149
nice_agent_add_stream (
  NiceAgent *agent,
150
  guint n_components);
151

Dafydd Harries's avatar
Dafydd Harries committed
152 153 154 155 156
void
nice_agent_remove_stream (
  NiceAgent *agent,
  guint stream_id);

157
void
158 159
nice_agent_add_remote_candidate (
  NiceAgent *agent,
160 161
  guint stream_id,
  guint component_id,
162 163
  NiceCandidateType type,
  NiceAddress *addr,
164 165
  const gchar *username,
  const gchar *password);
166

167 168 169 170 171 172 173
void
nice_agent_set_remote_candidates (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
  GSList *candidates);

Dafydd Harries's avatar
Dafydd Harries committed
174
guint
175
nice_agent_recv (
Dafydd Harries's avatar
Dafydd Harries committed
176 177 178 179 180 181
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
  guint buf_len,
  gchar *buf);

Dafydd Harries's avatar
Dafydd Harries committed
182 183 184 185 186 187 188 189 190
guint
nice_agent_recv_sock (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
  guint sock,
  guint buf_len,
  gchar *buf);

Dafydd Harries's avatar
Dafydd Harries committed
191 192 193
GSList *
nice_agent_poll_read (
  NiceAgent *agent,
194 195 196
  GSList *other_fds,
  NiceAgentRecvFunc func,
  gpointer data);
Dafydd Harries's avatar
Dafydd Harries committed
197

Dafydd Harries's avatar
Dafydd Harries committed
198 199 200 201 202 203
void
nice_agent_send (
  NiceAgent *agent,
  guint stream_id,
  guint component_id,
  guint len,
204
  const gchar *buf);
Dafydd Harries's avatar
Dafydd Harries committed
205

206
GSList *
207
nice_agent_get_local_candidates (
208 209 210
  NiceAgent *agent,
  guint stream_id,
  guint component_id);
Dafydd Harries's avatar
Dafydd Harries committed
211

212 213 214 215 216 217
GSList *
nice_agent_get_remote_candidates (
  NiceAgent *agent,
  guint stream_id,
  guint component_id);

218 219 220 221 222 223 224
gboolean
nice_agent_main_context_attach (
  NiceAgent *agent,
  GMainContext *ctx,
  NiceAgentRecvFunc func,
  gpointer data);

Dafydd Harries's avatar
Dafydd Harries committed
225 226
G_END_DECLS

Dafydd Harries's avatar
Dafydd Harries committed
227 228
#endif /* _AGENT_H */