libcoap 4.3.2rc2

coap_address.h
Go to the documentation of this file.
1/*
2 * coap_address.h -- representation of network addresses
3 *
4 * Copyright (C) 2010-2011,2015-2016,2022-2023 Olaf Bergmann <bergmann@tzi.org>
5 *
6 * SPDX-License-Identifier: BSD-2-Clause
7 *
8 * This file is part of the CoAP library libcoap. Please see README for terms
9 * of use.
10 */
11
17#ifndef COAP_ADDRESS_H_
18#define COAP_ADDRESS_H_
19
20#include <assert.h>
21#include <stdint.h>
22#include <string.h>
23#include <sys/types.h>
24#include "libcoap.h"
25
26#include "coap3/coap_pdu.h"
27
28#if defined(WITH_LWIP)
29
30#include <lwip/ip_addr.h>
31
32 struct coap_address_t {
33 uint16_t port;
34 ip_addr_t addr;
35};
36
40 COAP_STATIC_INLINE uint16_t
41 coap_address_get_port(const coap_address_t *addr) {
42 return addr->port;
43}
44
48 COAP_STATIC_INLINE void
49 coap_address_set_port(coap_address_t *addr, uint16_t port) {
50 addr->port = port;
51}
52
53#define _coap_address_equals_impl(A, B) \
54 ((A)->port == (B)->port && \
55 (!!ip_addr_cmp(&(A)->addr,&(B)->addr)))
56
57#define _coap_address_isany_impl(A) ip_addr_isany(&(A)->addr)
58
59#define _coap_is_mcast_impl(Address) ip_addr_ismulticast(&(Address)->addr)
60
61#elif defined(WITH_CONTIKI)
62
63#include "uip.h"
64
65 struct coap_address_t {
66 uip_ipaddr_t addr;
67 uint16_t port;
68};
69
73 COAP_STATIC_INLINE uint16_t
74 coap_address_get_port(const coap_address_t *addr) {
75 return uip_ntohs(addr->port);
76}
77
81 COAP_STATIC_INLINE void
82 coap_address_set_port(coap_address_t *addr, uint16_t port) {
83 addr->port = uip_htons(port);
84}
85
86#define _coap_address_equals_impl(A,B) \
87 ((A)->port == (B)->port && \
88 uip_ipaddr_cmp(&((A)->addr),&((B)->addr)))
89
91#define _coap_address_isany_impl(A) 0
92
93#define _coap_is_mcast_impl(Address) uip_is_addr_mcast(&((Address)->addr))
94
95#else /* ! WITH_LWIP && ! WITH_CONTIKI */
96
97#ifdef _WIN32
98#define sa_family_t short
99#endif /* _WIN32 */
100
101#define COAP_UNIX_PATH_MAX (sizeof(struct sockaddr_in6) - sizeof(sa_family_t))
102
103 struct coap_sockaddr_un {
104 sa_family_t sun_family; /* AF_UNIX */
105 char sun_path[COAP_UNIX_PATH_MAX]; /* pathname max 26 with NUL byte */
106};
107
109 struct coap_address_t {
110 socklen_t size;
111 union {
112 struct sockaddr sa;
113 struct sockaddr_in sin;
114 struct sockaddr_in6 sin6;
115 struct coap_sockaddr_un cun; /* CoAP shortened special */
116 } addr;
117};
118
122uint16_t coap_address_get_port(const coap_address_t *addr);
123
127 void coap_address_set_port(coap_address_t *addr, uint16_t port);
128
134 int coap_address_equals(const coap_address_t *a, const coap_address_t *b);
135
136 int _coap_address_isany_impl(const coap_address_t *a);
137#endif /* ! WITH_LWIP && ! WITH_CONTIKI */
138
140 typedef struct coap_addr_info_t {
141 struct coap_addr_info_t *next;
142 coap_uri_scheme_t scheme;
143 coap_proto_t proto;
144 coap_address_t addr;
145} coap_addr_info_t;
146
160uint32_t coap_get_available_scheme_hint_bits(int have_pki_psk, int ws_check,
161 coap_proto_t use_unix_proto);
162
166 typedef enum coap_resolve_type_t {
167 COAP_RESOLVE_TYPE_LOCAL,
168 COAP_RESOLVE_TYPE_REMOTE,
169} coap_resolve_type_t;
170
187 coap_addr_info_t *coap_resolve_address_info(const coap_str_const_t *address,
188 uint16_t port,
189 uint16_t secure_port,
190 uint16_t ws_port,
191 uint16_t ws_secure_port,
192 int ai_hints_flags,
193 int scheme_hint_bits,
194 coap_resolve_type_t type);
195
202 void coap_free_address_info(coap_addr_info_t *info_list);
203
211 void coap_address_init(coap_address_t *addr);
212
224 int coap_address_set_unix_domain(coap_address_t *addr,
225 const uint8_t *host, size_t host_len);
226
227/* Convenience function to copy IPv6 addresses without garbage. */
228#if defined(WITH_LWIP) || defined(WITH_CONTIKI)
229 COAP_STATIC_INLINE void
230 coap_address_copy(coap_address_t *dst, const coap_address_t *src) {
231 memcpy(dst, src, sizeof(coap_address_t));
232}
233#else /* ! WITH_LWIP && ! WITH_CONTIKI */
234 void coap_address_copy(coap_address_t *dst, const coap_address_t *src);
235#endif /* ! WITH_LWIP && ! WITH_CONTIKI */
236
237#if defined(WITH_LWIP) || defined(WITH_CONTIKI)
243 COAP_STATIC_INLINE int
244 coap_address_equals(const coap_address_t *a, const coap_address_t *b) {
245 assert(a);
246 assert(b);
247 return _coap_address_equals_impl(a, b);
248}
249#endif
250
256 COAP_STATIC_INLINE int
257 coap_address_isany(const coap_address_t *a) {
258 assert(a);
259 return _coap_address_isany_impl(a);
260}
261
262#if !defined(WITH_LWIP) && !defined(WITH_CONTIKI)
263
268 int coap_is_mcast(const coap_address_t *a);
269
274 int coap_is_bcast(const coap_address_t *a);
275
280 int coap_is_af_unix(const coap_address_t *a);
281
282#else /* WITH_LWIP || WITH_CONTIKI */
283
288 COAP_STATIC_INLINE int
289 coap_is_mcast(const coap_address_t *a) {
290 return a && _coap_is_mcast_impl(a);
291}
292
297 COAP_STATIC_INLINE int
298 coap_is_af_unix(const coap_address_t *a) {
299 (void)a;
300 return 0;
301}
302
303#endif /* WITH_LWIP || WITH_CONTIKI */
304
305#endif /* COAP_ADDRESS_H_ */
coap_address_isany
COAP_STATIC_INLINE int coap_address_isany(const coap_address_t *a)
Checks if given address object a denotes the wildcard address.
Definition: coap_address.h:257
coap_address_set_port
void coap_address_set_port(coap_address_t *addr, uint16_t port)
Set the port field of addr to port (in host byte order).
Definition: coap_address.c:56
coap_address_set_unix_domain
int coap_address_set_unix_domain(coap_address_t *addr, const uint8_t *host, size_t host_len)
Copy the parsed unix domain host into coap_address_t structure translating %2F into / on the way.
Definition: coap_address.c:258
coap_free_address_info
void coap_free_address_info(coap_addr_info_t *info_list)
Free off the one or more linked sets of coap_addr_info_t returned from coap_resolve_address_info().
Definition: coap_address.c:792
coap_addr_info_t
struct coap_addr_info_t coap_addr_info_t
Resolved addresses information.
coap_is_af_unix
int coap_is_af_unix(const coap_address_t *a)
Checks if given address a denotes a AF_UNIX address.
Definition: coap_address.c:103
coap_is_bcast
int coap_is_bcast(const coap_address_t *a)
Checks if given address a denotes a broadcast address.
Definition: coap_address.c:165
coap_address_init
void coap_address_init(coap_address_t *addr)
Resets the given coap_address_t object addr to its default values.
Definition: coap_address.c:248
coap_is_mcast
int coap_is_mcast(const coap_address_t *a)
Checks if given address a denotes a multicast address.
Definition: coap_address.c:113
coap_resolve_type_t
coap_resolve_type_t
coap_resolve_type_t values
Definition: coap_address.h:166
COAP_RESOLVE_TYPE_LOCAL
@ COAP_RESOLVE_TYPE_LOCAL
local side of session
Definition: coap_address.h:167
COAP_RESOLVE_TYPE_REMOTE
@ COAP_RESOLVE_TYPE_REMOTE
remote side of session
Definition: coap_address.h:168
_coap_address_isany_impl
int _coap_address_isany_impl(const coap_address_t *a)
Definition: coap_address.c:832
coap_address_get_port
uint16_t coap_address_get_port(const coap_address_t *addr)
Returns the port from addr in host byte order.
Definition: coap_address.c:38
coap_get_available_scheme_hint_bits
uint32_t coap_get_available_scheme_hint_bits(int have_pki_psk, int ws_check, coap_proto_t use_unix_proto)
Determine and set up scheme_hint_bits for a server that can be used in a call to coap_resolve_address...
Definition: coap_address.c:307
coap_resolve_address_info
coap_addr_info_t * coap_resolve_address_info(const coap_str_const_t *address, uint16_t port, uint16_t secure_port, uint16_t ws_port, uint16_t ws_secure_port, int ai_hints_flags, int scheme_hint_bits, coap_resolve_type_t type)
Resolve the specified address into a set of coap_address_t that can be used to bind() (local) or conn...
Definition: coap_address.c:379
COAP_UNIX_PATH_MAX
#define COAP_UNIX_PATH_MAX
Definition: coap_address.h:101
coap_address_copy
void coap_address_copy(coap_address_t *dst, const coap_address_t *src)
Definition: coap_address.c:803
coap_address_equals
int coap_address_equals(const coap_address_t *a, const coap_address_t *b)
Compares given address objects a and b.
Definition: coap_address.c:75
coap_pdu.h
Pre-defined constants that reflect defaults for CoAP.
coap_uri_scheme_t
coap_uri_scheme_t
The scheme specifiers.
Definition: coap_uri.h:28
coap_proto_t
coap_proto_t
CoAP protocol types.
Definition: coap_pdu.h:304
libcoap.h
Platform specific header file for CoAP stack.
COAP_STATIC_INLINE
#define COAP_STATIC_INLINE
Definition: libcoap.h:53
coap_addr_info_t
Resolved addresses information.
Definition: coap_address.h:140
coap_addr_info_t::scheme
coap_uri_scheme_t scheme
CoAP scheme to use.
Definition: coap_address.h:142
coap_addr_info_t::proto
coap_proto_t proto
CoAP protocol to use.
Definition: coap_address.h:143
coap_addr_info_t::next
struct coap_addr_info_t * next
Next entry in the chain.
Definition: coap_address.h:141
coap_addr_info_t::addr
coap_address_t addr
The address to connect / bind to.
Definition: coap_address.h:144
coap_address_t
Multi-purpose address abstraction.
Definition: coap_address.h:109
coap_address_t::size
socklen_t size
size of addr
Definition: coap_address.h:110
coap_address_t::sin
struct sockaddr_in sin
Definition: coap_address.h:113
coap_address_t::cun
struct coap_sockaddr_un cun
Definition: coap_address.h:115
coap_address_t::sin6
struct sockaddr_in6 sin6
Definition: coap_address.h:114
coap_address_t::sa
struct sockaddr sa
Definition: coap_address.h:112
coap_address_t::addr
union coap_address_t::@0 addr
coap_sockaddr_un
Definition: coap_address.h:103
coap_sockaddr_un::sun_path
char sun_path[COAP_UNIX_PATH_MAX]
Definition: coap_address.h:105
coap_sockaddr_un::sun_family
sa_family_t sun_family
Definition: coap_address.h:104
coap_str_const_t
CoAP string data definition with const data.
Definition: coap_str.h:46