conncheck.h 3.54 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
/*
 * 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_CONNCHECK_H
#define _NICE_CONNCHECK_H

/* note: this is a private header to libnice */

#include "agent.h"
#include "stream.h"
46 47
#include "stun/usages/stun-ice.h"
#include "stun/usages/bind.h"
48 49

#define NICE_CANDIDATE_PAIR_MAX_FOUNDATION        NICE_CANDIDATE_MAX_FOUNDATION*2
50 51 52 53 54 55 56 57

typedef enum
{
  NICE_CHECK_WAITING = 1,   /**< waiting to be scheduled */
  NICE_CHECK_IN_PROGRESS,   /**< conn. checks started */
  NICE_CHECK_SUCCEEDED,     /**< conn. succesfully checked */
  NICE_CHECK_FAILED,        /**< no connectivity, retransmissions ceased */
  NICE_CHECK_FROZEN,        /**< waiting to be scheduled to WAITING */
58 59
  NICE_CHECK_CANCELLED,     /**< check cancelled */
  NICE_CHECK_DISCOVERED     /**< a valid candidate pair not on check list */
60 61 62 63 64 65 66 67 68 69 70
} NiceCheckState;

typedef struct _CandidateCheckPair CandidateCheckPair;

struct _CandidateCheckPair
{
  NiceAgent *agent;         /* back pointer to owner */
  guint stream_id;
  guint component_id;
  NiceCandidate *local;
  NiceCandidate *remote;
71
  gchar foundation[NICE_CANDIDATE_PAIR_MAX_FOUNDATION];
72 73
  NiceCheckState state;
  gboolean nominated;
74
  gboolean controlling;
Youness Alaoui's avatar
Youness Alaoui committed
75
  guint64 priority;
76
  GTimeVal next_tick;       /* next tick timestamp */
77
  gboolean traffic_after_tick;
78 79 80 81 82 83
  stun_bind_t *stun_ctx;
};

int conn_check_add_for_candidate (NiceAgent *agent, guint stream_id, Component *component, NiceCandidate *remote);
void conn_check_free_item (gpointer data, gpointer user_data);
void conn_check_free (NiceAgent *agent);
84
gboolean conn_check_schedule_next (NiceAgent *agent);
85
int conn_check_send (NiceAgent *agent, CandidateCheckPair *pair);
86
gboolean conn_check_prune_stream (NiceAgent *agent, Stream *stream);
87 88
gboolean conn_check_handle_inbound_stun (NiceAgent *agent, Stream *stream, Component *component, NiceUDPSocket *udp_socket, const NiceAddress *from, gchar *buf, guint len);
gint conn_check_compare (const CandidateCheckPair *a, const CandidateCheckPair *b);
89
void conn_check_remote_candidates_set(NiceAgent *agent);
90 91

#endif /*_NICE_CONNCHECK_H */