New module-specific HUP, and find without linking
[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 void fr_request_from_reply(RADIUS_PACKET *request,
34                              const RADIUS_PACKET *reply);
35 int fr_socket(fr_ipaddr_t *ipaddr, int port);
36
37 typedef struct fr_packet_list_t fr_packet_list_t;
38
39 fr_packet_list_t *fr_packet_list_create(int alloc_id);
40 void fr_packet_list_free(fr_packet_list_t *pl);
41 int fr_packet_list_insert(fr_packet_list_t *pl,
42                             RADIUS_PACKET **request_p);
43
44 RADIUS_PACKET **fr_packet_list_find(fr_packet_list_t *pl,
45                                       RADIUS_PACKET *request);
46 RADIUS_PACKET **fr_packet_list_find_byreply(fr_packet_list_t *pl,
47                                               RADIUS_PACKET *reply);
48 RADIUS_PACKET **fr_packet_list_yank(fr_packet_list_t *pl,
49                                       RADIUS_PACKET *request);
50 int fr_packet_list_num_elements(fr_packet_list_t *pl);
51 int fr_packet_list_id_alloc(fr_packet_list_t *pl,
52                               RADIUS_PACKET *request);
53 int fr_packet_list_id_free(fr_packet_list_t *pl,
54                              RADIUS_PACKET *request);
55 int fr_packet_list_socket_add(fr_packet_list_t *pl, int sockfd);
56 int fr_packet_list_socket_remove(fr_packet_list_t *pl, int sockfd);
57 int fr_packet_list_walk(fr_packet_list_t *pl, void *ctx,
58                           fr_hash_table_walk_t callback);
59 int fr_packet_list_fd_set(fr_packet_list_t *pl, fd_set *set);
60 RADIUS_PACKET *fr_packet_list_recv(fr_packet_list_t *pl, fd_set *set);
61
62 int fr_packet_list_num_incoming(fr_packet_list_t *pl);
63 int fr_packet_list_num_outgoing(fr_packet_list_t *pl);
64
65 /*
66  *      "find" returns a pointer to the RADIUS_PACKET* member in the
67  *      caller's structure.  In order to get the pointer to the *top*
68  *      of the caller's structure, you have to subtract the offset to
69  *      the member from the returned pointer, and cast it to the
70  *      required type.
71  */
72 # define fr_packet2myptr(TYPE, MEMBER, PTR) (TYPE *) (((char *)PTR) - offsetof(TYPE, MEMBER))
73 #endif /* FR_PACKET_H */