GNUnet  0.20.0
gnunet_network_lib.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2009-2013, 2022 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
39 #ifndef GNUNET_NETWORK_LIB_H
40 #define GNUNET_NETWORK_LIB_H
41 
42 #include "gnunet_common.h"
43 #ifdef __cplusplus
44 extern "C"
45 {
46 #if 0 /* keep Emacsens' auto-indent happy */
47 }
48 #endif
49 #endif
50 
51 //#ifdef HAVE_SYS_SELECT_H
52 /*
53  * Include "sys/select.h" because it is required to use
54  * "fd_set" in "struct GNUNET_NETWORK_FDSet"!
55  */
56 
57 #include <sys/select.h>
58 //#endif
59 #ifdef HAVE_SYS_SOCKET_H
60 #include <sys/socket.h>
61 #endif
62 #ifdef HAVE_SYS_UN_H
63 #include <sys/un.h>
64 #endif
65 
70 
71 
76 {
80  int nsds;
81 
85  fd_set sds;
86 
87 };
88 
89 #include "gnunet_disk_lib.h"
90 #include "gnunet_time_lib.h"
91 
99 GNUNET_NETWORK_test_pf (int pf);
100 
101 
111 char *
112 GNUNET_NETWORK_shorten_unixpath (char *unixpath);
113 
114 
124 void
125 GNUNET_NETWORK_unix_precheck (const struct sockaddr_un *un);
126 
127 
138 struct GNUNET_NETWORK_Handle *
140  struct sockaddr *address,
141  socklen_t *address_len);
142 
143 
150 struct GNUNET_NETWORK_Handle *
152 
153 
163  int doBlock);
164 
165 
176  const struct sockaddr *address,
177  socklen_t address_len);
178 
187 
188 
194 void
196 
197 
208  const struct sockaddr *address,
209  socklen_t address_len);
210 
211 
224  int level,
225  int optname,
226  void *optval,
227  socklen_t *optlen);
228 
229 
239  int backlog);
240 
241 
248 ssize_t
250  GNUNET_NETWORK_Handle *desc);
251 
252 
263 ssize_t
265  void *buffer,
266  size_t length,
267  struct sockaddr *src_addr,
268  socklen_t *addrlen);
269 
270 
279 ssize_t
281  void *buffer,
282  size_t length);
283 
284 
294 int
296  struct GNUNET_NETWORK_FDSet *wfds,
297  struct GNUNET_NETWORK_FDSet *efds,
299 
300 
309 ssize_t
311  const void *buffer,
312  size_t length);
313 
314 
326 ssize_t
328  const void *message,
329  size_t length,
330  const struct sockaddr *dest_addr,
331  socklen_t dest_len);
332 
333 
344 int
346  int level,
347  int option_name,
348  const void *option_value,
349  socklen_t option_len);
350 
351 
361  int how);
362 
363 
375 
376 
387 struct GNUNET_NETWORK_Handle *
388 GNUNET_NETWORK_socket_create (int domain,
389  int type,
390  int protocol);
391 
392 
398 void
400 
401 
408 void
410  const struct GNUNET_NETWORK_Handle *desc);
411 
412 
420 int
422  const struct GNUNET_NETWORK_Handle *desc);
423 
424 
431 void
433  const struct GNUNET_NETWORK_FDSet *src);
434 
435 
442 void
444  const struct GNUNET_NETWORK_FDSet *from);
445 
446 
453 int
454 GNUNET_NETWORK_get_fd (const struct GNUNET_NETWORK_Handle *desc);
455 
456 
463 struct sockaddr*
465 
466 
473 socklen_t
475 
476 
484 void
486  const fd_set *from,
487  int nfds);
488 
489 
496 void
498  int nfd);
499 
500 
508 int
510  int nfd);
511 
512 
519 void
521  const struct GNUNET_DISK_FileHandle *h);
522 
523 
531 void
533  const struct GNUNET_DISK_FileHandle *h);
534 
535 
543 int
545  const struct GNUNET_DISK_FileHandle *h);
546 
547 
555 int
557  const struct GNUNET_NETWORK_FDSet *fds2);
558 
559 
565 struct GNUNET_NETWORK_FDSet *
567 
568 
574 void
576 
577 
585 int
586 GNUNET_NETWORK_test_port_free (int ipproto,
587  uint16_t port);
588 
589 
590 #if 0 /* keep Emacsens' auto-indent happy */
591 {
592 #endif
593 #ifdef __cplusplus
594 }
595 #endif
596 
597 #endif /* GNUNET_NETWORK_LIB_H */
598  /* end of group */
600  /* end of group addition */
602  /* end of group addition */
static struct GNUNET_TIME_Relative timeout
Desired timeout for the lookup (default is no timeout).
Definition: gnunet-abd.c:61
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
static uint16_t port
Port number.
Definition: gnunet-bcd.c:147
static char * address
GNS address for this phone.
commonly used definitions; globals in this file are exempt from the rule that the module name ("commo...
Disk IO APIs.
Functions related to time.
GNUNET_GenericReturnValue
Named constants for return values.
struct sockaddr * GNUNET_NETWORK_get_addr(const struct GNUNET_NETWORK_Handle *desc)
Return the sockaddr for this network handle.
Definition: network.c:1014
void GNUNET_NETWORK_fdset_handle_set_first(struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_DISK_FileHandle *h)
Add a file handle to the fd set On W32: ensure that the handle is first in the array.
Definition: network.c:1114
enum GNUNET_GenericReturnValue GNUNET_NETWORK_socket_getsockopt(const struct GNUNET_NETWORK_Handle *desc, int level, int optname, void *optval, socklen_t *optlen)
Get socket options.
Definition: network.c:627
struct GNUNET_NETWORK_FDSet * GNUNET_NETWORK_fdset_create(void)
Creates an fd set.
Definition: network.c:1171
void GNUNET_NETWORK_fdset_zero(struct GNUNET_NETWORK_FDSet *fds)
Reset FD set (clears all file descriptors).
Definition: network.c:918
enum GNUNET_GenericReturnValue GNUNET_NETWORK_socket_close(struct GNUNET_NETWORK_Handle *desc)
Close a socket.
Definition: network.c:509
void GNUNET_NETWORK_fdset_destroy(struct GNUNET_NETWORK_FDSet *fds)
Releases the associated memory of an fd set.
Definition: network.c:1187
socklen_t GNUNET_NETWORK_get_addrlen(const struct GNUNET_NETWORK_Handle *desc)
Return sockaddr length for this network handle.
Definition: network.c:1027
int GNUNET_NETWORK_get_fd(const struct GNUNET_NETWORK_Handle *desc)
Return file descriptor for this network handle.
Definition: network.c:1001
void GNUNET_NETWORK_fdset_copy_native(struct GNUNET_NETWORK_FDSet *to, const fd_set *from, int nfds)
Copy a native fd set into the GNUnet representation.
Definition: network.c:1041
int GNUNET_NETWORK_test_port_free(int ipproto, uint16_t port)
Test if the given port is available.
Definition: network.c:1201
int GNUNET_NETWORK_fdset_overlap(const struct GNUNET_NETWORK_FDSet *fds1, const struct GNUNET_NETWORK_FDSet *fds2)
Checks if two fd sets overlap.
Definition: network.c:1145
ssize_t GNUNET_NETWORK_socket_recv(const struct GNUNET_NETWORK_Handle *desc, void *buffer, size_t length)
Read data from a connected socket (always non-blocking).
Definition: network.c:717
ssize_t GNUNET_NETWORK_socket_recvfrom(const struct GNUNET_NETWORK_Handle *desc, void *buffer, size_t length, struct sockaddr *src_addr, socklen_t *addrlen)
Read data from a socket (always non-blocking).
Definition: network.c:688
void GNUNET_NETWORK_fdset_add(struct GNUNET_NETWORK_FDSet *dst, const struct GNUNET_NETWORK_FDSet *src)
Add one fd set to another (computes the union).
Definition: network.c:965
enum GNUNET_GenericReturnValue GNUNET_NETWORK_socket_set_blocking(struct GNUNET_NETWORK_Handle *fd, int doBlock)
Set if a socket should use blocking or non-blocking IO.
Definition: network.c:225
void GNUNET_NETWORK_fdset_set_native(struct GNUNET_NETWORK_FDSet *to, int nfd)
Set a native fd in a set.
Definition: network.c:1058
void GNUNET_NETWORK_fdset_copy(struct GNUNET_NETWORK_FDSet *to, const struct GNUNET_NETWORK_FDSet *from)
Copy one fd set to another.
Definition: network.c:985
enum GNUNET_GenericReturnValue GNUNET_NETWORK_socket_connect(const struct GNUNET_NETWORK_Handle *desc, const struct sockaddr *address, socklen_t address_len)
Connect a socket to some remote address.
Definition: network.c:602
struct GNUNET_NETWORK_Handle * GNUNET_NETWORK_socket_accept(const struct GNUNET_NETWORK_Handle *desc, struct sockaddr *address, socklen_t *address_len)
Accept a new connection on a socket.
Definition: network.c:393
ssize_t GNUNET_NETWORK_socket_recvfrom_amount(const struct GNUNET_NETWORK_Handle *desc)
How much data is available to be read on this descriptor?
Definition: network.c:671
int GNUNET_NETWORK_fdset_test_native(const struct GNUNET_NETWORK_FDSet *to, int nfd)
Test native fd in a set.
Definition: network.c:1076
struct GNUNET_NETWORK_Handle * GNUNET_NETWORK_socket_create(int domain, int type, int protocol)
Create a new socket.
Definition: network.c:833
void GNUNET_NETWORK_fdset_set(struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_NETWORK_Handle *desc)
Add a socket to the FD set.
Definition: network.c:932
void GNUNET_NETWORK_socket_free_memory_only_(struct GNUNET_NETWORK_Handle *desc)
Only free memory of a socket, keep the file descriptor untouched.
Definition: network.c:566
char * GNUNET_NETWORK_shorten_unixpath(char *unixpath)
Given a unixpath that is too long (larger than UNIX_PATH_MAX), shorten it to an acceptable length whi...
Definition: network.c:144
ssize_t GNUNET_NETWORK_socket_send(const struct GNUNET_NETWORK_Handle *desc, const void *buffer, size_t length)
Send data (always non-blocking).
Definition: network.c:738
enum GNUNET_GenericReturnValue GNUNET_NETWORK_test_pf(int pf)
Test if the given protocol family is supported by this system.
Definition: network.c:80
enum GNUNET_GenericReturnValue GNUNET_NETWORK_socket_bind(struct GNUNET_NETWORK_Handle *desc, const struct sockaddr *address, socklen_t address_len)
Bind a socket to a particular address.
Definition: network.c:440
enum GNUNET_GenericReturnValue GNUNET_NETWORK_socket_listen(const struct GNUNET_NETWORK_Handle *desc, int backlog)
Listen on a socket.
Definition: network.c:652
void GNUNET_NETWORK_unix_precheck(const struct sockaddr_un *un)
If services crash, they can leave a unix domain socket file on the disk.
Definition: network.c:179
int GNUNET_NETWORK_fdset_handle_isset(const struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_DISK_FileHandle *h)
Check if a file handle is part of an fd set.
Definition: network.c:1129
int GNUNET_NETWORK_socket_select(struct GNUNET_NETWORK_FDSet *rfds, struct GNUNET_NETWORK_FDSet *wfds, struct GNUNET_NETWORK_FDSet *efds, struct GNUNET_TIME_Relative timeout)
Check if sockets meet certain conditions.
Definition: network.c:1261
enum GNUNET_GenericReturnValue GNUNET_NETWORK_socket_shutdown(struct GNUNET_NETWORK_Handle *desc, int how)
Shut down socket operations.
Definition: network.c:861
int GNUNET_NETWORK_socket_setsockopt(struct GNUNET_NETWORK_Handle *fd, int level, int option_name, const void *option_value, socklen_t option_len)
Set socket option.
Definition: network.c:806
ssize_t GNUNET_NETWORK_socket_sendto(const struct GNUNET_NETWORK_Handle *desc, const void *message, size_t length, const struct sockaddr *dest_addr, socklen_t dest_len)
Send data to a particular destination (always non-blocking).
Definition: network.c:772
int GNUNET_NETWORK_fdset_isset(const struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_NETWORK_Handle *desc)
Check whether a socket is part of the fd set.
Definition: network.c:950
enum GNUNET_GenericReturnValue GNUNET_NETWORK_socket_disable_corking(struct GNUNET_NETWORK_Handle *desc)
Disable the "CORK" feature for communication with the given socket, forcing the OS to immediately flu...
Definition: network.c:882
void GNUNET_NETWORK_fdset_handle_set(struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_DISK_FileHandle *h)
Add a file handle to the fd set.
Definition: network.c:1092
struct GNUNET_NETWORK_Handle * GNUNET_NETWORK_socket_box_native(int fd)
Box a native socket (and check that it is a socket).
Definition: network.c:580
Handle used to access files (and pipes).
collection of IO descriptors
int nsds
Maximum number of any socket descriptor in the set (plus one)
fd_set sds
Bitset with the descriptors.
handle to a socket
Definition: network.c:54
socklen_t addrlen
Number of bytes in addr.
Definition: network.c:70
Time for relative time used by GNUnet, in microseconds.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model