libcoap 4.3.2rc1
Loading...
Searching...
No Matches
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
32struct coap_address_t {
33 uint16_t port;
34 ip_addr_t addr;
35};
36
40COAP_STATIC_INLINE uint16_t
42 return addr->port;
43}
44
49coap_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
65struct coap_address_t {
66 uip_ipaddr_t addr;
67 uint16_t port;
68};
69
73COAP_STATIC_INLINE uint16_t
75 return uip_ntohs(addr->port);
76}
77
82coap_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
104 sa_family_t sun_family; /* AF_UNIX */
105 char sun_path[COAP_UNIX_PATH_MAX]; /* pathname max 26 with NUL byte */
106};
107
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 */
117};
118
122uint16_t coap_address_get_port(const coap_address_t *addr);
123
127void coap_address_set_port(coap_address_t *addr, uint16_t port);
128
135
137#endif /* ! WITH_LWIP && ! WITH_CONTIKI */
138
140typedef struct 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
170
186 uint16_t port,
187 uint16_t secure_port,
188 int ai_hints_flags,
189 int scheme_hint_bits,
191
199
208
221 const uint8_t *host, size_t host_len);
222
223/* Convenience function to copy IPv6 addresses without garbage. */
224#if defined(WITH_LWIP) || defined(WITH_CONTIKI)
227 memcpy(dst, src, sizeof(coap_address_t));
228}
229#else /* ! WITH_LWIP && ! WITH_CONTIKI */
230void coap_address_copy(coap_address_t *dst, const coap_address_t *src);
231#endif /* ! WITH_LWIP && ! WITH_CONTIKI */
232
233#if defined(WITH_LWIP) || defined(WITH_CONTIKI)
241 assert(a);
242 assert(b);
243 return _coap_address_equals_impl(a, b);
244}
245#endif
246
254 assert(a);
255 return _coap_address_isany_impl(a);
256}
257
258#if !defined(WITH_LWIP) && !defined(WITH_CONTIKI)
259
264int coap_is_mcast(const coap_address_t *a);
265
270int coap_is_bcast(const coap_address_t *a);
271
276int coap_is_af_unix(const coap_address_t *a);
277
278#else /* WITH_LWIP || WITH_CONTIKI */
279
286 return a && _coap_is_mcast_impl(a);
287}
288
295 (void)a;
296 return 0;
297}
298
299#endif /* WITH_LWIP || WITH_CONTIKI */
300
301#endif /* COAP_ADDRESS_H_ */
COAP_STATIC_INLINE int coap_address_isany(const coap_address_t *a)
Checks if given address object a denotes the wildcard address.
void coap_address_set_port(coap_address_t *addr, uint16_t port)
Set the port field of addr to port (in host byte order).
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.
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().
int coap_is_af_unix(const coap_address_t *a)
Checks if given address a denotes a AF_UNIX address.
int coap_is_bcast(const coap_address_t *a)
Checks if given address a denotes a broadcast address.
void coap_address_init(coap_address_t *addr)
Resets the given coap_address_t object addr to its default values.
int coap_is_mcast(const coap_address_t *a)
Checks if given address a denotes a multicast address.
coap_resolve_type_t
coap_resolve_type_t values
@ COAP_RESOLVE_TYPE_LOCAL
local side of session
@ COAP_RESOLVE_TYPE_REMOTE
remote side of session
int _coap_address_isany_impl(const coap_address_t *a)
uint16_t coap_address_get_port(const coap_address_t *addr)
Returns the port from addr in host byte order.
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...
coap_addr_info_t * coap_resolve_address_info(const coap_str_const_t *address, uint16_t port, uint16_t 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...
#define COAP_UNIX_PATH_MAX
void coap_address_copy(coap_address_t *dst, const coap_address_t *src)
int coap_address_equals(const coap_address_t *a, const coap_address_t *b)
Compares given address objects a and b.
Pre-defined constants that reflect defaults for CoAP.
coap_uri_scheme_t
The scheme specifiers.
Definition coap_uri.h:28
coap_proto_t
CoAP protocol types.
Definition coap_pdu.h:304
Platform specific header file for CoAP stack.
#define COAP_STATIC_INLINE
Definition libcoap.h:53
Resolved addresses information.
coap_uri_scheme_t scheme
CoAP scheme to use.
coap_proto_t proto
CoAP protocol to use.
struct coap_addr_info_t * next
Next entry in the chain.
coap_address_t addr
The address to connect / bind to.
Multi-purpose address abstraction.
socklen_t size
size of addr
struct sockaddr_in sin
struct coap_sockaddr_un cun
struct sockaddr_in6 sin6
struct sockaddr sa
union coap_address_t::@0 addr
char sun_path[COAP_UNIX_PATH_MAX]
sa_family_t sun_family
CoAP string data definition with const data.
Definition coap_str.h:46