addr.h
2.35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
* Copyright (C) 2015 Martine Lenders <mlenders@inf.fu-berlin.de>
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup net_ipv4_addr IPv4 addresses
* @ingroup net_ipv4
* @brief IPv4 address types and helper function
* @{
*
* @file
* @brief IPv6 address type and helper functions definitions
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/
#ifndef NET_IPV4_ADDR_H
#define NET_IPV4_ADDR_H
#include <stdbool.h>
#include <stdint.h>
#include "byteorder.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Maximum length of an IPv4 address as string.
*/
#define IPV4_ADDR_MAX_STR_LEN (sizeof("255.255.255.255"))
/**
* @brief Data type to represent an IPv4 address.
*/
typedef union {
uint8_t u8[4]; /**< as 4 8-bit unsigned integer */
network_uint32_t u32; /**< as 32-bit unsigned integer */
} ipv4_addr_t;
/**
* @brief Checks if two IPv4 addresses are equal.
*
* @param[in] a An IPv4 address.
* @param[in] b Another IPv4 address.
*
* @return true, if @p a and @p b are equal
* @return false, otherwise.
*/
static inline bool ipv4_addr_equal(ipv4_addr_t *a, ipv4_addr_t *b)
{
return (a->u32.u32 == b->u32.u32);
}
/**
* @brief Converts an IPv4 address to its string representation
*
* @param[out] result The resulting string representation of at least
* @ref IPV4_ADDR_MAX_STR_LEN.
* @param[in] addr An IPv4 address
* @param[in] result_len Length of @p result
*
* @return @p result, on success
* @return NULL, if @p result_len was lesser than IPV4_ADDR_MAX_STR_LEN
* @return NULL, if @p result or @p addr was NULL
*/
char *ipv4_addr_to_str(char *result, const ipv4_addr_t *addr, uint8_t result_len);
/**
* @brief Converts an IPv4 address string representation to a byte-represented
* IPv4 address
*
* @param[in] result The resulting byte representation
* @param[in] addr An IPv4 address string representation
*
* @return @p result, on success
* @return NULL, if @p addr was malformed
* @return NULL, if @p result or @p addr was NULL
*/
ipv4_addr_t *ipv4_addr_from_str(ipv4_addr_t *result, const char *addr);
#ifdef __cplusplus
}
#endif
#endif /* NET_IPV4_ADDR_H */
/** @} */