Mercurial > hg > freeDiameter
annotate include/freeDiameter/libfreeDiameter.h @ 7:e5af94b04946
Added dispatch module and tests
| author | Sebastien Decugis <sdecugis@nict.go.jp> |
|---|---|
| date | Fri, 04 Sep 2009 18:05:25 +0900 |
| parents | b0d377c79d80 |
| children | 3e143f047f78 |
| rev | line source |
|---|---|
| 0 | 1 /********************************************************************************************************* |
| 2 * Software License Agreement (BSD License) * | |
| 3 * Author: Sebastien Decugis <sdecugis@nict.go.jp> * | |
| 4 * * | |
| 5 * Copyright (c) 2009, WIDE Project and NICT * | |
| 6 * All rights reserved. * | |
| 7 * * | |
| 8 * Redistribution and use of this software in source and binary forms, with or without modification, are * | |
| 9 * permitted provided that the following conditions are met: * | |
| 10 * * | |
| 11 * * Redistributions of source code must retain the above * | |
| 12 * copyright notice, this list of conditions and the * | |
| 13 * following disclaimer. * | |
| 14 * * | |
| 15 * * Redistributions in binary form must reproduce the above * | |
| 16 * copyright notice, this list of conditions and the * | |
| 17 * following disclaimer in the documentation and/or other * | |
| 18 * materials provided with the distribution. * | |
| 19 * * | |
| 20 * * Neither the name of the WIDE Project or NICT nor the * | |
| 21 * names of its contributors may be used to endorse or * | |
| 22 * promote products derived from this software without * | |
| 23 * specific prior written permission of WIDE Project and * | |
| 24 * NICT. * | |
| 25 * * | |
| 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED * | |
| 27 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A * | |
| 28 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR * | |
| 29 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * | |
| 30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * | |
| 31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR * | |
| 32 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * | |
| 33 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * | |
| 34 *********************************************************************************************************/ | |
| 35 | |
|
1
bafb831ba688
Fix names to proper case for freeDiameter
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
0
diff
changeset
|
36 /* This file contains the definitions of functions and types used by the libfreeDiameter library. |
| 0 | 37 * |
|
1
bafb831ba688
Fix names to proper case for freeDiameter
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
0
diff
changeset
|
38 * This library is meant to be used by both the freeDiameter daemon and its extensions. |
| 0 | 39 * |
| 40 * It provides the tools to manipulate Diameter messages and related data. | |
| 41 * | |
|
1
bafb831ba688
Fix names to proper case for freeDiameter
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
0
diff
changeset
|
42 * This file should always be included as #include <freeDiameter/libfreeDiameter.h> |
| 0 | 43 */ |
| 44 | |
| 45 #ifndef _LIBFREEDIAMETER_H | |
| 46 #define _LIBFREEDIAMETER_H | |
| 47 | |
| 48 #ifndef FD_IS_CONFIG | |
|
1
bafb831ba688
Fix names to proper case for freeDiameter
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
0
diff
changeset
|
49 #error "You must include 'freeDiameter-host.h' before this file." |
| 0 | 50 #endif /* FD_IS_CONFIG */ |
| 51 | |
| 52 #include <pthread.h> | |
| 53 #include <string.h> | |
| 54 #include <assert.h> | |
| 55 #include <errno.h> | |
| 56 #include <arpa/inet.h> | |
| 57 #include <sys/socket.h> | |
| 58 #include <netdb.h> | |
| 59 #include <stdio.h> | |
| 60 #include <stdlib.h> | |
| 61 #include <unistd.h> | |
| 62 | |
| 63 /*============================================================*/ | |
| 64 /* DEBUG */ | |
| 65 /*============================================================*/ | |
| 66 #ifndef ASSERT | |
| 67 #define ASSERT(x) assert(x) | |
| 68 #endif /* ASSERT */ | |
| 69 | |
| 70 /* | |
| 71 * FUNCTION: fd_log_debug | |
| 72 * | |
| 73 * PARAMETERS: | |
| 74 * format : Same format string as in the printf function | |
| 75 * ... : Same list as printf | |
| 76 * | |
| 77 * DESCRIPTION: | |
| 78 * Log internal information for use of developpers only. | |
| 79 * The format and arguments may contain UTF-8 encoded data. The | |
| 80 * output medium (file or console) is expected to support this encoding. | |
| 81 * | |
| 82 * This function assumes that a global mutex called "fd_log_lock" exists | |
| 83 * in the address space of the current process. | |
| 84 * | |
| 85 * RETURN VALUE: | |
| 86 * None. | |
| 87 */ | |
| 88 void fd_log_debug ( char * format, ... ); | |
| 89 extern pthread_mutex_t fd_log_lock; | |
| 90 | |
| 91 /* | |
| 92 * FUNCTION: fd_log_threadname | |
| 93 * | |
| 94 * PARAMETERS: | |
| 95 * name : \0-terminated string containing a name to identify the current thread. | |
| 96 * | |
| 97 * DESCRIPTION: | |
| 98 * Name the current thread, useful for debugging multi-threaded problems. | |
| 99 * | |
| 100 * This function assumes that a global thread-specific key called "fd_log_thname" exists | |
| 101 * in the address space of the current process. | |
| 102 * | |
| 103 * RETURN VALUE: | |
| 104 * None. | |
| 105 */ | |
| 106 void fd_log_threadname ( char * name ); | |
| 107 extern pthread_key_t fd_log_thname; | |
| 108 | |
| 109 /* | |
| 110 * FUNCTION: fd_log_time | |
| 111 * | |
| 112 * PARAMETERS: | |
| 113 * buf : An array where the time must be stored | |
| 114 * len : size of the buffer | |
| 115 * | |
| 116 * DESCRIPTION: | |
| 117 * Writes the current timestamp (in human readable format) in a buffer. | |
| 118 * | |
| 119 * RETURN VALUE: | |
| 120 * pointer to buf. | |
| 121 */ | |
| 122 char * fd_log_time ( char * buf, size_t len ); | |
| 123 | |
| 124 | |
| 125 /* levels definitions */ | |
| 126 #define NONE 0 /* Display no debug message */ | |
| 127 #define INFO 1 /* Display errors only */ | |
| 128 #define FULL 2 /* Display additional information to follow code execution */ | |
| 129 #define ANNOYING 4 /* Very verbose, for example in loops */ | |
| 130 #define FCTS 6 /* Display entry parameters of most functions */ | |
| 131 #define CALL 9 /* Display calls to most functions (with CHECK macros) */ | |
| 132 | |
| 133 /* Default level is INFO */ | |
| 134 #ifndef TRACE_LEVEL | |
| 135 #define TRACE_LEVEL INFO | |
| 136 #endif /* TRACE_LEVEL */ | |
| 137 | |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
138 /* The level of the file being compiled. */ |
| 0 | 139 static int local_debug_level = TRACE_LEVEL; |
| 140 | |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
141 /* A global level, changed by configuration or cmd line for example. default is 0. */ |
|
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
142 extern int fd_g_debug_lvl; |
|
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
143 |
|
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
144 /* Some portability code to get nice function name in __PRETTY_FUNCTION__ */ |
| 0 | 145 #if __STDC_VERSION__ < 199901L |
| 146 # if __GNUC__ >= 2 | |
| 147 # define __func__ __FUNCTION__ | |
| 148 # else /* __GNUC__ >= 2 */ | |
| 149 # define __func__ "<unknown>" | |
| 150 # endif /* __GNUC__ >= 2 */ | |
| 151 #endif /* __STDC_VERSION__ < 199901L */ | |
| 152 #ifndef __PRETTY_FUNCTION__ | |
| 153 #define __PRETTY_FUNCTION__ __func__ | |
| 154 #endif /* __PRETTY_FUNCTION__ */ | |
| 155 | |
| 156 /* Boolean for tracing at a certain level */ | |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
157 #define TRACE_BOOL(_level_) ( (_level_) <= local_debug_level + fd_g_debug_lvl ) |
| 0 | 158 |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
159 /* The general debug macro, each call results in two lines of debug messages (change the macro for more compact output) */ |
| 0 | 160 #define TRACE_DEBUG(level,format,args... ) { \ |
| 161 if ( TRACE_BOOL(level) ) { \ | |
| 162 char __buf[25]; \ | |
| 163 char * __thn = ((char *)pthread_getspecific(fd_log_thname) ?: "unnamed"); \ | |
| 164 fd_log_debug("\t | th:%-30s\t%s\tin %s@%s:%d\n" \ | |
| 165 "\t%s|%*s" format "\n", \ | |
| 166 __thn, fd_log_time(__buf, sizeof(__buf)), __PRETTY_FUNCTION__, __FILE__, __LINE__, \ | |
| 167 (level < FULL)?"@":" ",level, "", ## args); \ | |
| 168 } \ | |
| 169 } | |
| 170 | |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
171 /* Helper for function entry -- for very detailed trace of the execution */ |
| 0 | 172 #define TRACE_ENTRY(_format,_args... ) \ |
| 173 TRACE_DEBUG(FCTS, "->%s (" #_args ") = (" _format ") >", __PRETTY_FUNCTION__, ##_args ); | |
| 174 | |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
175 /* Helper for debugging by adding traces -- for debuging a specific location of the code */ |
| 0 | 176 #define TRACE_HERE() \ |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
177 TRACE_DEBUG(NONE, " -- debug checkpoint -- "); |
| 0 | 178 |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
179 /* Helper for tracing the CHECK_* macros bellow -- very very verbose code execution! */ |
| 0 | 180 #define TRACE_DEBUG_ALL( str ) \ |
| 181 TRACE_DEBUG(CALL, str ); | |
| 182 | |
| 183 | |
| 184 /* Macros to check a return value and branch out in case of error. | |
| 185 * These macro must be used only when errors are highly improbable, not for expected errors. | |
| 186 */ | |
| 187 | |
| 188 /* Check the return value of a system function and execute fallback in case of error */ | |
| 189 #define CHECK_SYS_DO( __call__, __fallback__ ) { \ | |
| 190 int __ret__; \ | |
| 191 TRACE_DEBUG_ALL( "Check SYS: " #__call__ ); \ | |
| 192 __ret__ = (__call__); \ | |
| 193 if (__ret__ < 0) { \ | |
| 194 int __err__ = errno; /* We may handle EINTR here */ \ | |
| 195 TRACE_DEBUG(NONE, "ERROR: in '" #__call__ "' :\t%s", strerror(__err__));\ | |
| 196 __fallback__; \ | |
| 197 } \ | |
| 198 } | |
| 199 /* Check the return value of a system function, return error code on error */ | |
| 200 #define CHECK_SYS( __call__ ) { \ | |
| 201 int __ret__; \ | |
| 202 TRACE_DEBUG_ALL( "Check SYS: " #__call__ ); \ | |
| 203 __ret__ = (__call__); \ | |
| 204 if (__ret__ < 0) { \ | |
| 205 int __err__ = errno; /* We may handle EINTR here */ \ | |
| 206 TRACE_DEBUG(NONE, "ERROR: in '" #__call__ "' :\t%s", strerror(__err__));\ | |
| 207 return __err__; \ | |
| 208 } \ | |
| 209 } | |
| 210 | |
| 211 /* Check the return value of a POSIX function and execute fallback in case of error or special value */ | |
| 212 #define CHECK_POSIX_DO2( __call__, __speval__, __fallback1__, __fallback2__ ) { \ | |
| 213 int __ret__; \ | |
| 214 TRACE_DEBUG_ALL( "Check POSIX: " #__call__ ); \ | |
| 215 __ret__ = (__call__); \ | |
| 216 if (__ret__ != 0) { \ | |
| 217 if (__ret__ == (__speval__)) { \ | |
| 218 __fallback1__; \ | |
| 219 } else { \ | |
| 220 TRACE_DEBUG(NONE, "ERROR: in '" #__call__ "':\t%s", strerror(__ret__)); \ | |
| 221 __fallback2__; \ | |
| 222 } \ | |
| 223 } \ | |
| 224 } | |
| 225 | |
| 226 /* Check the return value of a POSIX function and execute fallback in case of error */ | |
| 227 #define CHECK_POSIX_DO( __call__, __fallback__ ) \ | |
| 228 CHECK_POSIX_DO2( (__call__), 0, , __fallback__ ); | |
| 229 | |
| 230 /* Check the return value of a POSIX function and return it if error */ | |
| 231 #define CHECK_POSIX( __call__ ) { \ | |
| 232 int __v__; \ | |
| 233 CHECK_POSIX_DO( __v__ = (__call__), return __v__ ); \ | |
| 234 } | |
| 235 | |
| 236 /* Check that a memory allocator did not return NULL, otherwise log an error and execute fallback */ | |
| 237 #define CHECK_MALLOC_DO( __call__, __fallback__ ) { \ | |
| 238 void * __ret__; \ | |
| 239 TRACE_DEBUG_ALL( "Check MALLOC: " #__call__ ); \ | |
| 240 __ret__ = (void *)( __call__ ); \ | |
| 241 if (__ret__ == NULL) { \ | |
| 242 int __err__ = errno; \ | |
| 243 TRACE_DEBUG(NONE, "ERROR: in '" #__call__ "':\t%s", strerror(__err__)); \ | |
| 244 __fallback__; \ | |
| 245 } \ | |
| 246 } | |
| 247 | |
| 248 /* Check that a memory allocator did not return NULL, otherwise return ENOMEM */ | |
| 249 #define CHECK_MALLOC( __call__ ) \ | |
| 250 CHECK_MALLOC_DO( __call__, return ENOMEM ); | |
| 251 | |
| 252 | |
| 253 /* The next macros can be used also for expected errors */ | |
| 254 | |
| 255 /* Check parameters at function entry, execute fallback on error */ | |
| 256 #define CHECK_PARAMS_DO( __bool__, __fallback__ ) \ | |
| 257 TRACE_DEBUG_ALL( "Check PARAMS: " #__bool__ ); \ | |
| 258 if ( ! (__bool__) ) { \ | |
| 259 TRACE_DEBUG(INFO, "Invalid parameter received in '" #__bool__ "'"); \ | |
| 260 __fallback__; \ | |
| 261 } | |
| 262 /* Check parameters at function entry, return EINVAL if the boolean is false (similar to assert) */ | |
| 263 #define CHECK_PARAMS( __bool__ ) \ | |
| 264 CHECK_PARAMS_DO( __bool__, return EINVAL ); | |
| 265 | |
| 266 /* Check the return value of an internal function, log and propagate */ | |
| 267 #define CHECK_FCT_DO( __call__, __fallback__ ) { \ | |
| 268 int __ret__; \ | |
| 269 TRACE_DEBUG_ALL( "Check FCT: " #__call__ ); \ | |
| 270 __ret__ = (__call__); \ | |
| 271 if (__ret__ != 0) { \ | |
| 272 TRACE_DEBUG(INFO, "Error in '" #__call__ "':\t%s", strerror(__ret__)); \ | |
| 273 __fallback__; \ | |
| 274 } \ | |
| 275 } | |
| 276 /* Check the return value of a function call, return any error code */ | |
| 277 #define CHECK_FCT( __call__ ) { \ | |
| 278 int __v__; \ | |
| 279 CHECK_FCT_DO( __v__ = (__call__), return __v__ ); \ | |
| 280 } | |
| 281 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
282 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
283 /*============================================================*/ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
284 /* MACROS */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
285 /*============================================================*/ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
286 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
287 /* helper macros (pre-processor hacks to allow macro arguments) */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
288 #define __str( arg ) #arg |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
289 #define _stringize( arg ) __str( arg ) |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
290 #define __agr( arg1, arg2 ) arg1 ## arg2 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
291 #define _aggregate( arg1, arg2 ) __agr( arg1, arg2 ) |
| 0 | 292 |
| 293 /* Some aliases to socket addresses structures */ | |
| 294 #define sSS struct sockaddr_storage | |
| 295 #define sSA struct sockaddr | |
| 296 #define sSA4 struct sockaddr_in | |
| 297 #define sSA6 struct sockaddr_in6 | |
| 298 | |
| 299 /* Dump one sockaddr */ | |
| 300 #define sSA_DUMP( level, text, sa ) { \ | |
| 301 sSA * __sa = (sSA *)(sa); \ | |
| 302 char *__str, __addrbuf[INET6_ADDRSTRLEN]; \ | |
| 303 if (__sa) { \ | |
| 304 int __rc = getnameinfo(__sa, \ | |
| 305 sizeof(sSS), \ | |
| 306 __addrbuf, \ | |
| 307 sizeof(__addrbuf), \ | |
| 308 NULL, \ | |
| 309 0, \ | |
| 310 0); \ | |
| 311 if (__rc) \ | |
| 312 __str = (char *)gai_strerror(__rc); \ | |
| 313 else \ | |
| 314 __str = &__addrbuf[0]; \ | |
| 315 } else { \ | |
| 316 __str = "(NULL / ANY)"; \ | |
| 317 } \ | |
| 318 TRACE_DEBUG(level, text "%s", __str); \ | |
| 319 } | |
| 320 | |
| 321 /* The sockaddr length of a sSS structure */ | |
| 322 #define sSSlen( _ss_ ) \ | |
| 323 ( (socklen_t) ( ((_ss_)->ss_family == AF_INET) ? (sizeof(sSA4)) : \ | |
| 324 (((_ss_)->ss_family == AF_INET6) ? (sizeof(sSA6)) : \ | |
| 325 0 ) ) ) | |
| 326 | |
| 327 /* Define the value of IP loopback address */ | |
| 328 #ifndef INADDR_LOOPBACK | |
| 329 #define INADDR_LOOPBACK inet_addr("127.0.0.1") | |
| 330 #endif /* INADDR_LOOPBACK */ | |
| 331 | |
| 332 /* create a V4MAPPED address */ | |
| 333 #define IN6_ADDR_V4MAP( a6, a4 ) { \ | |
| 334 ((uint32_t *)(a6))[0] = 0; \ | |
| 335 ((uint32_t *)(a6))[1] = 0; \ | |
| 336 ((uint32_t *)(a6))[2] = htonl(0xffff); \ | |
| 337 ((uint32_t *)(a6))[3] = (uint32_t)(a4); \ | |
| 338 } | |
| 339 | |
| 340 /* Retrieve a v4 value from V4MAPPED address ( takes a s6_addr as param) */ | |
| 341 #define IN6_ADDR_V4UNMAP( a6 ) \ | |
| 342 (((in_addr_t *)(a6))[3]) | |
| 343 | |
| 344 | |
| 345 /* We provide macros to convert 64 bit values to and from network byte-order, on systems where it is not already provided. */ | |
| 346 #ifndef HAVE_NTOHLL /* Defined in config.h, if the ntohll symbol is defined on the system */ | |
| 347 # if HOST_BIG_ENDIAN | |
| 348 /* In big-endian systems, we don't have to change the values, since the order is the same as network */ | |
| 349 # define ntohll(x) (x) | |
| 350 # define htonll(x) (x) | |
| 351 # else /* HOST_BIG_ENDIAN */ | |
| 352 /* For these systems, we must reverse the bytes. Use ntohl and htonl on sub-32 blocs, and inverse these blocs. */ | |
| 353 # define ntohll(x) (typeof (x))( (((uint64_t)ntohl( (uint32_t)(x))) << 32 ) | ((uint64_t) ntohl( ((uint64_t)(x)) >> 32 ))) | |
| 354 # define htonll(x) (typeof (x))( (((uint64_t)htonl( (uint32_t)(x))) << 32 ) | ((uint64_t) htonl( ((uint64_t)(x)) >> 32 ))) | |
| 355 # endif /* HOST_BIG_ENDIAN */ | |
| 356 #endif /* HAVE_NTOHLL */ | |
| 357 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
358 /* This macro will give the next multiple of 4 for an integer (used for padding sizes of AVP). */ |
| 0 | 359 #define PAD4(_x) ((_x) + ( (4 - (_x)) & 3 ) ) |
| 360 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
361 /* Useful to display as safe ASCII a value (will garbage UTF-8 output...) */ |
| 0 | 362 #define ASCII(_c) ( ((_c < 32) || (_c > 127)) ? ( _c ? '?' : ' ' ) : _c ) |
| 363 | |
| 364 /* Compare timespec structures */ | |
| 365 #define TS_IS_INFERIOR( ts1, ts2 ) \ | |
| 366 ( ((ts1)->tv_sec < (ts2)->tv_sec ) \ | |
|
5
c2d2729e3603
Completed new session module tests; some bugs fixed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
3
diff
changeset
|
367 || (((ts1)->tv_sec == (ts2)->tv_sec ) && ((ts1)->tv_nsec < (ts2)->tv_nsec) )) |
| 0 | 368 |
| 369 | |
| 370 /*============================================================*/ | |
| 371 /* THREADS */ | |
| 372 /*============================================================*/ | |
| 373 | |
| 374 /* Terminate a thread */ | |
| 375 static __inline__ int fd_thr_term(pthread_t * th) | |
| 376 { | |
| 377 int ret = 0; | |
| 378 void * th_ret = NULL; | |
| 379 | |
| 380 CHECK_PARAMS(th); | |
| 381 | |
| 382 /* Test if it was already terminated */ | |
| 383 if (*th == (pthread_t)NULL) | |
| 384 return 0; | |
| 385 | |
| 386 /* Cancel the thread if it is still running - ignore error if it was already terminated */ | |
| 387 (void) pthread_cancel(*th); | |
| 388 | |
| 389 /* Then join the thread */ | |
| 390 CHECK_POSIX_DO( ret = pthread_join(*th, &th_ret), /* continue */ ); | |
| 391 | |
| 392 if (th_ret != NULL) { | |
| 393 TRACE_DEBUG(FULL, "The thread returned the following value: %p (ignored)", th_ret); | |
| 394 } | |
| 395 | |
| 396 /* Clean the location */ | |
| 397 *th = (pthread_t)NULL; | |
| 398 | |
| 399 return ret; | |
| 400 } | |
| 401 | |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
402 /* Cleanups for cancellation (all threads should be safely cancelable...) */ |
| 0 | 403 static __inline__ void fd_cleanup_mutex( void * mutex ) |
| 404 { | |
| 405 CHECK_POSIX_DO( pthread_mutex_unlock((pthread_mutex_t *)mutex), /* */); | |
| 406 } | |
| 407 | |
| 408 static __inline__ void fd_cleanup_rwlock( void * rwlock ) | |
| 409 { | |
| 410 CHECK_POSIX_DO( pthread_rwlock_unlock((pthread_rwlock_t *)rwlock), /* */); | |
| 411 } | |
| 412 | |
| 413 static __inline__ void fd_cleanup_buffer( void * buffer ) | |
| 414 { | |
| 415 free(buffer); | |
| 416 } | |
| 417 | |
| 418 /*============================================================*/ | |
| 419 /* LISTS */ | |
| 420 /*============================================================*/ | |
| 421 | |
| 422 /* The following structure represents a chained list element */ | |
| 423 struct fd_list { | |
| 424 struct fd_list *next; /* next element in the list */ | |
| 425 struct fd_list *prev; /* previous element in the list */ | |
| 426 struct fd_list *head; /* head of the list */ | |
| 427 void *o; /* additional avialbe pointer used for start of the parento object or other purpose */ | |
| 428 }; | |
| 429 | |
| 430 #define FD_LIST( _li ) ((struct fd_list *)( _li )) | |
| 431 | |
| 432 /* Initialize a list element */ | |
| 433 void fd_list_init ( struct fd_list * list, void *obj ); | |
| 434 | |
| 435 /* Return boolean, true if the list is empty */ | |
| 436 #define FD_IS_LIST_EMPTY( _list ) (((FD_LIST(_list))->head == (_list)) && ((FD_LIST(_list))->next == (_list))) | |
| 437 | |
| 438 /* Insert an item in a list at known position */ | |
| 439 void fd_list_insert_after ( struct fd_list * ref, struct fd_list * item ); | |
| 440 void fd_list_insert_before ( struct fd_list * ref, struct fd_list * item ); | |
| 441 | |
| 442 /* Insert an item in an ordered list -- ordering function provided. If duplicate object found, EEXIST and it is returned in ref_duplicate */ | |
| 443 int fd_list_insert_ordered( struct fd_list * head, struct fd_list * item, int (*cmp_fct)(void *, void *), void ** ref_duplicate); | |
| 444 | |
| 445 /* Unlink an item from a list */ | |
| 446 void fd_list_unlink ( struct fd_list * item ); | |
| 447 | |
| 448 /* Compute a hash value of a string (session id, diameter id, ...) */ | |
| 449 uint32_t fd_hash ( char * string, size_t len ); | |
| 450 | |
| 451 | |
| 452 | |
| 453 /*============================================================*/ | |
| 454 /* DICTIONARY */ | |
| 455 /*============================================================*/ | |
| 456 /* Structure that contains the complete dictionary definitions */ | |
| 457 struct dictionary; | |
| 458 | |
| 459 /* Structure that contains a dictionary object */ | |
| 460 struct dict_object; | |
| 461 | |
| 462 /* Types of object in the dictionary. */ | |
| 463 enum dict_object_type { | |
| 464 DICT_VENDOR = 1, /* Vendor */ | |
| 465 DICT_APPLICATION, /* Diameter Application */ | |
| 466 DICT_TYPE, /* AVP data type */ | |
| 467 DICT_ENUMVAL, /* Named constant (value of an enumerated AVP type) */ | |
| 468 DICT_AVP, /* AVP */ | |
| 469 DICT_COMMAND, /* Diameter Command */ | |
| 470 DICT_RULE /* a Rule for AVP in command or grouped AVP */ | |
| 471 #define DICT_TYPE_MAX DICT_RULE | |
| 472 }; | |
| 473 | |
| 474 /* Initialize a dictionary */ | |
| 475 int fd_dict_init(struct dictionary ** dict); | |
| 476 /* Destroy a dictionary */ | |
| 477 int fd_dict_fini(struct dictionary ** dict); | |
| 478 | |
| 479 /* | |
| 480 * FUNCTION: fd_dict_new | |
| 481 * | |
| 482 * PARAMETERS: | |
| 483 * dict : Pointer to the dictionnary where the object is created | |
| 484 * type : What kind of object must be created | |
| 485 * data : pointer to the data for the object. | |
| 486 * type parameter is used to determine the type of data (see bellow for detail). | |
| 487 * parent : a reference to a parent object, if needed. | |
| 488 * ref : upon successful creation, reference to new object is stored here if !null. | |
| 489 * | |
| 490 * DESCRIPTION: | |
| 491 * Create a new object in the dictionary. | |
| 492 * See following object sections in this header file for more information on data and parent parameters format. | |
| 493 * | |
| 494 * RETURN VALUE: | |
| 495 * 0 : The object is created in the dictionary. | |
| 496 * EINVAL : A parameter is invalid. | |
| 497 * EEXIST : This object is already defined in the dictionary (with conflicting data). | |
| 498 * If "ref" is not NULL, it points to the existing element on return. | |
| 499 * (other standard errors may be returned, too, with their standard meaning. Example: | |
| 500 * ENOMEM : Memory allocation for the new object element failed.) | |
| 501 */ | |
| 502 int fd_dict_new ( struct dictionary * dict, enum dict_object_type type, void * data, struct dict_object * parent, struct dict_object **ref ); | |
| 503 | |
| 504 /* | |
| 505 * FUNCTION: fd_dict_search | |
| 506 * | |
| 507 * PARAMETERS: | |
| 508 * dict : Pointer to the dictionnary where the object is searched | |
| 509 * type : type of object that is being searched | |
| 510 * criteria : how the object must be searched. See object-related sections bellow for more information. | |
| 511 * what : depending on criteria, the data that must be searched. | |
| 512 * result : On successful return, pointer to the object is stored here. | |
| 513 * retval : this value is returned if the object is not found and result is not NULL. | |
| 514 * | |
| 515 * DESCRIPTION: | |
| 516 * Perform a search in the dictionary. | |
| 517 * See the object-specific sections bellow to find how to look for each objects. | |
| 518 * If the "result" parameter is NULL, the function is used to check if an object is in the dictionary. | |
| 519 * Otherwise, a reference to the object is stored in result if found. | |
| 520 * If result is not NULL and the object is not found, retval is returned (should be 0 or ENOENT usually) | |
| 521 * | |
| 522 * RETURN VALUE: | |
| 523 * 0 : The object has been found in the dictionary, or *result is NULL. | |
| 524 * EINVAL : A parameter is invalid. | |
| 525 * ENOENT : No matching object has been found, and result was NULL. | |
| 526 */ | |
| 527 int fd_dict_search ( struct dictionary * dict, enum dict_object_type type, int criteria, void * what, struct dict_object **result, int retval ); | |
| 528 | |
| 529 /* Special case: get the generic error command object */ | |
| 530 int fd_dict_get_error_cmd(struct dictionary * dict, struct dict_object **obj); | |
| 531 | |
| 532 /* | |
| 533 * FUNCTION: fd_dict_getval | |
| 534 * | |
| 535 * PARAMETERS: | |
| 536 * object : Pointer to a dictionary object. | |
| 537 * data : pointer to a structure to hold the data for the object. | |
| 538 * The type is the same as "data" parameter in fd_dict_new function. | |
| 539 * | |
| 540 * DESCRIPTION: | |
| 541 * Retrieve content of a dictionary object. | |
| 542 * See following object sections in this header file for more information on data and parent parameters format. | |
| 543 * | |
| 544 * RETURN VALUE: | |
| 545 * 0 : The content of the object has been retrieved. | |
| 546 * EINVAL : A parameter is invalid. | |
| 547 */ | |
| 548 int fd_dict_getval ( struct dict_object * object, void * val); | |
| 549 int fd_dict_gettype ( struct dict_object * object, enum dict_object_type * type); | |
| 550 int fd_dict_getdict ( struct dict_object * object, struct dictionary ** dict); | |
| 551 | |
| 552 /* Debug functions */ | |
| 553 void fd_dict_dump_object(struct dict_object * obj); | |
| 554 void fd_dict_dump(struct dictionary * dict); | |
| 555 | |
| 556 | |
| 557 /* | |
| 558 *************************************************************************** | |
| 559 * | |
| 560 * Vendor object | |
| 561 * | |
| 562 * These types are used to manage vendors in the dictionary | |
| 563 * | |
| 564 *************************************************************************** | |
| 565 */ | |
| 566 | |
| 567 /* Type to hold a Vendor ID: "SMI Network Management Private Enterprise Codes" (RFC3232) */ | |
| 568 typedef uint32_t vendor_id_t; | |
| 569 | |
| 570 /* Type to hold data associated to a vendor */ | |
| 571 struct dict_vendor_data { | |
| 572 vendor_id_t vendor_id; /* ID of a vendor */ | |
| 573 char *vendor_name; /* The name of this vendor */ | |
| 574 }; | |
| 575 | |
| 576 /* The criteria for searching a vendor object in the dictionary */ | |
| 577 enum { | |
| 578 VENDOR_BY_ID = 10, /* "what" points to a vendor_id_t */ | |
| 579 VENDOR_BY_NAME, /* "what" points to a string */ | |
| 580 VENDOR_OF_APPLICATION /* "what" points to a struct dict_object containing an application (see bellow) */ | |
| 581 }; | |
| 582 | |
| 583 /*** | |
| 584 * API usage : | |
| 585 | |
| 586 Note: the value of "vendor_name" is copied when the object is created, and the string may be disposed afterwards. | |
| 587 On the other side, when value is retrieved with dict_getval, the string is not copied and MUST NOT be freed. It will | |
| 588 be freed automatically along with the object itself with call to dict_fini later. | |
| 589 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
590 - fd_dict_new: |
| 0 | 591 The "parent" parameter is not used for vendors. |
| 592 Sample code to create a vendor: | |
| 593 { | |
| 594 int ret; | |
| 595 struct dict_object * myvendor; | |
| 596 struct dict_vendor_data myvendordata = { 23455, "my vendor name" }; -- just an example... | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
597 ret = fd_dict_new ( dict, DICT_VENDOR, &myvendordata, NULL, &myvendor ); |
| 0 | 598 } |
| 599 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
600 - fd_dict_search: |
| 0 | 601 Sample codes to look for a vendor object, by its id or name: |
| 602 { | |
| 603 int ret; | |
| 604 struct dict_object * vendor_found; | |
| 605 vendor_id_t vendorid = 23455; | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
606 ret = fd_dict_search ( dict, DICT_VENDOR, VENDOR_BY_ID, &vendorid, &vendor_found, ENOENT); |
| 0 | 607 - or - |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
608 ret = fd_dict_search ( dict, DICT_VENDOR, VENDOR_BY_NAME, "my vendor name", &vendor_found, ENOENT); |
| 0 | 609 } |
| 610 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
611 - fd_dict_getval: |
| 0 | 612 Sample code to retrieve the data from a vendor object: |
| 613 { | |
| 614 int ret; | |
| 615 struct dict_object * myvendor; | |
| 616 struct dict_vendor_data myvendordata; | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
617 ret = fd_dict_search ( dict, DICT_VENDOR, VENDOR_BY_NAME, "my vendor name", &myvendor, ENOENT); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
618 ret = fd_dict_getval ( myvendor, &myvendordata ); |
| 0 | 619 printf("my vendor id: %d\n", myvendordata.vendor_id ); |
| 620 } | |
| 621 | |
| 622 | |
| 623 */ | |
| 624 | |
| 625 /* | |
| 626 *************************************************************************** | |
| 627 * | |
| 628 * Application object | |
| 629 * | |
| 630 * These types are used to manage Diameter applications in the dictionary | |
| 631 * | |
| 632 *************************************************************************** | |
| 633 */ | |
| 634 | |
| 635 /* Type to hold a Diameter application ID: IANA assigned value for this application. */ | |
| 636 typedef uint32_t application_id_t; | |
| 637 | |
| 638 /* Type to hold data associated to an application */ | |
| 639 struct dict_application_data { | |
| 640 application_id_t application_id; /* ID of the application */ | |
| 641 char *application_name; /* The name of this application */ | |
| 642 }; | |
| 643 | |
| 644 /* The criteria for searching an application object in the dictionary */ | |
| 645 enum { | |
| 646 APPLICATION_BY_ID = 20, /* "what" points to a application_id_t */ | |
| 647 APPLICATION_BY_NAME, /* "what" points to a string */ | |
| 648 APPLICATION_OF_TYPE, /* "what" points to a struct dict_object containing a type object (see bellow) */ | |
| 649 APPLICATION_OF_COMMAND /* "what" points to a struct dict_object containing a command (see bellow) */ | |
| 650 }; | |
| 651 | |
| 652 /*** | |
| 653 * API usage : | |
| 654 | |
| 655 The "parent" parameter of dict_new may point to a vendor object to inform of what vendor defines the application. | |
| 656 for standard-track applications, the "parent" parameter should be NULL. | |
| 657 The vendor associated to an application is retrieved with VENDOR_OF_APPLICATION search criteria on vendors. | |
| 658 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
659 - fd_dict_new: |
| 0 | 660 Sample code for application creation: |
| 661 { | |
| 662 int ret; | |
| 663 struct dict_object * vendor; | |
| 664 struct dict_object * appl; | |
| 665 struct dict_vendor_data vendor_data = { | |
| 666 23455, | |
| 667 "my vendor name" | |
| 668 }; | |
| 669 struct dict_application_data app_data = { | |
| 670 9789, | |
| 671 "my vendor's application" | |
| 672 }; | |
| 673 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
674 ret = fd_dict_new ( dict, DICT_VENDOR, &vendor_data, NULL, &vendor ); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
675 ret = fd_dict_new ( dict, DICT_APPLICATION, &app_data, vendor, &appl ); |
| 0 | 676 } |
| 677 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
678 - fd_dict_search: |
| 0 | 679 Sample code to retrieve the vendor of an application |
| 680 { | |
| 681 int ret; | |
| 682 struct dict_object * vendor, * appli; | |
| 683 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
684 ret = fd_dict_search ( dict, DICT_APPLICATION, APPLICATION_BY_NAME, "my vendor's application", &appli, ENOENT); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
685 ret = fd_dict_search ( dict, DICT_VENDOR, VENDOR_OF_APPLICATION, appli, &vendor, ENOENT); |
| 0 | 686 } |
| 687 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
688 - fd_dict_getval: |
| 0 | 689 Sample code to retrieve the data from an application object: |
| 690 { | |
| 691 int ret; | |
| 692 struct dict_object * appli; | |
| 693 struct dict_application_data appl_data; | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
694 ret = fd_dict_search ( dict, DICT_APPLICATION, APPLICATION_BY_NAME, "my vendor's application", &appli, ENOENT); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
695 ret = fd_dict_getval ( appli, &appl_data ); |
| 0 | 696 printf("my application id: %s\n", appl_data.application_id ); |
| 697 } | |
| 698 | |
| 699 */ | |
| 700 | |
| 701 /* | |
| 702 *************************************************************************** | |
| 703 * | |
| 704 * Type object | |
| 705 * | |
| 706 * These types are used to manage AVP data types in the dictionary | |
| 707 * | |
| 708 *************************************************************************** | |
| 709 */ | |
| 710 | |
| 711 /* Type to store any AVP value */ | |
| 712 union avp_value { | |
| 713 struct { | |
| 714 uint8_t *data; /* bytes buffer */ | |
| 715 size_t len; /* length of the data buffer */ | |
| 716 } os; /* Storage for an octet string, data is alloc'd and must be freed */ | |
| 717 int32_t i32; /* integer 32 */ | |
| 718 int64_t i64; /* integer 64 */ | |
| 719 uint32_t u32; /* unsigned 32 */ | |
| 720 uint64_t u64; /* unsigned 64 */ | |
| 721 float f32; /* float 32 */ | |
| 722 double f64; /* float 64 */ | |
| 723 }; | |
| 724 | |
| 725 /* These are the basic AVP types defined in RFC3588bis */ | |
| 726 enum dict_avp_basetype { | |
| 727 AVP_TYPE_GROUPED, | |
| 728 AVP_TYPE_OCTETSTRING, | |
| 729 AVP_TYPE_INTEGER32, | |
| 730 AVP_TYPE_INTEGER64, | |
| 731 AVP_TYPE_UNSIGNED32, | |
| 732 AVP_TYPE_UNSIGNED64, | |
| 733 AVP_TYPE_FLOAT32, | |
| 734 AVP_TYPE_FLOAT64 | |
| 735 #define AVP_TYPE_MAX AVP_TYPE_FLOAT64 | |
| 736 }; | |
| 737 | |
| 738 /* Callbacks that can be associated with a derived type to easily interpret the AVP value. */ | |
| 739 /* | |
| 740 * CALLBACK: dict_avpdata_interpret | |
| 741 * | |
| 742 * PARAMETERS: | |
| 743 * val : Pointer to the AVP value that must be interpreted. | |
| 744 * interpreted : The result of interpretation is stored here. The format and meaning depends on each type. | |
| 745 * | |
| 746 * DESCRIPTION: | |
| 747 * This callback can be provided with a derived type in order to facilitate the interpretation of formated data. | |
| 748 * For example, when an AVP of type "Address" is received, it can be used to convert the octetstring into a struct sockaddr. | |
| 749 * This callback is not called directly, but through the message's API msg_avp_value_interpret function. | |
| 750 * | |
| 751 * RETURN VALUE: | |
| 752 * 0 : Operation complete. | |
| 753 * !0 : An error occurred, the error code is returned. | |
| 754 */ | |
| 755 typedef int (*dict_avpdata_interpret) (union avp_value * value, void * interpreted); | |
| 756 /* | |
| 757 * CALLBACK: dict_avpdata_encode | |
| 758 * | |
| 759 * PARAMETERS: | |
| 760 * data : The formated data that must be stored in the AVP value. | |
| 761 * val : Pointer to the AVP value storage area where the data must be stored. | |
| 762 * | |
| 763 * DESCRIPTION: | |
| 764 * This callback can be provided with a derived type in order to facilitate the encoding of formated data. | |
| 765 * For example, it can be used to convert a struct sockaddr in an AVP value of type Address. | |
| 766 * This callback is not called directly, but through the message's API msg_avp_value_encode function. | |
| 767 * If the callback is defined for an OctetString based type, the created string must be malloc'd. free will be called | |
| 768 * automatically later. | |
| 769 * | |
| 770 * RETURN VALUE: | |
| 771 * 0 : Operation complete. | |
| 772 * !0 : An error occurred, the error code is returned. | |
| 773 */ | |
| 774 typedef int (*dict_avpdata_encode) (void * data, union avp_value * val); | |
| 775 | |
| 776 | |
| 777 /* Type to hold data associated to a derived AVP data type */ | |
| 778 struct dict_type_data { | |
| 779 enum dict_avp_basetype type_base; /* How the data of such AVP must be interpreted */ | |
| 780 char *type_name; /* The name of this type */ | |
| 781 dict_avpdata_interpret type_interpret;/* cb to convert the AVP value in more comprehensive format (or NULL) */ | |
| 782 dict_avpdata_encode type_encode; /* cb to convert formatted data into an AVP value (or NULL) */ | |
| 783 }; | |
| 784 | |
| 785 /* The criteria for searching a type object in the dictionary */ | |
| 786 enum { | |
| 787 TYPE_BY_NAME = 30, /* "what" points to a string */ | |
| 788 TYPE_OF_ENUMVAL, /* "what" points to a struct dict_object containing an enumerated constant (DICT_ENUMVAL, see bellow). */ | |
| 789 TYPE_OF_AVP /* "what" points to a struct dict_object containing an AVP object. */ | |
| 790 }; | |
| 791 | |
| 792 | |
| 793 /*** | |
| 794 * API usage : | |
| 795 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
796 - fd_dict_new: |
| 0 | 797 The "parent" parameter may point to an application object, when a type is defined by a Diameter application. |
| 798 | |
| 799 Sample code: | |
| 800 { | |
| 801 int ret; | |
| 802 struct dict_object * mytype; | |
| 803 struct dict_type_data mytypedata = | |
| 804 { | |
| 805 AVP_TYPE_OCTETSTRING, | |
| 806 "Address", | |
| 807 NULL, | |
| 808 NULL | |
| 809 }; | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
810 ret = fd_dict_new ( dict, DICT_TYPE, &mytypedata, NULL, &mytype ); |
| 0 | 811 } |
| 812 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
813 - fd_dict_search: |
| 0 | 814 Sample code: |
| 815 { | |
| 816 int ret; | |
| 817 struct dict_object * address_type; | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
818 ret = fd_dict_search ( dict, DICT_TYPE, TYPE_BY_NAME, "Address", &address_type, ENOENT); |
| 0 | 819 } |
| 820 | |
| 821 */ | |
| 822 | |
| 823 /* | |
| 824 *************************************************************************** | |
| 825 * | |
| 826 * Enumerated values object | |
| 827 * | |
| 828 * These types are used to manage named constants of some AVP, | |
| 829 * for enumerated types. Waaad allows contants for types others than Unsigned32 | |
| 830 * | |
| 831 *************************************************************************** | |
| 832 */ | |
| 833 | |
| 834 /* Type to hold data of named constants for AVP */ | |
| 835 struct dict_enumval_data { | |
| 836 char *enum_name; /* The name of this constant */ | |
| 837 union avp_value enum_value; /* Value of the constant. Union term depends on parent type's base type. */ | |
| 838 }; | |
| 839 | |
| 840 /* The criteria for searching a constant in the dictionary */ | |
| 841 enum { | |
| 842 ENUMVAL_BY_STRUCT = 40, /* "what" points to a struct dict_enumval_request as defined bellow */ | |
| 843 }; | |
| 844 | |
| 845 struct dict_enumval_request { | |
| 846 /* Identifier of the parent type, one of the following must not be NULL */ | |
| 847 struct dict_object *type_obj; | |
| 848 char *type_name; | |
| 849 | |
| 850 /* Search criteria for the constant */ | |
| 851 struct dict_enumval_data search; /* search.enum_value is used only if search.enum_name == NULL */ | |
| 852 }; | |
| 853 | |
| 854 /*** | |
| 855 * API usage : | |
| 856 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
857 - fd_dict_new: |
| 0 | 858 The "parent" parameter must point to a derived type object. |
| 859 Sample code to create a type "Boolean" with two constants "True" and "False": | |
| 860 { | |
| 861 int ret; | |
| 862 struct dict_object * type_boolean; | |
| 863 struct dict_type_data type_boolean_data = | |
| 864 { | |
| 865 AVP_TYPE_INTEGER32, | |
| 866 "Boolean", | |
| 867 NULL, | |
| 868 NULL | |
| 869 }; | |
| 870 struct dict_enumval_data boolean_false = | |
| 871 { | |
| 872 .enum_name="False", | |
| 873 .enum_value.i32 = 0 | |
| 874 }; | |
| 875 struct dict_enumval_data boolean_true = | |
| 876 { | |
| 877 .enum_name="True", | |
| 878 .enum_value.i32 = -1 | |
| 879 }; | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
880 ret = fd_dict_new ( dict, DICT_TYPE, &type_boolean_data, NULL, &type_boolean ); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
881 ret = fd_dict_new ( dict, DICT_ENUMVAL, &boolean_false, type_boolean, NULL ); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
882 ret = fd_dict_new ( dict, DICT_ENUMVAL, &boolean_true , type_boolean, NULL ); |
| 0 | 883 |
| 884 } | |
| 885 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
886 - fd_dict_search: |
| 0 | 887 Sample code to look for a constant name, by its value: |
| 888 { | |
| 889 int ret; | |
| 890 struct dict_object * value_found; | |
| 891 struct dict_enumval_request boolean_by_value = | |
| 892 { | |
| 893 .type_name = "Boolean", | |
| 894 .search.enum_name=NULL, | |
| 895 .search.enum_value.i32 = -1 | |
| 896 }; | |
| 897 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
898 ret = fd_dict_search ( dict, DICT_ENUMVAL, ENUMVAL_BY_STRUCT, &boolean_by_value, &value_found, ENOENT); |
| 0 | 899 } |
| 900 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
901 - fd_dict_getval: |
| 0 | 902 Sample code to retrieve the data from a constant object: |
| 903 { | |
| 904 int ret; | |
| 905 struct dict_object * value_found; | |
| 906 struct dict_enumval_data boolean_data = NULL; | |
| 907 struct dict_enumval_request boolean_by_value = | |
| 908 { | |
| 909 .type_name = "Boolean", | |
| 910 .search.enum_name=NULL, | |
| 911 .search.enum_value.i32 = 0 | |
| 912 }; | |
| 913 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
914 ret = fd_dict_search ( dict, DICT_ENUMVAL, ENUMVAL_BY_STRUCT, &boolean_by_value, &value_found, ENOENT); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
915 ret = fd_dict_getval ( value_found, &boolean_data ); |
| 0 | 916 printf(" Boolean with value 0: %s", boolean_data.enum_name ); |
| 917 } | |
| 918 */ | |
| 919 | |
| 920 /* | |
| 921 *************************************************************************** | |
| 922 * | |
| 923 * AVP object | |
| 924 * | |
| 925 * These objects are used to manage AVP definitions in the dictionary | |
| 926 * | |
| 927 *************************************************************************** | |
| 928 */ | |
| 929 | |
| 930 /* Type to hold an AVP code. For vendor 0, these codes are assigned by IANA. Otherwise, it is managed by the vendor */ | |
| 931 typedef uint32_t avp_code_t; | |
| 932 | |
| 933 /* Values of AVP flags */ | |
| 934 #define AVP_FLAG_VENDOR 0x80 | |
| 935 #define AVP_FLAG_MANDATORY 0x40 | |
| 936 #define AVP_FLAG_RESERVED3 0x20 | |
| 937 #define AVP_FLAG_RESERVED4 0x10 | |
| 938 #define AVP_FLAG_RESERVED5 0x08 | |
| 939 #define AVP_FLAG_RESERVED6 0x04 | |
| 940 #define AVP_FLAG_RESERVED7 0x02 | |
| 941 #define AVP_FLAG_RESERVED8 0x01 | |
| 942 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
943 /* For dumping flags and values */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
944 #define DUMP_AVPFL_str "%c%c" |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
945 #define DUMP_AVPFL_val(_val) (_val & AVP_FLAG_VENDOR)?'V':'-' , (_val & AVP_FLAG_MANDATORY)?'M':'-' |
| 0 | 946 |
| 947 /* Type to hold data associated to an avp */ | |
| 948 struct dict_avp_data { | |
| 949 avp_code_t avp_code; /* Code of the avp */ | |
| 950 vendor_id_t avp_vendor; /* Vendor of the AVP, or 0 */ | |
| 951 char *avp_name; /* Name of this AVP */ | |
| 952 uint8_t avp_flag_mask; /* Mask of fixed AVP flags */ | |
| 953 uint8_t avp_flag_val; /* Values of the fixed flags */ | |
| 954 enum dict_avp_basetype avp_basetype; /* Basic type of data found in the AVP */ | |
| 955 }; | |
| 956 | |
| 957 /* The criteria for searching an avp object in the dictionary */ | |
| 958 enum { | |
| 959 AVP_BY_CODE = 50, /* "what" points to an avp_code_t, vendor is always 0 */ | |
| 960 AVP_BY_NAME, /* "what" points to a string, vendor is always 0 */ | |
| 961 AVP_BY_CODE_AND_VENDOR, /* "what" points to a struct dict_avp_request (see bellow), where avp_vendor and avp_code are set */ | |
| 962 AVP_BY_NAME_AND_VENDOR /* "what" points to a struct dict_avp_request (see bellow), where avp_vendor and avp_name are set */ | |
| 963 }; | |
| 964 | |
| 965 /* Struct used for some researchs */ | |
| 966 struct dict_avp_request { | |
| 967 vendor_id_t avp_vendor; | |
| 968 avp_code_t avp_code; | |
| 969 char *avp_name; | |
| 970 }; | |
| 971 | |
| 972 | |
| 973 /*** | |
| 974 * API usage : | |
| 975 | |
| 976 If "parent" parameter is not NULL during AVP creation, it must point to a DICT_TYPE object. | |
| 977 The extended type is then attached to the AVP. In case where it is an enumerated type, the value of | |
| 978 AVP is automatically interpreted in debug messages, and in message checks. | |
| 979 The derived type of an AVP can be retrieved with: dict_search ( DICT_TYPE, TYPE_OF_AVP, avp, ... ) | |
| 980 | |
| 981 To create the rules (ABNF) for children of Grouped AVP, see the DICT_RULE related part. | |
| 982 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
983 - fd_dict_new: |
| 0 | 984 Sample code for AVP creation: |
| 985 { | |
| 986 int ret; | |
| 987 struct dict_object * user_name_avp; | |
| 988 struct dict_object * boolean_type; | |
| 989 struct dict_object * sample_boolean_avp; | |
| 990 struct dict_avp_data user_name_data = { | |
| 991 1, // code | |
| 992 0, // vendor | |
| 993 "User-Name", // name | |
| 994 AVP_FLAG_VENDOR | AVP_FLAG_MANDATORY, // fixed mask: V and M values must always be defined as follow. other flags can be set or cleared | |
| 995 AVP_FLAG_MANDATORY, // the V flag must be cleared, the M flag must be set. | |
| 996 AVP_TYPE_OCTETSTRING // User-Name AVP contains OctetString data (further precision such as UTF8String can be given with a parent derived type) | |
| 997 }; | |
| 998 struct dict_avp_data sample_boolean_data = { | |
| 999 31337, | |
| 1000 23455, | |
| 1001 "Sample-Boolean", | |
| 1002 AVP_FLAG_VENDOR | AVP_FLAG_MANDATORY, | |
| 1003 AVP_FLAG_VENDOR, | |
| 1004 AVP_TYPE_INTEGER32 // This MUST be the same as parent type's | |
| 1005 }; | |
| 1006 | |
| 1007 -- Create an AVP with a base type -- | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1008 ret = fd_dict_new ( dict, DICT_AVP, &user_name_data, NULL, &user_name_avp ); |
| 0 | 1009 |
| 1010 -- Create an AVP with a derived type -- | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1011 ret = fd_dict_search ( dict, DICT_TYPE, TYPE_BY_NAME, "Boolean", &boolean_type, ENOENT); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1012 ret = fd_dict_new ( dict, DICT_AVP, &sample_boolean_data , boolean_type, &sample_boolean_avp ); |
| 0 | 1013 |
| 1014 } | |
| 1015 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1016 - fd_dict_search: |
| 0 | 1017 Sample code to look for an AVP |
| 1018 { | |
| 1019 int ret; | |
| 1020 struct dict_object * avp_username; | |
| 1021 struct dict_object * avp_sampleboolean; | |
| 1022 struct dict_avp_request avpvendorboolean = | |
| 1023 { | |
| 1024 .avp_vendor = 23455, | |
| 1025 .avp_name = "Sample-Boolean" | |
| 1026 }; | |
| 1027 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1028 ret = fd_dict_search ( dict, DICT_AVP, AVP_BY_NAME, "User-Name", &avp_username, ENOENT); |
| 0 | 1029 |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1030 ret = fd_dict_search ( dict, DICT_AVP, AVP_BY_NAME_AND_VENDOR, &avpvendorboolean, &avp_sampleboolean, ENOENT); |
| 0 | 1031 |
| 1032 } | |
| 1033 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1034 - fd_dict_getval: |
| 0 | 1035 Sample code to retrieve the data from an AVP object: |
| 1036 { | |
| 1037 int ret; | |
| 1038 struct dict_object * avp_username; | |
| 1039 struct dict_avp_data user_name_data; | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1040 ret = fd_dict_search ( dict, DICT_AVP, AVP_BY_NAME, "User-Name", &avp_username, ENOENT); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1041 ret = fd_dict_getval ( avp_username, &user_name_data ); |
| 0 | 1042 printf("User-Name code: %d\n", user_name_data.avp_code ); |
| 1043 } | |
| 1044 | |
| 1045 */ | |
| 1046 | |
| 1047 /* | |
| 1048 *************************************************************************** | |
| 1049 * | |
| 1050 * Command object | |
| 1051 * | |
| 1052 * These types are used to manage commands objects in the dictionary | |
| 1053 * | |
| 1054 *************************************************************************** | |
| 1055 */ | |
| 1056 | |
| 1057 /* Type to hold a Diameter command code: IANA assigned values. 0x0-0x7fffff=standard, 0x800000-0xfffffd=vendors, 0xfffffe-0xffffff=experimental */ | |
| 1058 typedef uint32_t command_code_t; | |
| 1059 | |
| 1060 /* Values of command flags */ | |
| 1061 #define CMD_FLAG_REQUEST 0x80 | |
| 1062 #define CMD_FLAG_PROXIABLE 0x40 | |
| 1063 #define CMD_FLAG_ERROR 0x20 | |
| 1064 #define CMD_FLAG_RETRANSMIT 0x10 | |
| 1065 #define CMD_FLAG_RESERVED5 0x08 | |
| 1066 #define CMD_FLAG_RESERVED6 0x04 | |
| 1067 #define CMD_FLAG_RESERVED7 0x02 | |
| 1068 #define CMD_FLAG_RESERVED8 0x01 | |
| 1069 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1070 /* For dumping flags and values */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1071 #define DUMP_CMDFL_str "%c%c%c%c" |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1072 #define DUMP_CMDFL_val(_val) (_val & CMD_FLAG_REQUEST)?'R':'-' , (_val & CMD_FLAG_PROXIABLE)?'P':'-' , (_val & CMD_FLAG_ERROR)?'E':'-' , (_val & CMD_FLAG_RETRANSMIT)?'T':'-' |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1073 |
| 0 | 1074 /* Type to hold data associated to a command */ |
| 1075 struct dict_cmd_data { | |
| 1076 command_code_t cmd_code; /* code of the command */ | |
| 1077 char *cmd_name; /* Name of the command */ | |
| 1078 uint8_t cmd_flag_mask; /* Mask of fixed-value flags */ | |
| 1079 uint8_t cmd_flag_val; /* values of the fixed flags */ | |
| 1080 }; | |
| 1081 | |
| 1082 /* The criteria for searching an avp object in the dictionary */ | |
| 1083 enum { | |
| 1084 CMD_BY_NAME = 60, /* "what" points to a string */ | |
| 1085 CMD_BY_CODE_R, /* "what" points to a command_code_t. The "Request" command is returned. */ | |
| 1086 CMD_BY_CODE_A, /* "what" points to a command_code_t. The "Answer" command is returned. */ | |
| 1087 CMD_ANSWER /* "what" points to a struct dict_object of a request command. The corresponding "Answer" command is returned. */ | |
| 1088 }; | |
| 1089 | |
| 1090 | |
| 1091 /*** | |
| 1092 * API usage : | |
| 1093 | |
| 1094 The "parent" parameter of dict_new may point to an application object to inform of what application defines the command. | |
| 1095 The application associated to a command is retrieved with APPLICATION_OF_COMMAND search criteria on applications. | |
| 1096 | |
| 1097 To create the rules for children of commands, see the DICT_RULE related part. | |
| 1098 | |
| 1099 Note that the "Request" and "Answer" commands are two independant objects. This allows to have different rules for each. | |
| 1100 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1101 - fd_dict_new: |
| 0 | 1102 Sample code for command creation: |
| 1103 { | |
| 1104 int ret; | |
| 1105 struct dict_object * cer; | |
| 1106 struct dict_object * cea; | |
| 1107 struct dict_cmd_data ce_data = { | |
| 1108 257, // code | |
| 1109 "Capabilities-Exchange-Request", // name | |
| 1110 CMD_FLAG_REQUEST, // mask | |
| 1111 CMD_FLAG_REQUEST // value. Only the "R" flag is constrained here, set. | |
| 1112 }; | |
| 1113 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1114 ret = fd_dict_new (dict, DICT_COMMAND, &ce_data, NULL, &cer ); |
| 0 | 1115 |
| 1116 ce_data.cmd_name = "Capabilities-Exchange-Answer"; | |
| 1117 ce_data.cmd_flag_val = 0; // Same constraint on "R" flag, but this time it must be cleared. | |
| 1118 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1119 ret = fd_dict_new ( dict, DICT_COMMAND, &ce_data, NULL, &cea ); |
| 0 | 1120 } |
| 1121 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1122 - fd_dict_search: |
| 0 | 1123 Sample code to look for a command |
| 1124 { | |
| 1125 int ret; | |
| 1126 struct dict_object * cer, * cea; | |
| 1127 command_code_t code = 257; | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1128 ret = fd_dict_search ( dict, DICT_COMMAND, CMD_BY_NAME, "Capabilities-Exchange-Request", &cer, ENOENT); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1129 ret = fd_dict_search ( dict, DICT_COMMAND, CMD_BY_CODE_R, &code, &cer, ENOENT); |
| 0 | 1130 } |
| 1131 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1132 - fd_dict_getval: |
| 0 | 1133 Sample code to retrieve the data from a command object: |
| 1134 { | |
| 1135 int ret; | |
| 1136 struct dict_object * cer; | |
| 1137 struct dict_object * cea; | |
| 1138 struct dict_cmd_data cea_data; | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1139 ret = fd_dict_search ( dict, DICT_COMMAND, CMD_BY_NAME, "Capabilities-Exchange-Request", &cer, ENOENT); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1140 ret = fd_dict_search ( dict, DICT_COMMAND, CMD_ANSWER, cer, &cea, ENOENT); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1141 ret = fd_dict_getval ( cea, &cea_data ); |
| 0 | 1142 printf("Answer to CER: %s\n", cea_data.cmd_name ); |
| 1143 } | |
| 1144 | |
| 1145 */ | |
| 1146 | |
| 1147 /* | |
| 1148 *************************************************************************** | |
| 1149 * | |
| 1150 * Rule object | |
| 1151 * | |
| 1152 * These objects are used to manage rules in the dictionary (ABNF implementation) | |
| 1153 * This is used for checking messages validity (more powerful than a DTD) | |
| 1154 * | |
| 1155 *************************************************************************** | |
| 1156 */ | |
| 1157 | |
| 1158 /* This defines the kind of rule that is defined */ | |
| 1159 enum rule_position { | |
| 1160 RULE_FIXED_HEAD = 1, /* The AVP must be at the head of the group. The rule_order field is used to specify the position. */ | |
| 1161 RULE_REQUIRED, /* The AVP must be present in the parent, but its position is not defined. */ | |
| 1162 RULE_OPTIONAL, /* The AVP may be present in the message. Used to specify a max number of occurences for example */ | |
| 1163 RULE_FIXED_TAIL /* The AVP must be at the end of the group. The rule_order field is used to specify the position. */ | |
| 1164 }; | |
| 1165 | |
| 1166 /* Content of a RULE object data */ | |
| 1167 struct dict_rule_data { | |
| 1168 struct dict_object *rule_avp; /* Pointer to the AVP object that is concerned by this rule */ | |
| 1169 enum rule_position rule_position; /* The position in which the rule_avp must appear in the parent */ | |
| 1170 unsigned rule_order; /* for RULE_FIXED_* rules, the place. 1,2,3.. for HEAD rules; ...,3,2,1 for TAIL rules. */ | |
| 1171 int rule_min; /* Minimum number of occurences. -1 means "default": 0 for optional rules, 1 for other rules */ | |
| 1172 int rule_max; /* Maximum number of occurences. -1 means no maximum. 0 means the AVP is forbidden. */ | |
| 1173 }; | |
| 1174 | |
| 1175 /* The criteria for searching a rule in the dictionary */ | |
| 1176 enum { | |
| 1177 RULE_BY_AVP_AND_PARENT = 70 /* "what" points to a struct dict_rule_request -- see bellow. This is used to query "what is the rule for this AVP in this group?" */ | |
| 1178 }; | |
| 1179 | |
| 1180 /* Structure for querying the dictionary about a rule */ | |
| 1181 struct dict_rule_request { | |
| 1182 struct dict_object *rule_parent; /* The grouped avp or command to which the rule apply */ | |
| 1183 struct dict_object *rule_avp; /* The AVP concerned by this rule */ | |
| 1184 }; | |
| 1185 | |
| 1186 | |
| 1187 /*** | |
| 1188 * API usage : | |
| 1189 | |
| 1190 The "parent" parameter can not be NULL. It points to the object (grouped avp or command) to which this rule apply (i.e. for which the ABNF is defined). | |
| 1191 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1192 - fd_dict_new: |
| 0 | 1193 Sample code for rule creation. Let's create the Proxy-Info grouped AVP for example. |
| 1194 { | |
| 1195 int ret; | |
| 1196 struct dict_object * proxy_info_avp; | |
| 1197 struct dict_object * proxy_host_avp; | |
| 1198 struct dict_object * proxy_state_avp; | |
| 1199 struct dict_object * diameteridentity_type; | |
| 1200 struct dict_rule_data rule_data; | |
| 1201 struct dict_type_data di_type_data = { AVP_TYPE_OCTETSTRING, "DiameterIdentity", NULL, NULL }; | |
| 1202 struct dict_avp_data proxy_info_data = { 284, 0, "Proxy-Info", AVP_FLAG_VENDOR | AVP_FLAG_MANDATORY, AVP_FLAG_MANDATORY, AVP_TYPE_GROUPED }; | |
| 1203 struct dict_avp_data proxy_host_data = { 280, 0, "Proxy-Host", AVP_FLAG_VENDOR | AVP_FLAG_MANDATORY, AVP_FLAG_MANDATORY, AVP_TYPE_OCTETSTRING }; | |
| 1204 struct dict_avp_data proxy_state_data = { 33, 0, "Proxy-State",AVP_FLAG_VENDOR | AVP_FLAG_MANDATORY, AVP_FLAG_MANDATORY, AVP_TYPE_OCTETSTRING }; | |
| 1205 | |
| 1206 -- Create the parent AVP | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1207 ret = fd_dict_new ( dict, DICT_AVP, &proxy_info_data, NULL, &proxy_info_avp ); |
| 0 | 1208 |
| 1209 -- Create the first child AVP. | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1210 ret = fd_dict_new ( dict, DICT_TYPE, &di_type_data, NULL, &diameteridentity_type ); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1211 ret = fd_dict_new ( dict, DICT_AVP, &proxy_host_data, diameteridentity_type, &proxy_host_avp ); |
| 0 | 1212 |
| 1213 -- Create the other child AVP | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1214 ret = fd_dict_new ( dict, DICT_AVP, &proxy_state_data, NULL, &proxy_state_avp ); |
| 0 | 1215 |
| 1216 -- Now we can create the rules. Both children AVP are mandatory. | |
| 1217 rule_data.rule_position = RULE_REQUIRED; | |
| 1218 rule_data.rule_min = -1; | |
| 1219 rule_data.rule_max = -1; | |
| 1220 | |
| 1221 rule_data.rule_avp = proxy_host_avp; | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1222 ret = fd_dict_new ( dict, DICT_RULE, &rule_data, proxy_info_avp, NULL ); |
| 0 | 1223 |
| 1224 rule_data.rule_avp = proxy_state_avp; | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1225 ret = fd_dict_new ( dict, DICT_RULE, &rule_data, proxy_info_avp, NULL ); |
| 0 | 1226 } |
| 1227 | |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1228 - fd_dict_search and fd_dict_getval are similar to previous examples. |
| 0 | 1229 |
| 1230 */ | |
| 1231 | |
| 1232 /* Define some hard-coded values */ | |
| 1233 /* Commands Codes */ | |
| 1234 #define CC_CAPABILITIES_EXCHANGE 257 | |
| 1235 #define CC_RE_AUTH 258 | |
| 1236 #define CC_ACCOUNTING 271 | |
| 1237 #define CC_ABORT_SESSION 274 | |
| 1238 #define CC_SESSION_TERMINATION 275 | |
| 1239 #define CC_DEVICE_WATCHDOG 280 | |
| 1240 #define CC_DISCONNECT_PEER 282 | |
| 1241 | |
| 1242 /* AVPs (Vendor 0) */ | |
| 1243 #define AC_PROXY_STATE 33 | |
| 1244 #define AC_HOST_IP_ADDRESS 257 | |
| 1245 #define AC_AUTH_APPLICATION_ID 258 | |
| 1246 #define AC_ACCT_APPLICATION_ID 259 | |
| 1247 #define AC_VENDOR_SPECIFIC_APPLICATION_ID 260 | |
| 1248 #define AC_REDIRECT_HOST_USAGE 261 | |
| 1249 #define AC_REDIRECT_MAX_CACHE_TIME 262 | |
| 1250 #define AC_SESSION_ID 263 | |
| 1251 #define AC_ORIGIN_HOST 264 | |
| 1252 #define AC_SUPPORTED_VENDOR_ID 265 | |
| 1253 #define AC_VENDOR_ID 266 | |
| 1254 #define AC_FIRMWARE_REVISION 267 | |
| 1255 #define AC_RESULT_CODE 268 | |
| 1256 #define AC_PRODUCT_NAME 269 | |
| 1257 #define AC_DISCONNECT_CAUSE 273 | |
| 1258 #define ACV_DC_REBOOTING 0 | |
| 1259 #define ACV_DC_BUSY 1 | |
| 1260 #define ACV_DC_NOT_FRIEND 2 | |
| 1261 #define AC_ORIGIN_STATE_ID 278 | |
| 1262 #define AC_FAILED_AVP 279 | |
| 1263 #define AC_PROXY_HOST 280 | |
| 1264 #define AC_ERROR_MESSAGE 281 | |
| 1265 #define AC_ROUTE_RECORD 282 | |
| 1266 #define AC_DESTINATION_REALM 283 | |
| 1267 #define AC_PROXY_INFO 284 | |
| 1268 #define AC_REDIRECT_HOST 292 | |
| 1269 #define AC_DESTINATION_HOST 293 | |
| 1270 #define AC_ERROR_REPORTING_HOST 294 | |
| 1271 #define AC_ORIGIN_REALM 296 | |
| 1272 #define AC_INBAND_SECURITY_ID 299 | |
| 1273 | |
| 1274 /* Error codes */ | |
| 1275 #define ER_DIAMETER_SUCCESS 2001 | |
| 1276 #define ER_DIAMETER_REALM_NOT_SERVED 3003 | |
| 1277 #define ER_DIAMETER_TOO_BUSY 3004 | |
| 1278 #define ER_DIAMETER_REDIRECT_INDICATION 3006 | |
| 1279 | |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1280 |
|
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1281 /*============================================================*/ |
|
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1282 /* SESSIONS */ |
|
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1283 /*============================================================*/ |
|
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1284 |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1285 /* Modules that want to associate a state with a Session-Id must first register a handler of this type */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1286 struct session_handler; |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1287 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1288 /* This opaque structure represents a session associated with a Session-Id */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1289 struct session; |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1290 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1291 /* The state information that a module associate with a session -- each module define its own data format */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1292 typedef void session_state; |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1293 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1294 /* |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1295 * FUNCTION: fd_sess_handler_create |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1296 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1297 * PARAMETERS: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1298 * handler : location where the new handler must be stored. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1299 * cleanup : a callback function that must be called when the session with associated data is destroyed. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1300 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1301 * DESCRIPTION: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1302 * Create a new session handler. This is needed by a module to associate a state with a session object. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1303 * The cleanup handler is called when the session timeout expires, or fd_sess_destroy is called. It must free |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1304 * the state associated with the session, and eventually trig other actions (send a STR, ...). |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1305 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1306 * RETURN VALUE: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1307 * 0 : The new handler has been created. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1308 * EINVAL : A parameter is invalid. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1309 * ENOMEM : Not enough memory to complete the operation |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1310 */ |
|
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1311 int fd_sess_handler_create_internal ( struct session_handler ** handler, void (*cleanup)(char * sid, session_state * state) ); |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1312 /* Macro to avoid casting everywhere */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1313 #define fd_sess_handler_create( _handler, _cleanup ) \ |
|
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1314 fd_sess_handler_create_internal( (_handler), (void (*)(char *, session_state *))(_cleanup) ) |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1315 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1316 /* |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1317 * FUNCTION: fd_sess_handler_destroy |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1318 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1319 * PARAMETERS: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1320 * handler : location of an handler created by fd_sess_handler_create. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1321 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1322 * DESCRIPTION: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1323 * This destroys a session handler (typically called when an application is shutting down). |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1324 * If sessions states are registered with this handler, the cleanup callback is called on them. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1325 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1326 * RETURN VALUE: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1327 * 0 : The handler was destroyed. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1328 * EINVAL : A parameter is invalid. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1329 * ENOMEM : Not enough memory to complete the operation |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1330 */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1331 int fd_sess_handler_destroy ( struct session_handler ** handler ); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1332 |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1333 |
|
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1334 |
|
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1335 /* |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1336 * FUNCTION: fd_sess_new |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1337 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1338 * PARAMETERS: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1339 * session : The location where the session object will be created upon success. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1340 * diamId : \0-terminated string containing a Diameter Identity. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1341 * opt : Additional string. Usage is described bellow. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1342 * optlen : if opt is \0-terminated, this can be 0. Otherwise, the length of opt. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1343 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1344 * DESCRIPTION: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1345 * Create a new session object. The Session-Id string associated with this session is generated as follow: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1346 * If diamId parameter is provided, the string is created according to the RFC: <diamId>;<high32>;<low32>[;opt] where |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1347 * diamId is a Diameter Identity. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1348 * high32 and low32 are the parts of a monotonic 64 bits counter initialized to (time, 0) at startup. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1349 * opt is an optional string that can be concatenated to the identifier. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1350 * If diamId is NULL, the string is exactly the content of opt. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1351 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1352 * RETURN VALUE: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1353 * 0 : The session is created. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1354 * EINVAL : A parameter is invalid. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1355 * EALREADY : A session with the same name already exists (returned in *session) |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1356 * ENOMEM : Not enough memory to complete the operation |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1357 */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1358 int fd_sess_new ( struct session ** session, char * diamId, char * opt, size_t optlen ); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1359 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1360 /* |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1361 * FUNCTION: fd_sess_fromsid |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1362 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1363 * PARAMETERS: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1364 * sid : pointer to a string containing a Session-Id (UTF-8). |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1365 * len : length of the sid string (which does not need to be '\0'-terminated) |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1366 * session : On success, pointer to the session object created / retrieved. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1367 * new : if not NULL, set to 1 on return if the session object has been created, 0 if it was simply retrieved. |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1368 * |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1369 * DESCRIPTION: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1370 * Retrieve a session object from a Session-Id string. Calling this function makes an implicit call to the |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1371 * fd_sess_link function on the returned session. In case no session object was previously existing with this |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1372 * id, a new object is silently created (equivalent to fd_sess_new with flag SESSION_NEW_FULL). |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1373 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1374 * RETURN VALUE: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1375 * 0 : The session parameter has been updated. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1376 * EINVAL : A parameter is invalid. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1377 * ENOMEM : Not enough memory to complete the operation |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1378 */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1379 int fd_sess_fromsid ( char * sid, size_t len, struct session ** session, int * new); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1380 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1381 /* |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1382 * FUNCTION: fd_sess_getsid |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1383 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1384 * PARAMETERS: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1385 * session : Pointer to a session object. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1386 * sid : On success, the location of a (\0-terminated) string is stored here. |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1387 * |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1388 * DESCRIPTION: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1389 * Retrieve the session identifier (Session-Id) corresponding to a session object. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1390 * The returned sid is an UTF-8 string terminated by \0, suitable for calls to strlen and strcpy. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1391 * It may be used for example to set the value of an AVP. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1392 * Note that the sid string is not copied, just its reference... do not free it! |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1393 * |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1394 * RETURN VALUE: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1395 * 0 : The sid parameter has been updated. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1396 * EINVAL : A parameter is invalid. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1397 */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1398 int fd_sess_getsid ( struct session * session, char ** sid ); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1399 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1400 /* |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1401 * FUNCTION: fd_sess_settimeout |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1402 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1403 * PARAMETERS: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1404 * session : The session for which to set the timeout. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1405 * timeout : The date when the session times out. |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1406 * |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1407 * DESCRIPTION: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1408 * Set the lifetime for a given session object. This function may be |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1409 * called several times on the same object to update the timeout value. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1410 * When the timeout date is reached, the cleanup handler of each |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1411 * module that registered data with this session is called, then the |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1412 * session is cleared. |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1413 * |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1414 * There is a possible race condition between cleanup of the session |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1415 * and use of its data; applications should ensure that they are not |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1416 * using data from a session that is about to expire / expired. |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1417 * |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1418 * RETURN VALUE: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1419 * 0 : The session timeout has been updated. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1420 * EINVAL : A parameter is invalid. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1421 */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1422 int fd_sess_settimeout( struct session * session, const struct timespec * timeout ); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1423 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1424 /* |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1425 * FUNCTION: fd_sess_destroy |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1426 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1427 * PARAMETERS: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1428 * session : Pointer to a session object. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1429 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1430 * DESCRIPTION: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1431 * Destroys a session an all associated data, if any. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1432 * Equivalent to a session timeout expired, but the effect is immediate. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1433 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1434 * RETURN VALUE: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1435 * 0 : The session no longer exists. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1436 * EINVAL : A parameter is invalid. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1437 */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1438 int fd_sess_destroy ( struct session ** session ); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1439 |
|
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1440 /* |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1441 * FUNCTION: fd_sess_reclaim |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1442 * |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1443 * PARAMETERS: |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1444 * session : Pointer to a session object. |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1445 * |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1446 * DESCRIPTION: |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1447 * Destroys the resources of a session, only if no session_state is associated with it. |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1448 * |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1449 * RETURN VALUE: |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1450 * 0 : The session no longer exists. |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1451 * EINVAL : A parameter is invalid. |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1452 */ |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1453 int fd_sess_reclaim ( struct session ** session ); |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1454 |
|
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1455 |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1456 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1457 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1458 /* |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1459 * FUNCTION: fd_sess_state_store |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1460 * |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1461 * PARAMETERS: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1462 * handler : The handler with which the state is registered. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1463 * session : The session object with which the state is registered. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1464 * state : An application state (opaque data) to store with the session. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1465 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1466 * DESCRIPTION: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1467 * Stores an application state with a session. This state can later be retrieved |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1468 * with fd_sess_state_retrieve, or implicitly in the cleanup handler when the session |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1469 * is destroyed. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1470 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1471 * RETURN VALUE: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1472 * 0 : The state has been stored. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1473 * EINVAL : A parameter is invalid. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1474 * EALREADY : Data was already associated with this session and client. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1475 * ENOMEM : Not enough memory to complete the operation |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1476 */ |
|
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1477 int fd_sess_state_store_internal ( struct session_handler * handler, struct session * session, session_state ** state ); |
|
5
c2d2729e3603
Completed new session module tests; some bugs fixed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
3
diff
changeset
|
1478 #define fd_sess_state_store( _handler, _session, _state ) \ |
|
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1479 fd_sess_state_store_internal( (_handler), (_session), (void *)(_state) ) |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1480 |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1481 /* |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1482 * FUNCTION: fd_sess_state_retrieve |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1483 * |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1484 * PARAMETERS: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1485 * handler : The handler with which the state was registered. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1486 * session : The session object with which the state was registered. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1487 * state : Location where the state must be saved if it is found. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1488 * |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1489 * DESCRIPTION: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1490 * Retrieves a state saved by fd_sess_state_store. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1491 * After this function has been called, the state is no longer associated with |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1492 * the session. A new call to fd_sess_state_store must be performed in order to |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1493 * store again the data with the session. |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1494 * |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1495 * RETURN VALUE: |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1496 * 0 : *state is updated (NULL or points to the state if it was found). |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1497 * EINVAL : A parameter is invalid. |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1498 */ |
|
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1499 int fd_sess_state_retrieve_internal ( struct session_handler * handler, struct session * session, session_state ** state ); |
|
5
c2d2729e3603
Completed new session module tests; some bugs fixed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
3
diff
changeset
|
1500 #define fd_sess_state_retrieve( _handler, _session, _state ) \ |
|
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1501 fd_sess_state_retrieve_internal( (_handler), (_session), (void *)(_state) ) |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1502 |
|
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1503 |
|
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1504 /* For debug */ |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1505 void fd_sess_dump(int level, struct session * session); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1506 void fd_sess_dump_hdl(int level, struct session_handler * handler); |
|
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1507 |
|
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1508 |
|
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1509 /*============================================================*/ |
| 0 | 1510 /* MESSAGES */ |
| 1511 /*============================================================*/ | |
| 1512 | |
| 1513 /* The following types are opaque */ | |
| 1514 struct msg; /* A message: command with children AVPs (possibly grand children) */ | |
| 1515 struct avp; /* AVP object */ | |
| 1516 | |
| 1517 /* Some details about chaining: | |
| 1518 * | |
| 1519 * A message is made of a header ( msg ) and 0 or more AVPs ( avp ). | |
| 1520 * The structure is a kind of tree, where some AVPs (grouped AVPs) can contain other AVPs. | |
| 1521 * Exemple: | |
| 1522 * msg | |
| 1523 * |-avp | |
| 1524 * |-gavp | |
| 1525 * | |-avp | |
| 1526 * | |-avp | |
| 1527 * | \-avp | |
| 1528 * |-avp | |
| 1529 * \-avp | |
| 1530 * | |
| 1531 */ | |
| 1532 | |
| 1533 /* The following type is used to point to either a msg or an AVP */ | |
| 1534 typedef void msg_or_avp; | |
| 1535 | |
| 1536 /* The Diameter protocol version */ | |
| 1537 #define DIAMETER_VERSION 1 | |
| 1538 | |
| 1539 /* In the two following types, some fields are marked (READONLY). | |
| 1540 * This means that the content of these fields will be overwritten by the daemon so modifying it is useless. | |
| 1541 */ | |
| 1542 | |
| 1543 /* The following structure represents the header of a message. All data is in host byte order. */ | |
| 1544 struct msg_hdr { | |
| 1545 uint8_t msg_version; /* (READONLY) Version of Diameter: must be DIAMETER_VERSION. */ | |
| 1546 uint32_t msg_length; /* (READONLY)(3 bytes) indicates the length of the message */ | |
| 1547 uint8_t msg_flags; /* Message flags: CMD_FLAG_* */ | |
| 1548 command_code_t msg_code; /* (3 bytes) the command-code. See dictionary-api.h for more detail */ | |
| 1549 application_id_t msg_appl; /* The application issuing this message */ | |
| 1550 uint32_t msg_hbhid; /* The Hop-by-Hop identifier of the message */ | |
| 1551 uint32_t msg_eteid; /* The End-to-End identifier of the message */ | |
| 1552 }; | |
| 1553 | |
| 1554 /* The following structure represents the visible content of an AVP. All data is in host byte order. */ | |
| 1555 struct avp_hdr { | |
| 1556 avp_code_t avp_code; /* the AVP Code */ | |
| 1557 uint8_t avp_flags; /* AVP_FLAG_* flags */ | |
| 1558 uint32_t avp_len; /* (READONLY)(Only 3 bytes are used) the length of the AVP as described in the RFC */ | |
| 1559 vendor_id_t avp_vendor; /* Only used if AVP_FLAG_VENDOR is present */ | |
| 1560 union avp_value *avp_value; /* pointer to the value of the AVP. NULL means that the value is not set / not understood. | |
| 1561 One should not directly change this value. Use the msg_avp_setvalue function instead. | |
| 1562 The content of the pointed structure can be changed directly, with this restriction: | |
| 1563 if the AVP is an OctetString, and you change the value of the pointer avp_value->os.data, then | |
| 1564 you must call free() on the previous value, and the new one must be free()-able. | |
| 1565 */ | |
| 1566 }; | |
| 1567 | |
| 1568 /* The following enum is used to browse inside message hierarchy (msg, gavp, avp) */ | |
| 1569 enum msg_brw_dir { | |
| 1570 MSG_BRW_NEXT = 1, /* Get the next element at the same level, or NULL if this is the last element. */ | |
| 1571 MSG_BRW_PREV, /* Get the previous element at the same level, or NULL if this is the first element. */ | |
| 1572 MSG_BRW_FIRST_CHILD, /* Get the first child AVP of this element, if any. */ | |
| 1573 MSG_BRW_LAST_CHILD, /* Get the last child AVP of this element, if any. */ | |
| 1574 MSG_BRW_PARENT, /* Get the parent element of this element, if any. Only the msg_t object has no parent. */ | |
| 1575 MSG_BRW_WALK /* This is equivalent to FIRST_CHILD or NEXT or PARENT->next, first that is not NULL. Use this to walk inside all AVPs. */ | |
| 1576 }; | |
| 1577 | |
| 1578 /* Some flags used in the functions bellow */ | |
| 1579 #define MSGFL_ALLOC_ETEID 0x01 /* When creating a message, a new end-to-end ID is allocated and set in the message */ | |
| 1580 #define MSGFL_ANSW_ERROR 0x02 /* When creating an answer message, set the 'E' bit and use the generic error ABNF instead of command-specific ABNF */ | |
| 1581 #define MSGFL_MAX MSGFL_ANSW_ERROR /* The biggest valid flag value */ | |
| 1582 | |
| 1583 /**************************************************/ | |
| 1584 /* Message creation, manipulation, disposal */ | |
| 1585 /**************************************************/ | |
| 1586 /* | |
| 1587 * FUNCTION: fd_msg_avp_new | |
| 1588 * | |
| 1589 * PARAMETERS: | |
| 1590 * model : Pointer to a DICT_AVP dictionary object describing the avp to create, or NULL. | |
| 1591 * flags : Flags to use in creation (not used yet, should be 0). | |
| 1592 * avp : Upon success, pointer to the new avp is stored here. | |
| 1593 * | |
| 1594 * DESCRIPTION: | |
| 1595 * Create a new AVP instance. | |
| 1596 * | |
| 1597 * RETURN VALUE: | |
| 1598 * 0 : The AVP is created. | |
| 1599 * EINVAL : A parameter is invalid. | |
| 1600 * (other standard errors may be returned, too, with their standard meaning. Example: | |
| 1601 * ENOMEM : Memory allocation for the new avp failed.) | |
| 1602 */ | |
| 1603 int fd_msg_avp_new ( struct dict_object * model, int flags, struct avp ** avp ); | |
| 1604 | |
| 1605 /* | |
| 1606 * FUNCTION: fd_msg_new | |
| 1607 * | |
| 1608 * PARAMETERS: | |
| 1609 * model : Pointer to a DICT_COMMAND dictionary object describing the message to create, or NULL. | |
| 1610 * flags : combination of MSGFL_* flags. | |
| 1611 * msg : Upon success, pointer to the new message is stored here. | |
| 1612 * | |
| 1613 * DESCRIPTION: | |
| 1614 * Create a new empty Diameter message. | |
| 1615 * | |
| 1616 * RETURN VALUE: | |
| 1617 * 0 : The message is created. | |
| 1618 * EINVAL : A parameter is invalid. | |
| 1619 * (other standard errors may be returned, too, with their standard meaning. Example: | |
| 1620 * ENOMEM : Memory allocation for the new message failed.) | |
| 1621 */ | |
| 1622 int fd_msg_new ( struct dict_object * model, int flags, struct msg ** msg ); | |
| 1623 | |
| 1624 /* | |
| 1625 * FUNCTION: msg_new_answer_from_req | |
| 1626 * | |
| 1627 * PARAMETERS: | |
| 1628 * dict : Pointer to the dictionary containing the model of the query. | |
| 1629 * msg : The location of the query on function call. Updated by the location of answer message on return. | |
| 1630 * flag : Pass MSGFL_ANSW_ERROR to indicate if the answer is an error message (will set the 'E' bit) | |
| 1631 * | |
| 1632 * DESCRIPTION: | |
| 1633 * This function creates the empty answer message corresponding to a request. | |
| 1634 * The header is set properly (R flag, ccode, appid, hbhid, eteid) | |
| 1635 * The Session-Id AVP is copied if present. | |
| 1636 * The calling code should usually call fd_msg_rescode_set function on the answer. | |
| 1637 * Upon return, the original query may be retrieved by calling fd_msg_answ_getq on the message. | |
| 1638 * | |
| 1639 * RETURN VALUE: | |
| 1640 * 0 : Operation complete. | |
| 1641 * !0 : an error occurred. | |
| 1642 */ | |
| 1643 int fd_msg_new_answer_from_req ( struct dictionary * dict, struct msg ** msg, int flag ); | |
| 1644 | |
| 1645 /* | |
| 1646 * FUNCTION: fd_msg_browse | |
| 1647 * | |
| 1648 * PARAMETERS: | |
| 1649 * reference : Pointer to a struct msg or struct avp. | |
| 1650 * dir : Direction for browsing | |
| 1651 * found : If not NULL, updated with the element that has been found, if any, or NULL if no element was found / an error occurred. | |
| 1652 * depth : If not NULL, points to an integer representing the "depth" of this object in the tree. This is a relative value, updated on return. | |
| 1653 * | |
| 1654 * DESCRIPTION: | |
| 1655 * Explore the content of a message object (hierarchy). If "found" is null, only error checking is performed. | |
| 1656 * If "depth" is provided, it is updated as follow on successful function return: | |
| 1657 * - not modified for MSG_BRW_NEXT and MSG_BRW_PREV. | |
| 1658 * - *depth = *depth + 1 for MSG_BRW_FIRST_CHILD and MSG_BRW_LAST_CHILD. | |
| 1659 * - *depth = *depth - 1 for MSG_BRW_PARENT. | |
| 1660 * - *depth = *depth + X for MSG_BRW_WALK, with X between 1 (returned the 1st child) and -N (returned the Nth parent's next). | |
| 1661 * | |
| 1662 * RETURN VALUE: | |
| 1663 * 0 : found has been updated (if non NULL). | |
| 1664 * EINVAL : A parameter is invalid. | |
| 1665 * ENOENT : No element has been found where requested, and "found" was NULL (otherwise, *found is set to NULL and 0 is returned). | |
| 1666 */ | |
| 1667 int fd_msg_browse_internal ( msg_or_avp * reference, enum msg_brw_dir dir, msg_or_avp ** found, int * depth ); | |
| 1668 /* Macro to avoid having to cast the third parameter everywhere */ | |
| 1669 #define fd_msg_browse( ref, dir, found, depth ) \ | |
| 1670 fd_msg_browse_internal( (ref), (dir), (void *)(found), (depth) ) | |
| 1671 | |
| 1672 | |
| 1673 /* | |
| 1674 * FUNCTION: fd_msg_avp_add | |
| 1675 * | |
| 1676 * PARAMETERS: | |
| 1677 * reference : Pointer to a valid msg or avp. | |
| 1678 * dir : location where the new AVP should be inserted, relative to the reference. MSG_BRW_PARENT and MSG_BRW_WALK are not valid. | |
| 1679 * avp : pointer to the AVP object that must be inserted. | |
| 1680 * | |
| 1681 * DESCRIPTION: | |
| 1682 * Adds an AVP into an object that can contain it: grouped AVP or message. | |
| 1683 * | |
| 1684 * RETURN VALUE: | |
| 1685 * 0 : The AVP has been added. | |
| 1686 * EINVAL : A parameter is invalid. | |
| 1687 */ | |
| 1688 int fd_msg_avp_add ( msg_or_avp * reference, enum msg_brw_dir dir, struct avp *avp); | |
| 1689 | |
| 1690 /* | |
| 1691 * FUNCTION: fd_msg_search_avp | |
| 1692 * | |
| 1693 * PARAMETERS: | |
| 1694 * msg : The message structure in which to search the AVP. | |
| 1695 * what : The dictionary model of the AVP to search. | |
| 1696 * avp : location where the AVP reference is stored if found. | |
| 1697 * | |
| 1698 * DESCRIPTION: | |
| 1699 * Search the first top-level AVP of a given model inside a message. | |
| 1700 * Note: only the first instance of the AVP is returned by this function. | |
| 1701 * Note: only top-level AVPs are searched, not inside grouped AVPs. | |
| 1702 * Use msg_browse if you need more advanced research features. | |
| 1703 * | |
| 1704 * RETURN VALUE: | |
| 1705 * 0 : The AVP has been found. | |
| 1706 * EINVAL : A parameter is invalid. | |
| 1707 * ENOENT : No AVP has been found, and "avp" was NULL (otherwise, *avp is set to NULL and 0 returned). | |
| 1708 */ | |
| 1709 int fd_msg_search_avp ( struct msg * msg, struct dict_object * what, struct avp ** avp ); | |
| 1710 | |
| 1711 /* | |
| 1712 * FUNCTION: fd_msg_free | |
| 1713 * | |
| 1714 * PARAMETERS: | |
| 1715 * object : pointer to the message or AVP object that must be unlinked and freed. | |
| 1716 * | |
| 1717 * DESCRIPTION: | |
| 1718 * Unlink and free a message or AVP object and its children. | |
| 1719 * If the object is an AVP linked into a message, the AVP is removed before being freed. | |
| 1720 * | |
| 1721 * RETURN VALUE: | |
| 1722 * 0 : The message has been freed. | |
| 1723 * EINVAL : A parameter is invalid. | |
| 1724 */ | |
| 1725 int fd_msg_free ( msg_or_avp * object ); | |
| 1726 | |
| 1727 /***************************************/ | |
| 1728 /* Dump functions */ | |
| 1729 /***************************************/ | |
| 1730 /* | |
| 1731 * FUNCTION: fd_msg_dump_* | |
| 1732 * | |
| 1733 * PARAMETERS: | |
| 1734 * level : the log level (INFO, FULL, ...) at which the object is dumped | |
| 1735 * obj : A msg or avp object. | |
| 1736 * | |
| 1737 * DESCRIPTION: | |
| 1738 * These functions dump the content of a message to the debug log | |
| 1739 * either recursively or only the object itself. | |
| 1740 * | |
| 1741 * RETURN VALUE: | |
| 1742 * - | |
| 1743 */ | |
| 1744 void fd_msg_dump_walk ( int level, msg_or_avp *obj ); | |
| 1745 void fd_msg_dump_one ( int level, msg_or_avp *obj ); | |
| 1746 | |
| 1747 | |
| 1748 /*********************************************/ | |
| 1749 /* Message metadata management functions */ | |
| 1750 /*********************************************/ | |
| 1751 /* | |
| 1752 * FUNCTION: fd_msg_model | |
| 1753 * | |
| 1754 * PARAMETERS: | |
| 1755 * reference : Pointer to a valid msg or avp. | |
| 1756 * model : on success, pointer to the dictionary model of this command or AVP. NULL if the model is unknown. | |
| 1757 * | |
| 1758 * DESCRIPTION: | |
| 1759 * Retrieve the dictionary object describing this message or avp. If the object is unknown or the fd_msg_parse_dict has not been called, | |
| 1760 * *model is set to NULL. | |
| 1761 * | |
| 1762 * RETURN VALUE: | |
| 1763 * 0 : The model has been set. | |
| 1764 * EINVAL : A parameter is invalid. | |
| 1765 */ | |
| 1766 int fd_msg_model ( msg_or_avp * reference, struct dict_object ** model ); | |
| 1767 | |
| 1768 /* | |
| 1769 * FUNCTION: fd_msg_hdr | |
| 1770 * | |
| 1771 * PARAMETERS: | |
| 1772 * msg : Pointer to a valid message object. | |
| 1773 * pdata : Upon success, pointer to the msg_hdr structure of this message. The fields may be modified. | |
| 1774 * | |
| 1775 * DESCRIPTION: | |
| 1776 * Retrieve location of modifiable section of a message. | |
| 1777 * | |
| 1778 * RETURN VALUE: | |
| 1779 * 0 : The location has been written. | |
| 1780 * EINVAL : A parameter is invalid. | |
| 1781 */ | |
| 1782 int fd_msg_hdr ( struct msg *msg, struct msg_hdr **pdata ); | |
| 1783 | |
| 1784 /* | |
| 1785 * FUNCTION: fd_msg_avp_hdr | |
| 1786 * | |
| 1787 * PARAMETERS: | |
| 1788 * avp : Pointer to a valid avp object. | |
| 1789 * pdata : Upon success, pointer to the avp_hdr structure of this avp. The fields may be modified. | |
| 1790 * | |
| 1791 * DESCRIPTION: | |
| 1792 * Retrieve location of modifiable data of an avp. | |
| 1793 * | |
| 1794 * RETURN VALUE: | |
| 1795 * 0 : The location has been written. | |
| 1796 * EINVAL : A parameter is invalid. | |
| 1797 */ | |
| 1798 int fd_msg_avp_hdr ( struct avp *avp, struct avp_hdr **pdata ); | |
| 1799 | |
| 1800 /* | |
| 1801 * FUNCTION: fd_msg_answ_associate, fd_msg_answ_getq, fd_msg_answ_detach | |
| 1802 * | |
| 1803 * PARAMETERS: | |
| 1804 * answer : the received answer message | |
| 1805 * query : the corresponding query that had been sent | |
| 1806 * | |
| 1807 * DESCRIPTION: | |
| 1808 * fd_msg_answ_associate associates a query msg with the received answer. | |
| 1809 * Query is retrieved with fd_msg_answ_getq. | |
| 1810 * If answer message is freed, the query is also freed. | |
| 1811 * If the msg_answ_detach function is called, the association is removed. | |
| 1812 * This is meant to be called from the daemon only. | |
| 1813 * | |
| 1814 * RETURN VALUE: | |
| 1815 * 0 : ok | |
| 1816 * EINVAL: a parameter is invalid | |
| 1817 */ | |
| 1818 int fd_msg_answ_associate( struct msg * answer, struct msg * query ); | |
| 1819 int fd_msg_answ_getq ( struct msg * answer, struct msg ** query ); | |
| 1820 int fd_msg_answ_detach ( struct msg * answer ); | |
| 1821 | |
| 1822 /* | |
| 1823 * FUNCTION: fd_msg_anscb_associate, fd_msg_anscb_get | |
| 1824 * | |
| 1825 * PARAMETERS: | |
| 1826 * msg : the answer message | |
| 1827 * anscb : the callback to associate with the message | |
| 1828 * data : the data to pass to the callback | |
| 1829 * | |
| 1830 * DESCRIPTION: | |
| 1831 * Associate or retrieve a callback with an answer message. | |
| 1832 * This is meant to be called from the daemon only. | |
| 1833 * | |
| 1834 * RETURN VALUE: | |
| 1835 * 0 : ok | |
| 1836 * EINVAL: a parameter is invalid | |
| 1837 */ | |
| 1838 int fd_msg_anscb_associate( struct msg * msg, void ( *anscb)(void *, struct msg **), void * data ); | |
| 1839 int fd_msg_anscb_get ( struct msg * msg, void (**anscb)(void *, struct msg **), void ** data ); | |
| 1840 | |
| 1841 /* | |
| 1842 * FUNCTION: fd_msg_rt_associate, fd_msg_rt_get | |
| 1843 * | |
| 1844 * PARAMETERS: | |
| 1845 * msg : the query message to be sent | |
| 1846 * list : the ordered list of possible next-peers | |
| 1847 * | |
| 1848 * DESCRIPTION: | |
| 1849 * Associate a routing list with a query, and retrieve it. | |
| 1850 * If the message is freed, the list is also freed. | |
| 1851 * | |
| 1852 * RETURN VALUE: | |
| 1853 * 0 : ok | |
| 1854 * EINVAL: a parameter is invalid | |
| 1855 */ | |
| 1856 int fd_msg_rt_associate( struct msg * msg, struct fd_list ** list ); | |
| 1857 int fd_msg_rt_get ( struct msg * msg, struct fd_list ** list ); | |
| 1858 | |
| 1859 /* | |
| 1860 * FUNCTION: fd_msg_is_routable | |
| 1861 * | |
| 1862 * PARAMETERS: | |
| 1863 * msg : A msg object. | |
| 1864 * | |
| 1865 * DESCRIPTION: | |
| 1866 * This function returns a boolean telling if a given message is routable in the Diameter network, | |
| 1867 * or if it is a local link message only (ex: CER/CEA, DWR/DWA, ...). | |
| 1868 * | |
| 1869 * RETURN VALUE: | |
| 1870 * 0 : The message is not routable / an error occurred. | |
| 1871 * 1 : The message is routable. | |
| 1872 */ | |
| 1873 int fd_msg_is_routable ( struct msg * msg ); | |
| 1874 | |
| 1875 /* | |
| 1876 * FUNCTION: fd_msg_source_(g/s)et | |
| 1877 * | |
| 1878 * PARAMETERS: | |
| 1879 * msg : A msg object. | |
| 1880 * diamid : The diameter id of the peer from which this message was received. | |
| 1881 * hash : The hash for the diamid value. | |
| 1882 * add_rr : if true, a Route-Record AVP is added to the message with content diamid. In that case, dict must be supplied. | |
| 1883 * dict : a dictionary with definition of Route-Record AVP (if add_rr is true) | |
| 1884 * | |
| 1885 * DESCRIPTION: | |
| 1886 * Store or retrieve the diameted id of the peer from which this message was received. | |
| 1887 * Will be used for example by the routing module to add the Route-Record AVP in forwarded requests, | |
| 1888 * or to direct answers to the appropriate peer. | |
| 1889 * | |
| 1890 * RETURN VALUE: | |
| 1891 * 0 : Operation complete. | |
| 1892 * !0 : an error occurred. | |
| 1893 */ | |
| 1894 int fd_msg_source_set( struct msg * msg, char * diamid, uint32_t hash, int add_rr, struct dictionary * dict ); | |
| 1895 int fd_msg_source_get( struct msg * msg, char ** diamid, uint32_t *hash ); | |
| 1896 | |
| 1897 /* | |
| 1898 * FUNCTION: fd_msg_eteid_get | |
| 1899 * | |
| 1900 * PARAMETERS: | |
| 1901 * - | |
| 1902 * | |
| 1903 * DESCRIPTION: | |
| 1904 * Get a new unique end-to-end id value for the local peer. | |
| 1905 * | |
| 1906 * RETURN VALUE: | |
| 1907 * The new assigned value. No error code is defined. | |
| 1908 */ | |
| 1909 uint32_t fd_msg_eteid_get ( void ); | |
| 1910 | |
| 1911 | |
| 1912 /***************************************/ | |
| 1913 /* Manage AVP values */ | |
| 1914 /***************************************/ | |
| 1915 | |
| 1916 /* | |
| 1917 * FUNCTION: fd_msg_avp_setvalue | |
| 1918 * | |
| 1919 * PARAMETERS: | |
| 1920 * avp : Pointer to a valid avp object with a NULL avp_value pointer. The model must be known. | |
| 1921 * value : pointer to an avp_value. The content will be COPIED into the internal storage area. | |
| 1922 * If data type is an octetstring, the data is also copied. | |
| 1923 * If value is a NULL pointer, the previous data is erased and value is unset in the AVP. | |
| 1924 * | |
| 1925 * DESCRIPTION: | |
| 1926 * Initialize the avp_value field of an AVP header. | |
| 1927 * | |
| 1928 * RETURN VALUE: | |
| 1929 * 0 : The avp_value pointer has been set. | |
| 1930 * EINVAL : A parameter is invalid. | |
| 1931 */ | |
| 1932 int fd_msg_avp_setvalue ( struct avp *avp, union avp_value *value ); | |
| 1933 | |
| 1934 /* | |
| 1935 * FUNCTION: fd_msg_avp_value_encode | |
| 1936 * | |
| 1937 * PARAMETERS: | |
| 1938 * avp : Pointer to a valid avp object with a NULL avp_value. The model must be known. | |
| 1939 * data : Pointer to the data that must be encoded as AVP value and stored in the AVP. | |
| 1940 * This is only valid for AVPs of derived type for which type_data_encode callback is set. (ex: Address type) | |
| 1941 * | |
| 1942 * DESCRIPTION: | |
| 1943 * Initialize the avp_value field of an AVP object from formatted data, using the AVP's type "type_data_encode" callback. | |
| 1944 * | |
| 1945 * RETURN VALUE: | |
| 1946 * 0 : The avp_value has been set. | |
| 1947 * EINVAL : A parameter is invalid. | |
| 1948 * ENOTSUP : There is no appropriate callback registered with this AVP's type. | |
| 1949 */ | |
| 1950 int fd_msg_avp_value_encode ( void *data, struct avp *avp ); | |
| 1951 | |
| 1952 /* | |
| 1953 * FUNCTION: fd_msg_avp_value_interpret | |
| 1954 * | |
| 1955 * PARAMETERS: | |
| 1956 * avp : Pointer to a valid avp object with a non-NULL avp_value value. | |
| 1957 * data : Upon success, formatted interpretation of the AVP value is stored here. | |
| 1958 * | |
| 1959 * DESCRIPTION: | |
| 1960 * Interpret the content of an AVP of Derived type and store the result in data pointer. The structure | |
| 1961 * of the data pointer is dependent on the AVP type. This function calls the "type_data_interpret" callback | |
| 1962 * of the type. | |
| 1963 * | |
| 1964 * RETURN VALUE: | |
| 1965 * 0 : The avp_value has been set. | |
| 1966 * EINVAL : A parameter is invalid. | |
| 1967 * ENOTSUP : There is no appropriate callback registered with this AVP's type. | |
| 1968 */ | |
| 1969 int fd_msg_avp_value_interpret ( struct avp *avp, void *data ); | |
| 1970 | |
| 1971 | |
| 1972 /***************************************/ | |
| 1973 /* Message parsing functions */ | |
| 1974 /***************************************/ | |
| 1975 | |
| 1976 /* | |
| 1977 * FUNCTION: fd_msg_bufferize | |
| 1978 * | |
| 1979 * PARAMETERS: | |
| 1980 * msg : A valid msg object. All AVPs must have a value set. | |
| 1981 * buffer : Upon success, this points to a buffer (malloc'd) containing the message ready for network transmission (or security transformations). | |
| 1982 * The buffer may be freed after use. | |
| 1983 * len : if not NULL, the size of the buffer is written here. In any case, this size is updated in the msg header. | |
| 1984 * | |
| 1985 * DESCRIPTION: | |
| 1986 * Renders a message in memory as a buffer that can be sent over the network to the next peer. | |
| 1987 * | |
| 1988 * RETURN VALUE: | |
| 1989 * 0 : The location has been written. | |
| 1990 * EINVAL : The buffer does not contain a valid Diameter message. | |
| 1991 * ENOMEM : Unable to allocate enough memory to create the buffer object. | |
| 1992 */ | |
| 1993 int fd_msg_bufferize ( struct msg * msg, unsigned char ** buffer, size_t * len ); | |
| 1994 | |
| 1995 /* | |
| 1996 * FUNCTION: fd_msg_parse_buffer | |
| 1997 * | |
| 1998 * PARAMETERS: | |
| 1999 * buffer : Pointer to a buffer containing a message received from the network. | |
| 2000 * buflen : the size in bytes of the buffer. | |
| 2001 * msg : Upon success, this points to a valid msg object. No AVP value is resolved in this object, nor grouped AVP. | |
| 2002 * | |
| 2003 * DESCRIPTION: | |
| 2004 * This function parses a buffer an creates a msg object to represent the structure of the message. | |
| 2005 * Since no dictionary lookup is performed, the values of the AVPs are not interpreted. To interpret the values, | |
| 2006 * the returned message object must be passed to fd_msg_parse_dict function. | |
| 2007 * The buffer pointer is saved inside the message and will be freed when not needed anymore. | |
| 2008 * | |
| 2009 * RETURN VALUE: | |
| 2010 * 0 : The location has been written. | |
| 2011 * ENOMEM : Unable to allocate enough memory to create the msg object. | |
| 2012 * EBADMSG : The buffer does not contain a valid Diameter message (or is truncated). | |
| 2013 * EINVAL : A parameter is invalid. | |
| 2014 */ | |
| 2015 int fd_msg_parse_buffer ( unsigned char ** buffer, size_t buflen, struct msg ** msg ); | |
| 2016 | |
| 2017 /* | |
| 2018 * FUNCTION: fd_msg_parse_dict | |
| 2019 * | |
| 2020 * PARAMETERS: | |
| 2021 * object : A msg or AVP object as returned by fd_msg_parse_buffer. | |
| 2022 * dict : the dictionary containing the objects definitions to use for resolving all AVPs. | |
| 2023 * | |
| 2024 * DESCRIPTION: | |
| 2025 * This function looks up for the command and each children AVP definitions in the dictionary. | |
| 2026 * If the dictionary definition is found, avp_model is set and the value of the AVP is interpreted accordingly and: | |
| 2027 * - for grouped AVPs, the children AVP are created and interpreted also. | |
| 2028 * - for numerical AVPs, the value is converted to host byte order and saved in the avp_value field. | |
| 2029 * - for octetstring AVPs, the string is copied into a new buffer and its address is saved in avp_value. | |
| 2030 * If the dictionary definition is not found, avp_model is set to NULL and | |
| 2031 * the content of the AVP is saved as an octetstring in an internal structure. avp_value is NULL. | |
| 2032 * As a result, after this function has been called, there is no more dependency of the msg object to the message buffer, that is be freed. | |
| 2033 * | |
| 2034 * RETURN VALUE: | |
| 2035 * 0 : The message has been fully parsed as described. | |
| 2036 * EINVAL : The msg parameter is invalid for this operation. | |
| 2037 * ENOMEM : Unable to allocate enough memory to complete the operation. | |
| 2038 * ENOTSUP : No dictionary definition for the command or one of the mandatory AVP was found. | |
| 2039 */ | |
| 2040 int fd_msg_parse_dict ( msg_or_avp * object, struct dictionary * dict ); | |
| 2041 | |
| 2042 /* | |
| 2043 * FUNCTION: fd_msg_parse_rules | |
| 2044 * | |
| 2045 * PARAMETERS: | |
| 2046 * object : A msg or grouped avp object that must be verified. | |
| 2047 * dict : The dictionary containing the rules definitions. | |
| 2048 * rule : If not NULL, the first conflicting rule will be saved here if a conflict is found. | |
| 2049 * | |
| 2050 * DESCRIPTION: | |
| 2051 * Check that the children of the object do not conflict with the dictionary rules (ABNF compliance). | |
| 2052 * | |
| 2053 * RETURN VALUE: | |
| 2054 * 0 : The message has been fully parsed and complies to the defined rules. | |
| 2055 * EBADMSG : A conflict was detected, or a mandatory AVP is unknown in the dictionary. | |
| 2056 * EINVAL : The msg or avp object is invalid for this operation. | |
| 2057 * ENOMEM : Unable to allocate enough memory to complete the operation. | |
| 2058 */ | |
| 2059 int fd_msg_parse_rules ( msg_or_avp * object, struct dictionary * dict, struct dict_object ** rule); | |
| 2060 | |
| 2061 | |
| 2062 /* | |
| 2063 * FUNCTION: fd_msg_update_length | |
| 2064 * | |
| 2065 * PARAMETERS: | |
| 2066 * object : Pointer to a valid msg or avp. | |
| 2067 * | |
| 2068 * DESCRIPTION: | |
| 2069 * Update the length field of the object passed as parameter. | |
| 2070 * As a side effect, all children objects are also updated. Therefore, all avp_value fields of | |
| 2071 * the children AVPs must be set, or an error will occur. | |
| 2072 * | |
| 2073 * RETURN VALUE: | |
| 2074 * 0 : The size has been recomputed. | |
| 2075 * EINVAL : A parameter is invalid. | |
| 2076 */ | |
| 2077 int fd_msg_update_length ( msg_or_avp * object ); | |
| 2078 | |
| 2079 | |
|
7
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2080 /*============================================================*/ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2081 /* DISPATCH */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2082 /*============================================================*/ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2083 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2084 /* Dispatch module (passing incoming messages to extensions registered callbacks) |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2085 * is split between the library and the daemon. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2086 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2087 * The library provides the support for associating dispatch callbacks with |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2088 * dictionary objects. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2089 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2090 * The daemon is responsible for calling the callbacks for a message when appropriate. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2091 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2092 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2093 * The dispatch module has two main roles: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2094 * - help determine if a message can be handled locally (during the routing step) |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2095 * This decision involves only the application-id of the message. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2096 * - pass the message to the callback(s) that will handle it (during the dispatch step) |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2097 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2098 * The first role is handled by the daemon. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2099 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2100 * About the second, these are the possibilities for registering a dispatch callback: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2101 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2102 * -> For All messages. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2103 * This callback is called for all messages that are handled locally. This should be used only |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2104 * for debug purpose. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2105 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2106 * -> by AVP value (constants only). |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2107 * This callback will be called when a message is received and contains an AVP with a specified enumerated value. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2108 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2109 * -> by AVP. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2110 * This callback will be called when the received message contains a certain AVP. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2111 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2112 * -> by command-code. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2113 * This callback will be called when the message is a specific command (and 'R' flag). |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2114 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2115 * -> by application. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2116 * This callback will be called when the message has a specific application-id. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2117 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2118 * ( by vendor: would this be useful? it may be added later) |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2119 */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2120 enum disp_how { |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2121 DISP_HOW_ANY = 1, /* Any message. This should be only used for debug. */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2122 DISP_HOW_APPID, /* Any message with the specified application-id */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2123 DISP_HOW_CC, /* Messages of the specified command-code (request or answer). App id may be specified. */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2124 DISP_HOW_AVP, /* Messages containing a specific AVP. Command-code and App id may be specified. */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2125 DISP_HOW_AVP_ENUMVAL /* Messages containing a specific AVP with a specific enumerated value. Command-code and App id may be specified. */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2126 }; |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2127 /* |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2128 * Several criteria may be selected at the same time, for example command-code AND application id. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2129 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2130 * If several callbacks are registered for the same object, they are called in the order they were registered. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2131 * The order in which the callbacks are called is: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2132 * DISP_HOW_ANY |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2133 * DISP_HOW_AVP_ENUMVAL & DISP_HOW_AVP |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2134 * DISP_HOW_CC |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2135 * DISP_HOW_APPID |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2136 */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2137 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2138 /* When a callback is registered, a "when" argument is passed in addition to the disp_how value, |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2139 * to specify which values the criteria must match. */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2140 struct disp_when { |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2141 struct dict_object * app; |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2142 struct dict_object * command; |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2143 struct dict_object * avp; |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2144 struct dict_object * value; |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2145 }; |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2146 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2147 /* Note that all the dictionary objects should really belong to the same dictionary! |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2148 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2149 * Here is the details on this "when" argument, depending on the disp_how value. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2150 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2151 * DISP_HOW_ANY. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2152 * In this case, "when" must be NULL. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2153 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2154 * DISP_HOW_APPID. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2155 * Only the "app_id" field must be set, other fields are ignored. It points to a dictionary object of type DICT_APPLICATION. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2156 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2157 * DISP_HOW_CC. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2158 * The "command" field must be defined and point to a dictionary object of type DICT_COMMAND. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2159 * The "app_id" may be also set. In the case it is set, it restricts the callback to be called only with this command-code and app id. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2160 * The other fields are ignored. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2161 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2162 * DISP_HOW_AVP. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2163 * The "avp" field of the structure must be set and point to a dictionary object of type DICT_AVP. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2164 * The "app_id" field may be set to restrict the messages matching to a specific app id. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2165 * The "command" field may also be set to a valid DICT_COMMAND object. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2166 * The content of the "value" field is ignored. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2167 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2168 * DISP_HOW_AVP_ENUMVAL. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2169 * All fields have the same constraints and meaning as in DISP_REG_AVP. In addition, the "value" field must be set |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2170 * and points to a valid DICT_ENUMVAL object. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2171 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2172 * Here is a sumary of the fields: ( M : must be set; m : may be set; 0 : ignored ) |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2173 * field: app_id command avp value |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2174 * APPID : M 0 0 0 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2175 * CC : m M 0 0 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2176 * AVP : m m M 0 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2177 * ENUMVA: m m M M |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2178 */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2179 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2180 enum disp_action { |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2181 DISP_ACT_CONT, /* The next handler should be called, unless *msg == NULL. */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2182 DISP_ACT_SEND /* The updated message must be sent. No further callback is called. */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2183 }; |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2184 /* The callbacks that are registered have the following prototype: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2185 * int dispatch_callback( struct msg ** msg, struct avp * avp, struct session * session, enum disp_action * action ); |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2186 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2187 * CALLBACK: dispatch_callback |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2188 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2189 * PARAMETERS: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2190 * msg : the received message on function entry. may be updated to answer on return (see description) |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2191 * avp : for callbacks registered with DISP_HOW_AVP or DISP_HOW_AVP_ENUMVAL, direct link to the triggering AVP. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2192 * session : if the message contains a Session-Id AVP, the corresponding session object, NULL otherwise. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2193 * action : upon return, this tells the daemon what to do next. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2194 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2195 * DESCRIPTION: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2196 * Called when a received message matchs the condition for which the callback was registered. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2197 * This callback may do any kind of processing on the message, including: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2198 * - create an answer for a request. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2199 * - proxy a request or message, add / remove the Proxy-Info AVP, then forward the message. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2200 * - update a routing table or start a connection with a new peer, then forward the message. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2201 * - ... |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2202 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2203 * When *action == DISP_ACT_SEND on callback return, the msg pointed by *msg is passed to the routing module for sending. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2204 * When *action == DISP_ACT_CONT, the next registered callback is called. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2205 * When the last callback gives also DISP_ACT_CONT action value, a default handler is called. It's behavior is as follow: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2206 * - if the message is an answer, it is discarded. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2207 * - if the message is a request, it is passed again to the routing stack, and marked as non-local handling. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2208 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2209 * RETURN VALUE: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2210 * 0 : The callback executed successfully and updated *action appropriately. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2211 * !0 : standard errors. In case of error, the message is discarded. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2212 */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2213 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2214 /* This structure represents a handler for a registered callback, allowing its de-registration */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2215 struct disp_hdl; |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2216 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2217 /* |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2218 * FUNCTION: fd_disp_register |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2219 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2220 * PARAMETERS: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2221 * cb : The callback function to register (see dispatch_callback description above). |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2222 * how : How the callback must be registered. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2223 * when : Values that must match, depending on the how argument. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2224 * handle : On success, a handler to the registered callback is stored here if not NULL. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2225 * This handler can be used to unregister the cb. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2226 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2227 * DESCRIPTION: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2228 * Register a new callback to handle messages delivered locally. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2229 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2230 * RETURN VALUE: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2231 * 0 : The callback is registered. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2232 * EINVAL : A parameter is invalid. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2233 * ENOMEM : Not enough memory to complete the operation |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2234 */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2235 int fd_disp_register ( int (*cb)( struct msg **, struct avp *, struct session *, enum disp_action *), |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2236 enum disp_how how, struct disp_when * when, struct disp_hdl ** handle ); |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2237 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2238 /* |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2239 * FUNCTION: fd_disp_unregister |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2240 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2241 * PARAMETERS: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2242 * handle : Location of the handle of the callback that must be unregistered. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2243 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2244 * DESCRIPTION: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2245 * Removes a callback previously registered by fd_disp_register. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2246 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2247 * RETURN VALUE: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2248 * 0 : The callback is unregistered. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2249 * EINVAL : A parameter is invalid. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2250 */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2251 int fd_disp_unregister ( struct disp_hdl ** handle ); |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2252 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2253 /* |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2254 * FUNCTION: fd_msg_dispatch |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2255 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2256 * PARAMETERS: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2257 * msg : A msg object that have already been fd_msg_parse_dict. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2258 * session : The session corresponding to this object, if any. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2259 * action : Upon return, the action that must be taken on the message |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2260 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2261 * DESCRIPTION: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2262 * Call all handlers registered for a given message. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2263 * The session must have already been resolved on entry. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2264 * The msg pointed may be updated during this process. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2265 * Upon return, the action parameter points to what must be done next. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2266 * |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2267 * RETURN VALUE: |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2268 * 0 : Success. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2269 * EINVAL : A parameter is invalid. |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2270 * (other errors) |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2271 */ |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2272 int fd_msg_dispatch ( struct msg ** msg, struct session * session, enum disp_action *action ); |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2273 |
|
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2274 |
| 0 | 2275 |
| 2276 /*============================================================*/ | |
| 2277 /* MESSAGE QUEUES */ | |
| 2278 /*============================================================*/ | |
| 2279 | |
| 2280 /* Management of queues of messages */ | |
| 2281 | |
| 2282 /* A message queue is an opaque object */ | |
| 2283 struct mqueue; | |
| 2284 | |
| 2285 /* | |
| 2286 * FUNCTION: fd_mq_new | |
| 2287 * | |
| 2288 * PARAMETERS: | |
| 2289 * queue : Upon success, a pointer to the new message queue is saved here. | |
| 2290 * | |
| 2291 * DESCRIPTION: | |
| 2292 * Create a new empty message queue. | |
| 2293 * | |
| 2294 * RETURN VALUE : | |
| 2295 * 0 : The message queue has been initialized successfully. | |
| 2296 * EINVAL : The parameter is invalid. | |
| 2297 * ENOMEM : Not enough memory to complete the creation. | |
| 2298 */ | |
| 2299 int fd_mq_new ( struct mqueue ** queue ); | |
| 2300 | |
| 2301 /* | |
| 2302 * FUNCTION: fd_mq_del | |
| 2303 * | |
| 2304 * PARAMETERS: | |
| 2305 * queue : Pointer to an empty message queue to delete. | |
| 2306 * | |
| 2307 * DESCRIPTION: | |
| 2308 * Destroys a message queue. This is only possible if no thread is waiting for a message, | |
| 2309 * and the queue is empty. | |
| 2310 * | |
| 2311 * RETURN VALUE: | |
| 2312 * 0 : The message queue has been destroyed successfully. | |
| 2313 * EINVAL : The parameter is invalid. | |
| 2314 */ | |
| 2315 int fd_mq_del ( struct mqueue ** queue ); | |
| 2316 | |
| 2317 /* | |
| 2318 * FUNCTION: fd_mq_length | |
| 2319 * | |
| 2320 * PARAMETERS: | |
| 2321 * queue : The queue from which to retrieve the length. | |
| 2322 * length : Upon success, the current number of messages in the queue is stored here. | |
| 2323 * | |
| 2324 * DESCRIPTION: | |
| 2325 * Retrieve the number of messages pending in a queue. | |
| 2326 * | |
| 2327 * RETURN VALUE: | |
| 2328 * 0 : The length of the queue has been written. | |
| 2329 * EINVAL : A parameter is invalid. | |
| 2330 */ | |
| 2331 int fd_mq_length ( struct mqueue * queue, int * length ); | |
| 2332 int fd_mq_length_noerr ( struct mqueue * queue ); /* alternate with no error checking */ | |
| 2333 | |
| 2334 /* | |
| 2335 * FUNCTION: fd_mq_setthrhd | |
| 2336 * | |
| 2337 * PARAMETERS: | |
| 2338 * queue : The queue for which the thresholds are being set. | |
| 2339 * data : An opaque pointer that is passed to h_cb and l_cb callbacks. | |
| 2340 * high : The high-level threshold. If the number of elements in the queue increase to this value, h_cb is called. | |
| 2341 * h_cb : if not NULL, a callback to call when the queue lengh is bigger than "high". | |
| 2342 * low : The low-level threshold. Must be < high. | |
| 2343 * l_cb : If the number of elements decrease to low, this callback is called. | |
| 2344 * | |
| 2345 * DESCRIPTION: | |
| 2346 * This function allows to adjust the number of producer / consumer threads of a queue. | |
| 2347 * If the consumer are slower than the producers, the number of messages in the queue increase. | |
| 2348 * By setting a "high" value, we allow a callback to be called when this number is too high. | |
| 2349 * The typical use would be to create an additional consumer thread in this callback. | |
| 2350 * If the queue continues to grow, the callback will be called again when the length is 2 * high, then 3*high, ... N * high | |
| 2351 * (the callback itself may implement a limit on the number of consumers that can be created) | |
| 2352 * When the queue starts to decrease, and the number of elements go under ((N - 1) * high + low, the l_cb callback is called | |
| 2353 * and would typially stop one of the consumer threads. If the queue continue to reduce, l_cb is again called at (N-2)*high + low, | |
| 2354 * and so on. | |
| 2355 * | |
| 2356 * Since there is no destructor for the data pointer, if cleanup operations are required, they should be performed in | |
| 2357 * l_cb when the length of the queue is becoming < low. | |
| 2358 * | |
| 2359 * Note that the callbacks are called synchronously, during fd_mq_post or fd_mq_get. Their operation should be quick. | |
| 2360 * | |
| 2361 * RETURN VALUE: | |
| 2362 * 0 : The thresholds have been set | |
| 2363 * EINVAL : A parameter is invalid. | |
| 2364 */ | |
| 2365 int fd_mq_setthrhd ( struct mqueue * queue, void * data, uint16_t high, void (*h_cb)(struct mqueue *, void **), uint16_t low, void (*l_cb)(struct mqueue *, void **) ); | |
| 2366 | |
| 2367 /* | |
| 2368 * FUNCTION: fd_mq_post | |
| 2369 * | |
| 2370 * PARAMETERS: | |
| 2371 * queue : The queue in which the message must be posted. | |
| 2372 * msg : The message that is put in the queue. | |
| 2373 * | |
| 2374 * DESCRIPTION: | |
| 2375 * A message is added in a queue. Messages are retrieved from the queue (in FIFO order) | |
| 2376 * with the fd_mq_get, fd_mq_tryget, or fd_mq_timedget functions. | |
| 2377 * | |
| 2378 * RETURN VALUE: | |
| 2379 * 0 : The message is queued. | |
| 2380 * EINVAL : A parameter is invalid. | |
| 2381 * ENOMEM : Not enough memory to complete the operation. | |
| 2382 */ | |
| 2383 int fd_mq_post ( struct mqueue * queue, struct msg ** msg ); | |
| 2384 | |
| 2385 /* | |
| 2386 * FUNCTION: fd_mq_get | |
| 2387 * | |
| 2388 * PARAMETERS: | |
| 2389 * queue : The queue from which the message must be retrieved. | |
| 2390 * msg : On return, the first message of the queue is stored here. | |
| 2391 * | |
| 2392 * DESCRIPTION: | |
| 2393 * This function retrieves a message from a queue. If the queue is empty, the function will block the | |
| 2394 * thread until a new message is posted to the queue, or until the thread is canceled (in which case the | |
| 2395 * function does not return). | |
| 2396 * | |
| 2397 * RETURN VALUE: | |
| 2398 * 0 : A new message has been retrieved. | |
| 2399 * EINVAL : A parameter is invalid. | |
| 2400 */ | |
| 2401 int fd_mq_get ( struct mqueue * queue, struct msg ** msg ); | |
| 2402 | |
| 2403 /* | |
| 2404 * FUNCTION: fd_mq_tryget | |
| 2405 * | |
| 2406 * PARAMETERS: | |
| 2407 * queue : The queue from which the message must be retrieved. | |
| 2408 * msg : On return, the message is stored here. | |
| 2409 * | |
| 2410 * DESCRIPTION: | |
| 2411 * This function is similar to fd_mq_get, except that it will not block if | |
| 2412 * the queue is empty, but return EWOULDBLOCK instead. | |
| 2413 * | |
| 2414 * RETURN VALUE: | |
| 2415 * 0 : A new message has been retrieved. | |
| 2416 * EINVAL : A parameter is invalid. | |
| 2417 * EWOULDBLOCK : The queue was empty. | |
| 2418 */ | |
| 2419 int fd_mq_tryget ( struct mqueue * queue, struct msg ** msg ); | |
| 2420 | |
| 2421 /* | |
| 2422 * FUNCTION: fd_mq_timedget | |
| 2423 * | |
| 2424 * PARAMETERS: | |
| 2425 * queue : The queue from which the message must be retrieved. | |
| 2426 * msg : On return, the message is stored here. | |
| 2427 * abstime : the absolute time until which we allow waiting for a message. | |
| 2428 * | |
| 2429 * DESCRIPTION: | |
| 2430 * This function is similar to fd_mq_get, except that it will block if the queue is empty | |
| 2431 * only until the absolute time abstime (see pthread_cond_timedwait for + info). | |
| 2432 * If the queue is still empty when the time expires, the function returns ETIMEDOUT | |
| 2433 * | |
| 2434 * RETURN VALUE: | |
| 2435 * 0 : A new message has been retrieved. | |
| 2436 * EINVAL : A parameter is invalid. | |
| 2437 * ETIMEDOUT : The time out has passed and no message has been received. | |
| 2438 */ | |
| 2439 int fd_mq_timedget ( struct mqueue * queue, struct msg ** msg, const struct timespec *abstime ); | |
| 2440 | |
| 2441 #endif /* _LIBFREEDIAMETER_H */ |