agent/candidate.h

   1 /*
   2  * This file is part of the Nice GLib ICE library.
   3  *
   4  * (C) 2006, 2007 Collabora Ltd.
   5  *  Contact: Dafydd Harries
   6  * (C) 2006, 2007 Nokia Corporation. All rights reserved.
   7  *  Contact: Kai Vehmanen
   8  *
   9  * The contents of this file are subject to the Mozilla Public License Version
  10  * 1.1 (the "License"); you may not use this file except in compliance with
  11  * the License. You may obtain a copy of the License at
  12  * http://www.mozilla.org/MPL/
  13  *
  14  * Software distributed under the License is distributed on an "AS IS" basis,
  15  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  16  * for the specific language governing rights and limitations under the
  17  * License.
  18  *
  19  * The Original Code is the Nice GLib ICE library.
  20  *
  21  * The Initial Developers of the Original Code are Collabora Ltd and Nokia
  22  * Corporation. All Rights Reserved.
  23  *
  24  * Contributors:
  25  *   Dafydd Harries, Collabora Ltd.
  26  *   Kai Vehmanen, Nokia
  27  *
  28  * Alternatively, the contents of this file may be used under the terms of the
  29  * the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
  30  * case the provisions of LGPL are applicable instead of those above. If you
  31  * wish to allow use of your version of this file only under the terms of the
  32  * LGPL and not to allow others to use your version of this file under the
  33  * MPL, indicate your decision by deleting the provisions above and replace
  34  * them with the notice and other provisions required by the LGPL. If you do
  35  * not delete the provisions above, a recipient may use your version of this
  36  * file under either the MPL or the LGPL.
  37  */
  38
  39 #ifndef _CANDIDATE_H
  40 #define _CANDIDATE_H
  41
  42 #include "udp.h"
  43
  44 G_BEGIN_DECLS
  45
  46 #define NICE_CANDIDATE_TYPE_PREF_HOST                 120
  47 #define NICE_CANDIDATE_TYPE_PREF_PEER_REFLEXIVE       110
  48 #define NICE_CANDIDATE_TYPE_PREF_SERVER_REFLEXIVE     100
  49 #define NICE_CANDIDATE_TYPE_PREF_RELAYED               60
  50
  51 /* Max foundation size '1*32ice-char' plus terminating NULL, ICE ID-19  */
  52 #define NICE_CANDIDATE_MAX_FOUNDATION                32+1
  53
  54 typedef enum
  55 {
  56   NICE_CANDIDATE_TYPE_HOST,
  57   NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE,
  58   NICE_CANDIDATE_TYPE_PEER_REFLEXIVE,
  59   NICE_CANDIDATE_TYPE_RELAYED,
  60 } NiceCandidateType;
  61
  62 typedef enum
  63 {
  64   NICE_CANDIDATE_TRANSPORT_UDP,
  65 } NiceCandidateTransport;
  66
  67 typedef struct _NiceCandidate NiceCandidate;
  68
  69 struct _NiceCandidate
  70 {
  71   NiceCandidateType type;
  72   NiceCandidateTransport transport;
  73   NiceAddress addr;
  74   NiceAddress base_addr;
  75   guint32 priority;
  76   guint stream_id;
  77   guint component_id;
  78   gchar foundation[NICE_CANDIDATE_MAX_FOUNDATION];
  79   NiceUDPSocket *sockptr;
  80   gchar *username;        /* pointer to a NULL-terminated username string */
  81   gchar *password;        /* pointer to a NULL-terminated password string */
  82 };
  83
  84
  85 NiceCandidate *
  86 nice_candidate_new (NiceCandidateType type);
  87
  88 void
  89 nice_candidate_free (NiceCandidate *candidate);
  90
  91 gfloat
  92 nice_candidate_jingle_priority (NiceCandidate *candidate);
  93
  94 gfloat
  95 nice_candidate_msn_priority (NiceCandidate *candidate);
  96
  97 guint32
  98 nice_candidate_ice_priority_full (guint type_pref, guint local_pref, guint component_id);
  99
 100 guint32
 101 nice_candidate_ice_priority (const NiceCandidate *candidate);
 102
 103 guint64
 104 nice_candidate_pair_priority (guint32 o_prio, guint32 a_prio);
 105
 106 NiceCandidate *
 107 nice_candidate_copy (const NiceCandidate *candidate);
 108
 109 G_END_DECLS
 110
 111 #endif /* _CANDIDATE_H */
 112