]> arthur.barton.de Git - ngircd-alex.git/blob - src/ipaddr/ng_ipaddr.h
Add Doxygen @file documentation to each source and header file
[ngircd-alex.git] / src / ipaddr / ng_ipaddr.h
1 /*
2  * (c) 2008 Florian Westphal <fw@strlen.de>, public domain.
3  */
4
5 #ifndef NG_IPADDR_HDR
6 #define NG_IPADDR_HDR
7 #include "portab.h"
8
9 /**
10  * @file
11  * Functions for AF_ agnostic ipv4/ipv6 handling (header).
12  */
13
14 #include <assert.h>
15 #include <sys/socket.h>
16 #include <netinet/in.h>
17
18 #ifdef HAVE_ARPA_INET_H
19 # include <arpa/inet.h>
20 #else
21 # define PF_INET AF_INET
22 #endif
23
24
25 #ifdef WANT_IPV6
26 #define NG_INET_ADDRSTRLEN      INET6_ADDRSTRLEN
27 #else
28 #define NG_INET_ADDRSTRLEN      16
29 #endif
30
31
32 #ifdef WANT_IPV6
33 typedef union {
34         struct sockaddr sa;
35         struct sockaddr_in sin4;
36         struct sockaddr_in6 sin6;
37 } ng_ipaddr_t;
38 #else
39 /* assume compiler can't deal with typedef struct {... */
40 struct NG_IP_ADDR_DONTUSE {
41         struct sockaddr_in sin4;
42 };
43 typedef struct NG_IP_ADDR_DONTUSE ng_ipaddr_t;
44 #endif
45
46
47 static inline int
48 ng_ipaddr_af(const ng_ipaddr_t *a)
49 {
50 #ifdef WANT_IPV6
51         return a->sa.sa_family;
52 #else
53         assert(a->sin4.sin_family == 0 || a->sin4.sin_family == AF_INET);
54         return a->sin4.sin_family;
55 #endif
56 }
57
58
59 static inline socklen_t
60 ng_ipaddr_salen(const ng_ipaddr_t *a)
61 {
62 #ifdef WANT_IPV6
63         assert(a->sa.sa_family == AF_INET || a->sa.sa_family == AF_INET6);
64         if (a->sa.sa_family == AF_INET6)
65                 return (socklen_t)sizeof(a->sin6);
66 #endif
67         assert(a->sin4.sin_family == AF_INET);
68         return (socklen_t)sizeof(a->sin4);
69 }
70
71
72 static inline UINT16
73 ng_ipaddr_getport(const ng_ipaddr_t *a)
74 {
75 #ifdef WANT_IPV6
76         int af = a->sa.sa_family;
77
78         assert(af == AF_INET || af == AF_INET6);
79
80         if (af == AF_INET6)
81                 return ntohs(a->sin6.sin6_port);
82 #endif /* WANT_IPV6 */
83         assert(a->sin4.sin_family == AF_INET);
84         return ntohs(a->sin4.sin_port);
85 }
86
87 /*
88  * init a ng_ipaddr_t object.
89  * @param addr: pointer to ng_ipaddr_t to initialize.
90  * @param ip_str: ip address in dotted-decimal (ipv4) or hexadecimal (ipv6) notation
91  * @param port: transport layer port number to use.
92  */
93 GLOBAL bool ng_ipaddr_init PARAMS((ng_ipaddr_t *addr, const char *ip_str, UINT16 port));
94
95 /* set sin4/sin6_port, depending on a->sa_family */
96 GLOBAL void ng_ipaddr_setport PARAMS((ng_ipaddr_t *a, UINT16 port));
97
98 /* return true if a and b have the same IP address. If a and b have different AF, return false. */
99 GLOBAL bool ng_ipaddr_ipequal PARAMS((const ng_ipaddr_t *a, const ng_ipaddr_t *b));
100
101
102 #ifdef WANT_IPV6
103 /* convert struct sockaddr to string, returns pointer to static buffer */
104 GLOBAL const char *ng_ipaddr_tostr PARAMS((const ng_ipaddr_t *addr));
105
106 /* convert struct sockaddr to string. dest must be NG_INET_ADDRSTRLEN bytes long */
107 GLOBAL bool ng_ipaddr_tostr_r PARAMS((const ng_ipaddr_t *addr, char *dest));
108 #else
109 static inline const char*
110 ng_ipaddr_tostr(const ng_ipaddr_t *addr)
111 {
112         return inet_ntoa(addr->sin4.sin_addr);
113 }
114
115 static inline bool
116 ng_ipaddr_tostr_r(const ng_ipaddr_t *addr, char *d)
117 {
118         strlcpy(d, inet_ntoa(addr->sin4.sin_addr), NG_INET_ADDRSTRLEN);
119         return true;
120 }
121 #endif
122 #endif
123
124 /* -eof- */