ZeroMQ4.3.4

/* Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file This file is part of libzmq, the ZeroMQ core engine in C++. libzmq is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (LGPL) as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. As a special exception, the Contributors give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you must extend this exception to your version of the library. libzmq is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. ************************************************************************* NOTE to contributors. This file comprises the principal public contract for ZeroMQ API users. Any change to this file supplied in a stable release SHOULD not break existing applications. In practice this means that the value of constants must not change, and that old values may not be reused for new constants. ************************************************************************* */ #ifndef __ZMQ_H_INCLUDED__ #define __ZMQ_H_INCLUDED__ /* Version macros for compile-time API version detection */ #define ZMQ_VERSION_MAJOR 4 #define ZMQ_VERSION_MINOR 3 #define ZMQ_VERSION_PATCH 4 #define ZMQ_MAKE_VERSION(major, minor, patch) \ ((major) *10000 + (minor) *100 + (patch)) #define ZMQ_VERSION \ ZMQ_MAKE_VERSION (ZMQ_VERSION_MAJOR, ZMQ_VERSION_MINOR, ZMQ_VERSION_PATCH) #ifdef __cplusplus extern "C" { #endif #if !defined _WIN32_WCE #include <errno.h> #endif #include <stddef.h> #include <stdio.h> #if defined _WIN32 // Set target version to Windows Server 2008, Windows Vista or higher. // Windows XP (0x0501) is supported but without client & server socket types. #ifndef _WIN32_WINNT #define _WIN32_WINNT 0x0600 #endif #ifdef __MINGW32__ // Require Windows XP or higher with MinGW for getaddrinfo(). #if (_WIN32_WINNT >= 0x0501) #else #error You need at least Windows XP target #endif #endif #endif /* Handle DSO symbol visibility */ #if defined _WIN32 #if defined ZMQ_STATIC #define ZMQ_EXPORT #elif defined DLL_EXPORT #define ZMQ_EXPORT __declspec(dllexport) #else #define ZMQ_EXPORT __declspec(dllimport) #endif #else #if defined __SUNPRO_C || defined __SUNPRO_CC #define ZMQ_EXPORT __global #elif (defined __GNUC__ && __GNUC__ >= 4) || defined __INTEL_COMPILER #define ZMQ_EXPORT __attribute__ ((visibility ("default"))) #else #define ZMQ_EXPORT #endif #endif /* Define integer types needed for event interface */ #define ZMQ_DEFINED_STDINT 1 #if defined ZMQ_HAVE_SOLARIS || defined ZMQ_HAVE_OPENVMS #include <inttypes.h> #elif defined _MSC_VER && _MSC_VER < 1600 #ifndef uint64_t typedef unsigned __int64 uint64_t; #endif #ifndef int32_t typedef __int32 int32_t; #endif #ifndef uint32_t typedef unsigned __int32 uint32_t; #endif #ifndef uint16_t typedef unsigned __int16 uint16_t; #endif #ifndef uint8_t typedef unsigned __int8 uint8_t; #endif #else #include <stdint.h> #endif // 32-bit AIX's pollfd struct members are called reqevents and rtnevents so it // defines compatibility macros for them. Need to include that header first to // stop build failures since zmq_pollset_t defines them as events and revents. #ifdef ZMQ_HAVE_AIX #include <poll.h> #endif /******************************************************************************/ /* 0MQ errors. */ /******************************************************************************/ /* A number random enough not to collide with different errno ranges on */ /* different OSes. The assumption is that error_t is at least 32-bit type. */ #define ZMQ_HAUSNUMERO 156384712 /* On Windows platform some of the standard POSIX errnos are not defined. */ #ifndef ENOTSUP #define ENOTSUP (ZMQ_HAUSNUMERO + 1) #endif #ifndef EPROTONOSUPPORT #define EPROTONOSUPPORT (ZMQ_HAUSNUMERO + 2) #endif #ifndef ENOBUFS #define ENOBUFS (ZMQ_HAUSNUMERO + 3) #endif #ifndef ENETDOWN #define ENETDOWN (ZMQ_HAUSNUMERO + 4) #endif #ifndef EADDRINUSE #define EADDRINUSE (ZMQ_HAUSNUMERO + 5) #endif #ifndef EADDRNOTAVAIL #define EADDRNOTAVAIL (ZMQ_HAUSNUMERO + 6) #endif #ifndef ECONNREFUSED #define ECONNREFUSED (ZMQ_HAUSNUMERO + 7) #endif #ifndef EINPROGRESS #define EINPROGRESS (ZMQ_HAUSNUMERO + 8) #endif #ifndef ENOTSOCK #define ENOTSOCK (ZMQ_HAUSNUMERO + 9) #endif #ifndef EMSGSIZE #define EMSGSIZE (ZMQ_HAUSNUMERO + 10) #endif #ifndef EAFNOSUPPORT #define EAFNOSUPPORT (ZMQ_HAUSNUMERO + 11) #endif #ifndef ENETUNREACH #define ENETUNREACH (ZMQ_HAUSNUMERO + 12) #endif #ifndef ECONNABORTED #define ECONNABORTED (ZMQ_HAUSNUMERO + 13) #endif #ifndef ECONNRESET #define ECONNRESET (ZMQ_HAUSNUMERO + 14) #endif #ifndef ENOTCONN #define ENOTCONN (ZMQ_HAUSNUMERO + 15) #endif #ifndef ETIMEDOUT #define ETIMEDOUT (ZMQ_HAUSNUMERO + 16) #endif #ifndef EHOSTUNREACH #define EHOSTUNREACH (ZMQ_HAUSNUMERO + 17) #endif #ifndef ENETRESET #define ENETRESET (ZMQ_HAUSNUMERO + 18) #endif /* Native 0MQ error codes. */ #define EFSM (ZMQ_HAUSNUMERO + 51) #define ENOCOMPATPROTO (ZMQ_HAUSNUMERO + 52) #define ETERM (ZMQ_HAUSNUMERO + 53) #define EMTHREAD (ZMQ_HAUSNUMERO + 54) /* This function retrieves the errno as it is known to 0MQ library. The goal */ /* of this function is to make the code 100% portable, including where 0MQ */ /* compiled with certain CRT library (on Windows) is linked to an */ /* application that uses different CRT library. */ ZMQ_EXPORT int zmq_errno (void); /* Resolves system errors and 0MQ errors to human-readable string. */ ZMQ_EXPORT const char *zmq_strerror (int errnum_); /* Run-time API version detection */ ZMQ_EXPORT void zmq_version (int *major_, int *minor_, int *patch_); /******************************************************************************/ /* 0MQ infrastructure (a.k.a. context) initialisation & termination. */ /******************************************************************************/ /* Context options */ #define ZMQ_IO_THREADS 1 #define ZMQ_MAX_SOCKETS 2 #define ZMQ_SOCKET_LIMIT 3 #define ZMQ_THREAD_PRIORITY 3 #define ZMQ_THREAD_SCHED_POLICY 4 #define ZMQ_MAX_MSGSZ 5 #define ZMQ_MSG_T_SIZE 6 #define ZMQ_THREAD_AFFINITY_CPU_ADD 7 #define ZMQ_THREAD_AFFINITY_CPU_REMOVE 8 #define ZMQ_THREAD_NAME_PREFIX 9 /* Default for new contexts */ #define ZMQ_IO_THREADS_DFLT 1 #define ZMQ_MAX_SOCKETS_DFLT 1023 #define ZMQ_THREAD_PRIORITY_DFLT -1 #define ZMQ_THREAD_SCHED_POLICY_DFLT -1 ZMQ_EXPORT void *zmq_ctx_new (void); ZMQ_EXPORT int zmq_ctx_term (void *context_); ZMQ_EXPORT int zmq_ctx_shutdown (void *context_); ZMQ_EXPORT int zmq_ctx_set (void *context_, int option_, int optval_); ZMQ_EXPORT int zmq_ctx_get (void *context_, i