1/*
2 Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
3
4 This file is part of libzmq, the ZeroMQ core engine in C++.
5
6 libzmq is free software; you can redistribute it and/or modify it under
7 the terms of the GNU Lesser General Public License (LGPL) as published
8 by the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
10
11 As a special exception, the Contributors give you permission to link
12 this library with independent modules to produce an executable,
13 regardless of the license terms of these independent modules, and to
14 copy and distribute the resulting executable under terms of your choice,
15 provided that you also meet, for each linked independent module, the
16 terms and conditions of the license of that module. An independent
17 module is a module which is not derived from or based on this library.
18 If you modify this library, you must extend this exception to your
19 version of the library.
20
21 libzmq is distributed in the hope that it will be useful, but WITHOUT
22 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
23 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
24 License for more details.
25
26 You should have received a copy of the GNU Lesser General Public License
27 along with this program. If not, see <http://www.gnu.org/licenses/>.
28*/
29
30#ifndef __ZMQ_IP_HPP_INCLUDED__
31#define __ZMQ_IP_HPP_INCLUDED__
32
33#include <string>
34#include "fd.hpp"
35
36namespace zmq
37{
38// Same as socket(2), but allows for transparent tweaking the options.
39fd_t open_socket (int domain_, int type_, int protocol_);
40
41// Sets the socket into non-blocking mode.
42void unblock_socket (fd_t s_);
43
44// Enable IPv4-mapping of addresses in case it is disabled by default.
45void enable_ipv4_mapping (fd_t s_);
46
47// Returns string representation of peer's address.
48// Socket sockfd_ must be connected. Returns true iff successful.
49int get_peer_ip_address (fd_t sockfd_, std::string &ip_addr_);
50
51// Sets the IP Type-Of-Service for the underlying socket
52void set_ip_type_of_service (fd_t s_, int iptos_);
53
54// Sets the SO_NOSIGPIPE option for the underlying socket.
55// Return 0 on success, -1 if the connection has been closed by the peer
56int set_nosigpipe (fd_t s_);
57
58// Binds the underlying socket to the given device, eg. VRF or interface
59int bind_to_device (fd_t s_, const std::string &bound_device_);
60
61// Initialize network subsystem. May be called multiple times. Each call must be matched by a call to shutdown_network.
62bool initialize_network ();
63
64// Shutdown network subsystem. Must be called once for each call to initialize_network before terminating.
65void shutdown_network ();
66
67// Creates a pair of sockets (using signaler_port on OS using TCP sockets).
68// Returns -1 if we could not make the socket pair successfully
69int make_fdpair (fd_t *r_, fd_t *w_);
70
71// Makes a socket non-inheritable to child processes.
72// Asserts on any failure.
73void make_socket_noninheritable (fd_t sock_);
74
75// Asserts that:
76// - an internal 0MQ error did not occur,
77// - and, if a socket error occured, it can be recovered from.
78void assert_success_or_recoverable (fd_t s_, int rc_);
79
80#ifdef ZMQ_HAVE_IPC
81// Create an IPC wildcard path address
82int create_ipc_wildcard_address (std::string &path_, std::string &file_);
83#endif
84}
85
86#endif
87