zmq.h 24.1 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
Martin Sustrik's avatar
Martin Sustrik committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
Martin Sustrik's avatar
Martin Sustrik committed
5

6 7 8
    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
Martin Sustrik's avatar
Martin Sustrik committed
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    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.
Martin Sustrik's avatar
Martin Sustrik committed
25

26
    You should have received a copy of the GNU Lesser General Public License
Martin Sustrik's avatar
Martin Sustrik committed
27
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
28 29 30

    *************************************************************************
    NOTE to contributors. This file comprises the principal public contract
31 32
    for ZeroMQ API users. Any change to this file supplied in a stable
    release SHOULD not break existing applications.
33 34 35
    In practice this means that the value of constants must not change, and
    that old values may not be reused for new constants.
    *************************************************************************
Martin Sustrik's avatar
Martin Sustrik committed
36 37
*/

Martin Sustrik's avatar
Martin Sustrik committed
38 39
#ifndef __ZMQ_H_INCLUDED__
#define __ZMQ_H_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
40

41 42
/*  Version macros for compile-time API version detection                     */
#define ZMQ_VERSION_MAJOR 4
43
#define ZMQ_VERSION_MINOR 2
44
#define ZMQ_VERSION_PATCH 3
45 46 47 48 49 50

#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)

Martin Sustrik's avatar
Martin Sustrik committed
51 52 53 54
#ifdef __cplusplus
extern "C" {
#endif

55
#if !defined _WIN32_WCE
56
#include <errno.h>
boris@boressoft.ru's avatar
boris@boressoft.ru committed
57
#endif
Martin Sustrik's avatar
Martin Sustrik committed
58
#include <stddef.h>
59
#include <stdio.h>
60
#if defined _WIN32
61 62 63 64 65 66 67 68 69 70 71 72 73 74
//  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 >= 0x0600)
#else
#undef _WIN32_WINNT
#define _WIN32_WINNT 0x0600
#endif
#endif
75
#include <winsock2.h>
76
#endif
Martin Sustrik's avatar
Martin Sustrik committed
77

78
/*  Handle DSO symbol visibility                                             */
79
#if defined _WIN32
80 81 82
#   if defined ZMQ_STATIC
#       define ZMQ_EXPORT
#   elif defined DLL_EXPORT
83 84 85 86
#       define ZMQ_EXPORT __declspec(dllexport)
#   else
#       define ZMQ_EXPORT __declspec(dllimport)
#   endif
Martin Sustrik's avatar
Martin Sustrik committed
87
#else
88 89 90 91 92 93
#   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
94
#   endif
Martin Sustrik's avatar
Martin Sustrik committed
95 96
#endif

97
/*  Define integer types needed for event interface                          */
98
#define ZMQ_DEFINED_STDINT 1
99 100
#if defined ZMQ_HAVE_SOLARIS || defined ZMQ_HAVE_OPENVMS
#   include <inttypes.h>
101 102 103 104 105 106 107 108 109 110
#elif defined _MSC_VER && _MSC_VER < 1600
#   ifndef int32_t
        typedef __int32 int32_t;
#   endif
#   ifndef uint16_t
        typedef unsigned __int16 uint16_t;
#   endif
#   ifndef uint8_t
        typedef unsigned __int8 uint8_t;
#   endif
111 112 113 114
#else
#   include <stdint.h>
#endif

115 116 117 118 119 120 121
//  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

122

123
/******************************************************************************/
124
/*  0MQ errors.                                                               */
125
/******************************************************************************/
126

127
/*  A number random enough not to collide with different errno ranges on      */
128
/*  different OSes. The assumption is that error_t is at least 32-bit type.   */
129 130
#define ZMQ_HAUSNUMERO 156384712

131
/*  On Windows platform some of the standard POSIX errnos are not defined.    */
132 133 134 135 136 137
#ifndef ENOTSUP
#define ENOTSUP (ZMQ_HAUSNUMERO + 1)
#endif
#ifndef EPROTONOSUPPORT
#define EPROTONOSUPPORT (ZMQ_HAUSNUMERO + 2)
#endif
138 139 140 141 142 143 144 145 146 147 148 149
#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
malosek's avatar
malosek committed
150 151 152
#ifndef ECONNREFUSED
#define ECONNREFUSED (ZMQ_HAUSNUMERO + 7)
#endif
153 154 155
#ifndef EINPROGRESS
#define EINPROGRESS (ZMQ_HAUSNUMERO + 8)
#endif
156 157 158
#ifndef ENOTSOCK
#define ENOTSOCK (ZMQ_HAUSNUMERO + 9)
#endif
159 160 161
#ifndef EMSGSIZE
#define EMSGSIZE (ZMQ_HAUSNUMERO + 10)
#endif
162
#ifndef EAFNOSUPPORT
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
#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)
179
#endif
Pieter Hintjens's avatar
Pieter Hintjens committed
180
#ifndef EHOSTUNREACH
181
#define EHOSTUNREACH (ZMQ_HAUSNUMERO + 17)
Pieter Hintjens's avatar
Pieter Hintjens committed
182
#endif
183 184 185
#ifndef ENETRESET
#define ENETRESET (ZMQ_HAUSNUMERO + 18)
#endif
186

187
/*  Native 0MQ error codes.                                                   */
188 189
#define EFSM (ZMQ_HAUSNUMERO + 51)
#define ENOCOMPATPROTO (ZMQ_HAUSNUMERO + 52)
190
#define ETERM (ZMQ_HAUSNUMERO + 53)
191
#define EMTHREAD (ZMQ_HAUSNUMERO + 54)
192

193 194 195 196
/*  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.                              */
197
ZMQ_EXPORT int zmq_errno (void);
198 199

/*  Resolves system errors and 0MQ errors to human-readable string.           */
200 201
ZMQ_EXPORT const char *zmq_strerror (int errnum);

202 203 204
/*  Run-time API version detection                                            */
ZMQ_EXPORT void zmq_version (int *major, int *minor, int *patch);

205 206 207 208
/******************************************************************************/
/*  0MQ infrastructure (a.k.a. context) initialisation & termination.         */
/******************************************************************************/

209 210 211
/*  Context options                                                           */
#define ZMQ_IO_THREADS  1
#define ZMQ_MAX_SOCKETS 2
212
#define ZMQ_SOCKET_LIMIT 3
213 214
#define ZMQ_THREAD_PRIORITY 3
#define ZMQ_THREAD_SCHED_POLICY 4
215
#define ZMQ_MAX_MSGSZ 5
216

217 218
/*  Default for new contexts                                                  */
#define ZMQ_IO_THREADS_DFLT  1
219
#define ZMQ_MAX_SOCKETS_DFLT 1023
220 221
#define ZMQ_THREAD_PRIORITY_DFLT -1
#define ZMQ_THREAD_SCHED_POLICY_DFLT -1
222 223

ZMQ_EXPORT void *zmq_ctx_new (void);
224
ZMQ_EXPORT int zmq_ctx_term (void *context);
225
ZMQ_EXPORT int zmq_ctx_shutdown (void *context);
226 227 228 229 230 231
ZMQ_EXPORT int zmq_ctx_set (void *context, int option, int optval);
ZMQ_EXPORT int zmq_ctx_get (void *context, int option);

/*  Old (legacy) API                                                          */
ZMQ_EXPORT void *zmq_init (int io_threads);
ZMQ_EXPORT int zmq_term (void *context);
232
ZMQ_EXPORT int zmq_ctx_destroy (void *context);
233 234


235 236 237
/******************************************************************************/
/*  0MQ message definition.                                                   */
/******************************************************************************/
238

239 240 241
/* Some architectures, like sparc64 and some variants of aarch64, enforce pointer
 * alignment and raise sigbus on violations. Make sure applications allocate
 * zmq_msg_t on addresses aligned on a pointer-size boundary to avoid this issue.
242
 */
243 244 245 246 247
typedef struct zmq_msg_t {
#if defined (__GNUC__) || defined ( __INTEL_COMPILER) || \
        (defined (__SUNPRO_C) && __SUNPRO_C >= 0x590) || \
        (defined (__SUNPRO_CC) && __SUNPRO_CC >= 0x590)
    unsigned char _ [64] __attribute__ ((aligned (sizeof (void *))));
248 249 250 251
#elif defined (_MSC_VER) && (defined (_M_X64) || defined (_M_ARM64))
    __declspec (align (8)) unsigned char _ [64];
#elif defined (_MSC_VER) && (defined (_M_IX86) || defined (_M_ARM_ARMV7VE))
    __declspec (align (4)) unsigned char _ [64];
252 253 254 255
#else
    unsigned char _ [64];
#endif
} zmq_msg_t;
Martin Sustrik's avatar
Martin Sustrik committed
256

257
typedef void (zmq_free_fn) (void *data, void *hint);
Martin Sustrik's avatar
Martin Sustrik committed
258

259
ZMQ_EXPORT int zmq_msg_init (zmq_msg_t *msg);
260 261
ZMQ_EXPORT int zmq_msg_init_size (zmq_msg_t *msg, size_t size);
ZMQ_EXPORT int zmq_msg_init_data (zmq_msg_t *msg, void *data,
262
    size_t size, zmq_free_fn *ffn, void *hint);
263 264
ZMQ_EXPORT int zmq_msg_send (zmq_msg_t *msg, void *s, int flags);
ZMQ_EXPORT int zmq_msg_recv (zmq_msg_t *msg, void *s, int flags);
265 266 267 268
ZMQ_EXPORT int zmq_msg_close (zmq_msg_t *msg);
ZMQ_EXPORT int zmq_msg_move (zmq_msg_t *dest, zmq_msg_t *src);
ZMQ_EXPORT int zmq_msg_copy (zmq_msg_t *dest, zmq_msg_t *src);
ZMQ_EXPORT void *zmq_msg_data (zmq_msg_t *msg);
269 270 271
ZMQ_EXPORT size_t zmq_msg_size (const zmq_msg_t *msg);
ZMQ_EXPORT int zmq_msg_more (const zmq_msg_t *msg);
ZMQ_EXPORT int zmq_msg_get (const zmq_msg_t *msg, int property);
272
ZMQ_EXPORT int zmq_msg_set (zmq_msg_t *msg, int property, int optval);
273
ZMQ_EXPORT const char *zmq_msg_gets (const zmq_msg_t *msg, const char *property);
274

275 276 277
/******************************************************************************/
/*  0MQ socket definition.                                                    */
/******************************************************************************/
278

279
/*  Socket types.                                                             */
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
#define ZMQ_PAIR 0
#define ZMQ_PUB 1
#define ZMQ_SUB 2
#define ZMQ_REQ 3
#define ZMQ_REP 4
#define ZMQ_DEALER 5
#define ZMQ_ROUTER 6
#define ZMQ_PULL 7
#define ZMQ_PUSH 8
#define ZMQ_XPUB 9
#define ZMQ_XSUB 10
#define ZMQ_STREAM 11

/*  Deprecated aliases                                                        */
#define ZMQ_XREQ ZMQ_DEALER
#define ZMQ_XREP ZMQ_ROUTER
296

297
/*  Socket options.                                                           */
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
#define ZMQ_AFFINITY 4
#define ZMQ_IDENTITY 5
#define ZMQ_SUBSCRIBE 6
#define ZMQ_UNSUBSCRIBE 7
#define ZMQ_RATE 8
#define ZMQ_RECOVERY_IVL 9
#define ZMQ_SNDBUF 11
#define ZMQ_RCVBUF 12
#define ZMQ_RCVMORE 13
#define ZMQ_FD 14
#define ZMQ_EVENTS 15
#define ZMQ_TYPE 16
#define ZMQ_LINGER 17
#define ZMQ_RECONNECT_IVL 18
#define ZMQ_BACKLOG 19
#define ZMQ_RECONNECT_IVL_MAX 21
#define ZMQ_MAXMSGSIZE 22
#define ZMQ_SNDHWM 23
#define ZMQ_RCVHWM 24
#define ZMQ_MULTICAST_HOPS 25
#define ZMQ_RCVTIMEO 27
#define ZMQ_SNDTIMEO 28
#define ZMQ_LAST_ENDPOINT 32
#define ZMQ_ROUTER_MANDATORY 33
#define ZMQ_TCP_KEEPALIVE 34
#define ZMQ_TCP_KEEPALIVE_CNT 35
#define ZMQ_TCP_KEEPALIVE_IDLE 36
#define ZMQ_TCP_KEEPALIVE_INTVL 37
#define ZMQ_IMMEDIATE 39
#define ZMQ_XPUB_VERBOSE 40
#define ZMQ_ROUTER_RAW 41
#define ZMQ_IPV6 42
#define ZMQ_MECHANISM 43
#define ZMQ_PLAIN_SERVER 44
#define ZMQ_PLAIN_USERNAME 45
#define ZMQ_PLAIN_PASSWORD 46
#define ZMQ_CURVE_SERVER 47
#define ZMQ_CURVE_PUBLICKEY 48
#define ZMQ_CURVE_SECRETKEY 49
#define ZMQ_CURVE_SERVERKEY 50
#define ZMQ_PROBE_ROUTER 51
#define ZMQ_REQ_CORRELATE 52
#define ZMQ_REQ_RELAXED 53
#define ZMQ_CONFLATE 54
#define ZMQ_ZAP_DOMAIN 55
343
#define ZMQ_ROUTER_HANDOVER 56
344
#define ZMQ_TOS 57
345
#define ZMQ_CONNECT_RID 61
346
#define ZMQ_GSSAPI_SERVER 62
Chris Busbey's avatar
Chris Busbey committed
347 348
#define ZMQ_GSSAPI_PRINCIPAL 63
#define ZMQ_GSSAPI_SERVICE_PRINCIPAL 64
349
#define ZMQ_GSSAPI_PLAINTEXT 65
350
#define ZMQ_HANDSHAKE_IVL 66
351
#define ZMQ_SOCKS_PROXY 68
352
#define ZMQ_XPUB_NODROP 69
353
#define ZMQ_BLOCKY 70
354
#define ZMQ_XPUB_MANUAL 71
somdoron's avatar
somdoron committed
355
#define ZMQ_XPUB_WELCOME_MSG 72
356
#define ZMQ_STREAM_NOTIFY 73
357
#define ZMQ_INVERT_MATCHING 74
Jonathan Reams's avatar
Jonathan Reams committed
358 359 360
#define ZMQ_HEARTBEAT_IVL 75
#define ZMQ_HEARTBEAT_TTL 76
#define ZMQ_HEARTBEAT_TIMEOUT 77
361
#define ZMQ_XPUB_VERBOSER 78
362
#define ZMQ_CONNECT_TIMEOUT 79
363
#define ZMQ_TCP_MAXRT 80
364
#define ZMQ_THREAD_SAFE 81
365
#define ZMQ_MULTICAST_MAXTPDU 84
Ilya Kulakov's avatar
Ilya Kulakov committed
366 367 368 369
#define ZMQ_VMCI_BUFFER_SIZE 85
#define ZMQ_VMCI_BUFFER_MIN_SIZE 86
#define ZMQ_VMCI_BUFFER_MAX_SIZE 87
#define ZMQ_VMCI_CONNECT_TIMEOUT 88
370
#define ZMQ_USE_FD 89
371

372
/*  Message options                                                           */
373
#define ZMQ_MORE 1
374
#define ZMQ_SHARED 3
375

376
/*  Send/recv options.                                                        */
377 378
#define ZMQ_DONTWAIT 1
#define ZMQ_SNDMORE 2
379

380
/*  Security mechanisms                                                       */
381 382 383
#define ZMQ_NULL 0
#define ZMQ_PLAIN 1
#define ZMQ_CURVE 2
384
#define ZMQ_GSSAPI 3
385

somdoron's avatar
somdoron committed
386
/*  RADIO-DISH protocol                                                       */
somdoron's avatar
somdoron committed
387
#define ZMQ_GROUP_MAX_LENGTH        15
somdoron's avatar
somdoron committed
388

389
/*  Deprecated options and aliases                                            */
390 391 392 393
#define ZMQ_TCP_ACCEPT_FILTER       38
#define ZMQ_IPC_FILTER_PID          58
#define ZMQ_IPC_FILTER_UID          59
#define ZMQ_IPC_FILTER_GID          60
394 395 396 397 398
#define ZMQ_IPV4ONLY                31
#define ZMQ_DELAY_ATTACH_ON_CONNECT ZMQ_IMMEDIATE
#define ZMQ_NOBLOCK                 ZMQ_DONTWAIT
#define ZMQ_FAIL_UNROUTABLE         ZMQ_ROUTER_MANDATORY
#define ZMQ_ROUTER_BEHAVIOR         ZMQ_ROUTER_MANDATORY
399

400 401 402
/*  Deprecated Message options                                                */
#define ZMQ_SRCFD 2

403 404 405 406
/******************************************************************************/
/*  0MQ socket events and monitoring                                          */
/******************************************************************************/

407
/*  Socket transport events (TCP, IPC and TIPC only)                          */
408 409 410 411 412 413 414 415 416 417 418 419 420

#define ZMQ_EVENT_CONNECTED         0x0001
#define ZMQ_EVENT_CONNECT_DELAYED   0x0002
#define ZMQ_EVENT_CONNECT_RETRIED   0x0004
#define ZMQ_EVENT_LISTENING         0x0008
#define ZMQ_EVENT_BIND_FAILED       0x0010
#define ZMQ_EVENT_ACCEPTED          0x0020
#define ZMQ_EVENT_ACCEPT_FAILED     0x0040
#define ZMQ_EVENT_CLOSED            0x0080
#define ZMQ_EVENT_CLOSE_FAILED      0x0100
#define ZMQ_EVENT_DISCONNECTED      0x0200
#define ZMQ_EVENT_MONITOR_STOPPED   0x0400
#define ZMQ_EVENT_ALL               0xFFFF
421

422 423 424
ZMQ_EXPORT void *zmq_socket (void *, int type);
ZMQ_EXPORT int zmq_close (void *s);
ZMQ_EXPORT int zmq_setsockopt (void *s, int option, const void *optval,
425
    size_t optvallen);
426
ZMQ_EXPORT int zmq_getsockopt (void *s, int option, void *optval,
427
    size_t *optvallen);
428 429
ZMQ_EXPORT int zmq_bind (void *s, const char *addr);
ZMQ_EXPORT int zmq_connect (void *s, const char *addr);
430 431
ZMQ_EXPORT int zmq_unbind (void *s, const char *addr);
ZMQ_EXPORT int zmq_disconnect (void *s, const char *addr);
432 433 434
ZMQ_EXPORT int zmq_send (void *s, const void *buf, size_t len, int flags);
ZMQ_EXPORT int zmq_send_const (void *s, const void *buf, size_t len, int flags);
ZMQ_EXPORT int zmq_recv (void *s, void *buf, size_t len, int flags);
435
ZMQ_EXPORT int zmq_socket_monitor (void *s, const char *addr, int events);
somdoron's avatar
somdoron committed
436

skaller's avatar
skaller committed
437

438
/******************************************************************************/
439
/*  Deprecated I/O multiplexing. Prefer using zmq_poller API                  */
440
/******************************************************************************/
441

442 443 444
#define ZMQ_POLLIN 1
#define ZMQ_POLLOUT 2
#define ZMQ_POLLERR 4
445
#define ZMQ_POLLPRI 8
446

447
typedef struct zmq_pollitem_t
448
{
449
    void *socket;
450 451 452
#if defined _WIN32
    SOCKET fd;
#else
453
    int fd;
454
#endif
455 456 457 458
    short events;
    short revents;
} zmq_pollitem_t;

459 460
#define ZMQ_POLLITEMS_DFLT 16

461
ZMQ_EXPORT int  zmq_poll (zmq_pollitem_t *items, int nitems, long timeout);
462

463 464 465
/******************************************************************************/
/*  Message proxying                                                          */
/******************************************************************************/
Pieter Hintjens's avatar
Pieter Hintjens committed
466

467 468
ZMQ_EXPORT int zmq_proxy (void *frontend, void *backend, void *capture);
ZMQ_EXPORT int zmq_proxy_steerable (void *frontend, void *backend, void *capture, void *control);
469

470 471 472
/******************************************************************************/
/*  Probe library capabilities                                                */
/******************************************************************************/
473 474 475 476

#define ZMQ_HAS_CAPABILITIES 1
ZMQ_EXPORT int zmq_has (const char *capability);

477 478 479 480
/*  Deprecated aliases */
#define ZMQ_STREAMER 1
#define ZMQ_FORWARDER 2
#define ZMQ_QUEUE 3
481 482

/*  Deprecated methods */
483
ZMQ_EXPORT int zmq_device (int type, void *frontend, void *backend);
484 485
ZMQ_EXPORT int zmq_sendmsg (void *s, zmq_msg_t *msg, int flags);
ZMQ_EXPORT int zmq_recvmsg (void *s, zmq_msg_t *msg, int flags);
486 487 488
struct iovec;
ZMQ_EXPORT int zmq_sendiov (void *s, struct iovec *iov, size_t count, int flags);
ZMQ_EXPORT int zmq_recviov (void *s, struct iovec *iov, size_t *count, int flags);
Pieter Hintjens's avatar
Pieter Hintjens committed
489

490 491 492 493 494
/******************************************************************************/
/*  Encryption functions                                                      */
/******************************************************************************/

/*  Encode data with Z85 encoding. Returns encoded data                       */
495
ZMQ_EXPORT char *zmq_z85_encode (char *dest, const uint8_t *data, size_t size);
496 497

/*  Decode data with Z85 encoding. Returns decoded data                       */
498
ZMQ_EXPORT uint8_t *zmq_z85_decode (uint8_t *dest, const char *string);
499

500
/*  Generate z85-encoded public and private keypair with tweetnacl/libsodium. */
501 502 503
/*  Returns 0 on success.                                                     */
ZMQ_EXPORT int zmq_curve_keypair (char *z85_public_key, char *z85_secret_key);

504 505 506 507
/*  Derive the z85-encoded public key from the z85-encoded secret key.        */
/*  Returns 0 on success.                                                     */
ZMQ_EXPORT int zmq_curve_public (char *z85_public_key, const char *z85_secret_key);

508 509 510 511 512 513 514
/******************************************************************************/
/*  Atomic utility methods                                                    */
/******************************************************************************/

ZMQ_EXPORT void *zmq_atomic_counter_new (void);
ZMQ_EXPORT void zmq_atomic_counter_set (void *counter, int value);
ZMQ_EXPORT int zmq_atomic_counter_inc (void *counter);
515
ZMQ_EXPORT int zmq_atomic_counter_dec (void *counter);
516 517 518
ZMQ_EXPORT int zmq_atomic_counter_value (void *counter);
ZMQ_EXPORT void zmq_atomic_counter_destroy (void **counter_p);

519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547

/******************************************************************************/
/*  These functions are not documented by man pages -- use at your own risk.  */
/*  If you need these to be part of the formal ZMQ API, then (a) write a man  */
/*  page, and (b) write a test case in tests.                                 */
/******************************************************************************/

/*  Helper functions are used by perf tests so that they don't have to care   */
/*  about minutiae of time-related functions on different OS platforms.       */

/*  Starts the stopwatch. Returns the handle to the watch.                    */
ZMQ_EXPORT void *zmq_stopwatch_start (void);

/*  Stops the stopwatch. Returns the number of microseconds elapsed since     */
/*  the stopwatch was started.                                                */
ZMQ_EXPORT unsigned long zmq_stopwatch_stop (void *watch_);

/*  Sleeps for specified number of seconds.                                   */
ZMQ_EXPORT void zmq_sleep (int seconds_);

typedef void (zmq_thread_fn) (void*);

/* Start a thread. Returns a handle to the thread.                            */
ZMQ_EXPORT void *zmq_threadstart (zmq_thread_fn* func, void* arg);

/* Wait for thread to complete then free up resources.                        */
ZMQ_EXPORT void zmq_threadclose (void* thread);


548 549 550 551 552 553 554
/******************************************************************************/
/*  These functions are DRAFT and disabled in stable releases, and subject to */
/*  change at ANY time until declared stable.                                 */
/******************************************************************************/

#ifdef ZMQ_BUILD_DRAFT_API

555 556 557
/*  DRAFT Socket types.                                                       */
#define ZMQ_SERVER 12
#define ZMQ_CLIENT 13
558 559
#define ZMQ_RADIO 14
#define ZMQ_DISH 15
560 561
#define ZMQ_GATHER 16
#define ZMQ_SCATTER 17
562
#define ZMQ_DGRAM 18
563

564 565 566 567 568
/*  DRAFT 0MQ socket events and monitoring                                    */
#define ZMQ_EVENT_HANDSHAKE_FAILED  0x0800
#define ZMQ_EVENT_HANDSHAKE_SUCCEED 0x1000

/*  DRAFT Context options                                                     */
569 570
#define ZMQ_MSG_T_SIZE 6

571
/*  DRAFT Socket methods.                                                     */
572 573
ZMQ_EXPORT int zmq_join (void *s, const char *group);
ZMQ_EXPORT int zmq_leave (void *s, const char *group);
574

575 576 577 578 579 580
/*  DRAFT Msg methods.                                                        */
ZMQ_EXPORT int zmq_msg_set_routing_id(zmq_msg_t *msg, uint32_t routing_id);
ZMQ_EXPORT uint32_t zmq_msg_routing_id(zmq_msg_t *msg);
ZMQ_EXPORT int zmq_msg_set_group(zmq_msg_t *msg, const char *group);
ZMQ_EXPORT const char *zmq_msg_group(zmq_msg_t *msg);

581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
/******************************************************************************/
/*  Poller polling on sockets,fd and thread-safe sockets                      */
/******************************************************************************/

#define ZMQ_HAVE_POLLER

typedef struct zmq_poller_event_t
{
    void *socket;
#if defined _WIN32
    SOCKET fd;
#else
    int fd;
#endif
    void *user_data;
    short events;
} zmq_poller_event_t;

ZMQ_EXPORT void *zmq_poller_new (void);
ZMQ_EXPORT int  zmq_poller_destroy (void **poller_p);
ZMQ_EXPORT int  zmq_poller_add (void *poller, void *socket, void *user_data, short events);
ZMQ_EXPORT int  zmq_poller_modify (void *poller, void *socket, short events);
ZMQ_EXPORT int  zmq_poller_remove (void *poller, void *socket);
ZMQ_EXPORT int  zmq_poller_wait (void *poller, zmq_poller_event_t *event, long timeout);
605
ZMQ_EXPORT int  zmq_poller_wait_all (void *poller, zmq_poller_event_t *events, int n_events, long timeout);
606 607 608 609 610 611 612 613 614 615 616

#if defined _WIN32
ZMQ_EXPORT int zmq_poller_add_fd (void *poller, SOCKET fd, void *user_data, short events);
ZMQ_EXPORT int zmq_poller_modify_fd (void *poller, SOCKET fd, short events);
ZMQ_EXPORT int zmq_poller_remove_fd (void *poller, SOCKET fd);
#else
ZMQ_EXPORT int zmq_poller_add_fd (void *poller, int fd, void *user_data, short events);
ZMQ_EXPORT int zmq_poller_modify_fd (void *poller, int fd, short events);
ZMQ_EXPORT int zmq_poller_remove_fd (void *poller, int fd);
#endif

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
/******************************************************************************/
/*  Scheduling timers                                                         */
/******************************************************************************/

#define ZMQ_HAVE_TIMERS

typedef void (zmq_timer_fn)(int timer_id, void *arg);

ZMQ_EXPORT void *zmq_timers_new (void);
ZMQ_EXPORT int   zmq_timers_destroy (void **timers_p);
ZMQ_EXPORT int   zmq_timers_add (void *timers, size_t interval, zmq_timer_fn handler, void *arg);
ZMQ_EXPORT int   zmq_timers_cancel (void *timers, int timer_id);
ZMQ_EXPORT int   zmq_timers_set_interval (void *timers, int timer_id, size_t interval);
ZMQ_EXPORT int   zmq_timers_reset (void *timers, int timer_id);
ZMQ_EXPORT long  zmq_timers_timeout (void *timers);
ZMQ_EXPORT int   zmq_timers_execute (void *timers);

634 635 636 637
/******************************************************************************/
/*  GSSAPI socket options to set name type                                    */
/******************************************************************************/

638 639
#define ZMQ_GSSAPI_PRINCIPAL_NAMETYPE 90
#define ZMQ_GSSAPI_SERVICE_PRINCIPAL_NAMETYPE 91
640 641 642 643 644 645

/*  GSSAPI principal name types                                               */
#define ZMQ_GSSAPI_NT_HOSTBASED 0
#define ZMQ_GSSAPI_NT_USER_NAME 1
#define ZMQ_GSSAPI_NT_KRB5_PRINCIPAL 2

646 647 648
#endif // ZMQ_BUILD_DRAFT_API


649 650
#undef ZMQ_EXPORT

Martin Sustrik's avatar
Martin Sustrik committed
651 652 653 654 655
#ifdef __cplusplus
}
#endif

#endif