a700541082169f22c4445c97d840c6d6469c576b
[freeradius.git] / src / include / packet.h
1 #ifndef FR_PACKET_H
2 #define FR_PACKET_H
3
4 /*
5  * packet.h     Structures and prototypes
6  *              for packet manipulation
7  *
8  * Version:     $Id$
9  *
10  *   This program is free software; you can redistribute it and/or modify
11  *   it under the terms of the GNU General Public License as published by
12  *   the Free Software Foundation; either version 2 of the License, or
13  *   (at your option) any later version.
14  *
15  *   This program is distributed in the hope that it will be useful,
16  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
17  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  *   GNU General Public License for more details.
19  *
20  *   You should have received a copy of the GNU General Public License
21  *   along with this program; if not, write to the Free Software
22  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23  *
24  * Copyright 2001,2002,2003,2004,2005,2006  The FreeRADIUS server project
25  */
26
27 #include <freeradius-devel/ident.h>
28 RCSIDH(packet_h, "$Id$")
29
30 uint32_t fr_request_packet_hash(const RADIUS_PACKET *packet);
31 uint32_t fr_reply_packet_hash(const RADIUS_PACKET *packet);
32 int fr_packet_cmp(const RADIUS_PACKET *a, const RADIUS_PACKET *b);
33 int fr_inaddr_any(fr_ipaddr_t *ipaddr);
34 void fr_request_from_reply(RADIUS_PACKET *request,
35                              const RADIUS_PACKET *reply);
36 int fr_socket(fr_ipaddr_t *ipaddr, int port);
37 int fr_nonblock(int fd);
38
39 typedef struct fr_packet_list_t fr_packet_list_t;
40
41 fr_packet_list_t *fr_packet_list_create(int alloc_id);
42 void fr_packet_list_free(fr_packet_list_t *pl);
43 int fr_packet_list_insert(fr_packet_list_t *pl,
44                             RADIUS_PACKET **request_p);
45
46 RADIUS_PACKET **fr_packet_list_find(fr_packet_list_t *pl,
47                                       RADIUS_PACKET *request);
48 RADIUS_PACKET **fr_packet_list_find_byreply(fr_packet_list_t *pl,
49                                               RADIUS_PACKET *reply);
50 RADIUS_PACKET **fr_packet_list_yank(fr_packet_list_t *pl,
51                                       RADIUS_PACKET *request);
52 int fr_packet_list_num_elements(fr_packet_list_t *pl);
53 int fr_packet_list_id_alloc(fr_packet_list_t *pl, int proto,
54                             RADIUS_PACKET *request, void **pctx);
55 int fr_packet_list_id_free(fr_packet_list_t *pl,
56                              RADIUS_PACKET *request);
57 int fr_packet_list_socket_add(fr_packet_list_t *pl, int sockfd, int proto,
58                               fr_ipaddr_t *dst_ipaddr, int dst_port,
59                               void *ctx);
60 int fr_packet_list_socket_remove(fr_packet_list_t *pl, int sockfd,
61                                  void **pctx);
62 int fr_packet_list_socket_freeze(fr_packet_list_t *pl, int sockfd);
63 int fr_packet_list_walk(fr_packet_list_t *pl, void *ctx,
64                           fr_hash_table_walk_t callback);
65 int fr_packet_list_fd_set(fr_packet_list_t *pl, fd_set *set);
66 RADIUS_PACKET *fr_packet_list_recv(fr_packet_list_t *pl, fd_set *set);
67
68 int fr_packet_list_num_incoming(fr_packet_list_t *pl);
69 int fr_packet_list_num_outgoing(fr_packet_list_t *pl);
70
71 /*
72  *      "find" returns a pointer to the RADIUS_PACKET* member in the
73  *      caller's structure.  In order to get the pointer to the *top*
74  *      of the caller's structure, you have to subtract the offset to
75  *      the member from the returned pointer, and cast it to the
76  *      required type.
77  */
78 # define fr_packet2myptr(TYPE, MEMBER, PTR) (TYPE *) (((char *)PTR) - offsetof(TYPE, MEMBER))
79 #endif /* FR_PACKET_H */