constants.h 5.08 KB
Newer Older
1 2 3
/*
 * This file is part of the Nice GLib ICE library.
 *
4 5
 * (C) 2008 Collabora Ltd.
 *  Contact: Youness Alaoui
6
 * (C) 2008 Nokia Corporation. All rights reserved.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * 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.
 *
23 24
 * Contributors:
 *   Youness Alaoui, Collabora Ltd.
25 26 27 28 29 30 31 32 33 34 35 36
 *
 * 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.
 */

37 38
#ifndef _STUN_CONSTANTS_H
#define _STUN_CONSTANTS_H
39 40


41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
/**
 * SECTION:stunconstants
 * @short_description: STUN constants
 * @include: stun/constants.h
 * @stability: Stable
 *
 * Various constants defining parts of the STUN and TURN protocols and
 * on-the-wire packet formats.
 */

/**
 * STUN_ATTRIBUTE_LENGTH_LEN:
 *
 * Length of the length field of a STUN attribute (in bytes).
 */
/**
 * STUN_ATTRIBUTE_LENGTH_POS:
 *
 * Offset of the length field of a STUN attribute (in bytes).
 */
/**
 * STUN_ATTRIBUTE_TYPE_LEN:
 *
 * Length of the type field of a STUN attribute (in bytes).
 */
/**
 * STUN_ATTRIBUTE_TYPE_POS:
 *
 * Offset of the type field of a STUN attribute (in bytes).
 */
/**
 * STUN_ATTRIBUTE_VALUE_POS:
 *
 * Offset of the value field of a STUN attribute (in bytes).
 */
/**
 * STUN_ID_LEN:
 *
 * Length of the ID field of a STUN message (in bytes).
 */
/**
 * STUN_MAGIC_COOKIE:
 *
 * Magic cookie value used to identify STUN messages.
 */
/**
 * TURN_MAGIC_COOKIE:
 *
 * Magic cookie value used to identify TURN messages.
 */
/**
 * STUN_MAX_MESSAGE_SIZE_IPV4:
 *
 * Maximum size of a STUN message sent over IPv4 (in bytes).
 */
/**
 * STUN_MAX_MESSAGE_SIZE_IPV6:
 *
 * Maximum size of a STUN message sent over IPv6 (in bytes).
 */
/**
 * STUN_MESSAGE_ATTRIBUTES_POS:
 *
 * Offset of the attributes of a STUN message (in bytes).
 */
/**
 * STUN_MESSAGE_HEADER_LENGTH:
 *
 * Total length of a STUN message header (in bytes).
 */
/**
 * STUN_MESSAGE_LENGTH_LEN:
 *
 * Length of the length field of a STUN message (in bytes).
 */
/**
 * STUN_MESSAGE_LENGTH_POS:
 *
 * Offset of the length field of a STUN message (in bytes).
 */
/**
 * STUN_MESSAGE_TRANS_ID_LEN:
 *
 * Length of the transaction ID field of a STUN message (in bytes).
 */
/**
 * STUN_MESSAGE_TRANS_ID_POS:
 *
 * Offset of the transaction ID field of a STUN message (in bytes).
 */
/**
 * STUN_MESSAGE_TYPE_LEN:
 *
 * Length of the type field of a STUN message (in bytes).
 */
/**
 * STUN_MESSAGE_TYPE_POS:
 *
 * Offset of the type field of a STUN message (in bytes).
 */

142 143 144 145 146 147 148 149 150 151
#define STUN_MESSAGE_TYPE_POS 0
#define STUN_MESSAGE_TYPE_LEN 2
#define STUN_MESSAGE_LENGTH_POS \
  (STUN_MESSAGE_TYPE_POS + STUN_MESSAGE_TYPE_LEN)
#define STUN_MESSAGE_LENGTH_LEN 2
#define STUN_MESSAGE_TRANS_ID_POS \
  (STUN_MESSAGE_LENGTH_POS + STUN_MESSAGE_LENGTH_LEN)
#define STUN_MESSAGE_TRANS_ID_LEN 16
#define STUN_MESSAGE_ATTRIBUTES_POS \
  (STUN_MESSAGE_TRANS_ID_POS + STUN_MESSAGE_TRANS_ID_LEN)
152

153 154 155 156 157 158 159 160 161 162
#define STUN_MESSAGE_HEADER_LENGTH STUN_MESSAGE_ATTRIBUTES_POS

#define STUN_ATTRIBUTE_TYPE_POS 0
#define STUN_ATTRIBUTE_TYPE_LEN 2
#define STUN_ATTRIBUTE_LENGTH_POS \
  (STUN_ATTRIBUTE_TYPE_POS + STUN_ATTRIBUTE_TYPE_LEN)
#define STUN_ATTRIBUTE_LENGTH_LEN 2
#define STUN_ATTRIBUTE_VALUE_POS \
  (STUN_ATTRIBUTE_LENGTH_POS + STUN_ATTRIBUTE_LENGTH_LEN)

163 164 165 166 167
/**
 * STUN_ATTRIBUTE_HEADER_LENGTH:
 *
 * Length of a single STUN attribute header (in bytes).
 */
168 169 170 171 172
#define STUN_ATTRIBUTE_HEADER_LENGTH STUN_ATTRIBUTE_VALUE_POS


#define STUN_MAX_MESSAGE_SIZE_IPV4 576
#define STUN_MAX_MESSAGE_SIZE_IPV6 1280
173
/* #define STUN_MAX_MESSAGE_SIZE STUN_MAX_MESSAGE_SIZE_IPV4 */
174 175 176

#define STUN_ID_LEN 16

177 178 179 180 181
/**
 * STUN_AGENT_MAX_SAVED_IDS:
 *
 * Maximum number of simultaneously ongoing STUN transactions.
 */
182
#define STUN_AGENT_MAX_SAVED_IDS 200
183 184 185 186 187 188 189

/**
 * STUN_AGENT_MAX_UNKNOWN_ATTRIBUTES:
 *
 * Maximum number of unknown attribute which can be handled in a single STUN
 * message.
 */
190
#define STUN_AGENT_MAX_UNKNOWN_ATTRIBUTES 256
191

192
#define STUN_MAGIC_COOKIE 0x2112A442
193
#define TURN_MAGIC_COOKIE 0x72c64bc6
194 195 196 197 198 199 200 201 202 203

#ifndef TRUE
#define TRUE (1 == 1)
#endif

#ifndef FALSE
#define FALSE (0 == 1)
#endif

#endif /* _STUN_CONSTANTS_H */