zmq.cpp 41.7 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 28
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
Luca Boccassi's avatar
Luca Boccassi committed
29 30 31 32 33 34 35 36 37

// "Tell them I was a writer.
//  A maker of software.
//  A humanist. A father.
//  And many things.
//  But above all, a writer.
//  Thank You. :)"
//  - Pieter Hintjens

38
#include "precompiled.hpp"
39
#define ZMQ_TYPE_UNSAFE
Martin Sustrik's avatar
Martin Sustrik committed
40

41
#include "macros.hpp"
42
#include "poller.hpp"
43 44 45 46 47

//  On AIX platform, poll.h has to be included first to get consistent
//  definition of pollfd structure (AIX uses 'reqevents' and 'retnevents'
//  instead of 'events' and 'revents' and defines macros to map from POSIX-y
//  names to AIX-specific names).
48
#if defined ZMQ_POLL_BASED_ON_POLL && !defined ZMQ_HAVE_WINDOWS
49 50 51
#include <poll.h>
#endif

52
// TODO: determine if this is an issue, since zmq.h is being loaded from pch.
AJ Lewis's avatar
AJ Lewis committed
53
// zmq.h must be included *after* poll.h for AIX to build properly
54
//#include "../include/zmq.h"
AJ Lewis's avatar
AJ Lewis committed
55

56
#if !defined ZMQ_HAVE_WINDOWS
57 58 59
#include <unistd.h>
#endif

skaller's avatar
skaller committed
60
// XSI vector I/O
61
#if defined ZMQ_HAVE_UIO
skaller's avatar
skaller committed
62 63
#include <sys/uio.h>
#else
64
struct iovec {
skaller's avatar
skaller committed
65 66 67 68 69
    void *iov_base;
    size_t iov_len;
};
#endif

70
#include <string.h>
Martin Sustrik's avatar
Martin Sustrik committed
71 72
#include <stdlib.h>
#include <new>
73
#include <climits>
Martin Sustrik's avatar
Martin Sustrik committed
74

75
#include "proxy.hpp"
76
#include "socket_base.hpp"
77
#include "stdint.hpp"
78
#include "config.hpp"
79
#include "likely.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
80
#include "clock.hpp"
81
#include "ctx.hpp"
82
#include "err.hpp"
83
#include "msg.hpp"
84
#include "fd.hpp"
85
#include "metadata.hpp"
86
#include "signaler.hpp"
87
#include "socket_poller.hpp"
somdoron's avatar
somdoron committed
88
#include "timers.hpp"
89

90
#if defined ZMQ_HAVE_OPENPGM
91
#define __PGM_WININT_H__
92 93 94
#include <pgm/pgm.h>
#endif

95 96 97 98
//  Compile time check whether msg_t fits into zmq_msg_t.
typedef char check_msg_t_size
    [sizeof (zmq::msg_t) ==  sizeof (zmq_msg_t) ? 1 : -1];

99

100 101
void zmq_version (int *major_, int *minor_, int *patch_)
{
Martin Sustrik's avatar
Martin Sustrik committed
102 103 104
    *major_ = ZMQ_VERSION_MAJOR;
    *minor_ = ZMQ_VERSION_MINOR;
    *patch_ = ZMQ_VERSION_PATCH;
105 106
}

107

108 109
const char *zmq_strerror (int errnum_)
{
110
    return zmq::errno_to_string (errnum_);
111 112
}

113
int zmq_errno (void)
114 115 116 117 118
{
    return errno;
}


119
//  New context API
Martin Sustrik's avatar
Martin Sustrik committed
120

121 122
void *zmq_ctx_new (void)
{
123 124 125 126 127 128
#if defined ZMQ_HAVE_OPENPGM

    //  Init PGM transport. Ensure threading and timer are enabled. Find PGM
    //  protocol ID. Note that if you want to use gettimeofday and sleep for
    //  openPGM timing, set environment variables PGM_TIMER to "GTOD" and
    //  PGM_SLEEP to "USLEEP".
Steven McCoy's avatar
Steven McCoy committed
129
    pgm_error_t *pgm_error = NULL;
130 131
    const bool ok = pgm_init (&pgm_error);
    if (ok != TRUE) {
132 133 134 135 136 137 138

        //  Invalid parameters don't set pgm_error_t
        zmq_assert (pgm_error != NULL);
        if (pgm_error->domain == PGM_ERROR_DOMAIN_TIME && (
              pgm_error->code == PGM_ERROR_FAILED)) {

            //  Failed to access RTC or HPET device.
Steven McCoy's avatar
Steven McCoy committed
139
            pgm_error_free (pgm_error);
140 141 142
            errno = EINVAL;
            return NULL;
        }
143 144

        //  PGM_ERROR_DOMAIN_ENGINE: WSAStartup errors or missing WSARecvMsg.
145 146 147 148
        zmq_assert (false);
    }
#endif

149 150 151 152 153 154 155 156 157 158 159 160 161
#ifdef ZMQ_HAVE_WINDOWS
    //  Intialise Windows sockets. Note that WSAStartup can be called multiple
    //  times given that WSACleanup will be called for each WSAStartup.
   //  We do this before the ctx constructor since its embedded mailbox_t
   //  object needs Winsock to be up and running.
    WORD version_requested = MAKEWORD (2, 2);
    WSADATA wsa_data;
    int rc = WSAStartup (version_requested, &wsa_data);
    zmq_assert (rc == 0);
    zmq_assert (LOBYTE (wsa_data.wVersion) == 2 &&
        HIBYTE (wsa_data.wVersion) == 2);
#endif

162
    //  Create 0MQ context.
163
    zmq::ctx_t *ctx = new (std::nothrow) zmq::ctx_t;
164
    alloc_assert (ctx);
165 166 167
    return ctx;
}

168
int zmq_ctx_term (void *ctx_)
Martin Sustrik's avatar
Martin Sustrik committed
169
{
170
    if (!ctx_ || !((zmq::ctx_t *) ctx_)->check_tag ()) {
171 172 173
        errno = EFAULT;
        return -1;
    }
174

175
    int rc = ((zmq::ctx_t *) ctx_)->terminate ();
176 177
    int en = errno;

178 179
    //  Shut down only if termination was not interrupted by a signal.
    if (!rc || en != EINTR) {
180
#ifdef ZMQ_HAVE_WINDOWS
181 182 183
        //  On Windows, uninitialise socket layer.
        rc = WSACleanup ();
        wsa_assert (rc != SOCKET_ERROR);
184 185
#endif

186
#if defined ZMQ_HAVE_OPENPGM
187 188 189
        //  Shut down the OpenPGM library.
        if (pgm_shutdown () != TRUE)
            zmq_assert (false);
190
#endif
191
    }
192 193 194

    errno = en;
    return rc;
Martin Sustrik's avatar
Martin Sustrik committed
195 196
}

197 198
int zmq_ctx_shutdown (void *ctx_)
{
199
    if (!ctx_ || !((zmq::ctx_t *) ctx_)->check_tag ()) {
200 201 202
        errno = EFAULT;
        return -1;
    }
203
    return ((zmq::ctx_t *) ctx_)->shutdown ();
204 205
}

206 207
int zmq_ctx_set (void *ctx_, int option_, int optval_)
{
208
    if (!ctx_ || !((zmq::ctx_t *) ctx_)->check_tag ()) {
209 210 211
        errno = EFAULT;
        return -1;
    }
212
    return ((zmq::ctx_t *) ctx_)->set (option_, optval_);
213 214 215 216
}

int zmq_ctx_get (void *ctx_, int option_)
{
217
    if (!ctx_ || !((zmq::ctx_t *) ctx_)->check_tag ()) {
218 219 220
        errno = EFAULT;
        return -1;
    }
221
    return ((zmq::ctx_t *) ctx_)->get (option_);
222 223 224 225 226 227
}

//  Stable/legacy context API

void *zmq_init (int io_threads_)
{
228 229 230 231 232 233
    if (io_threads_ >= 0) {
        void *ctx = zmq_ctx_new ();
        zmq_ctx_set (ctx, ZMQ_IO_THREADS, io_threads_);
        return ctx;
    }
    errno = EINVAL;
234
    return NULL;
235 236 237 238
}

int zmq_term (void *ctx_)
{
239 240 241 242 243 244
    return zmq_ctx_term (ctx_);
}

int zmq_ctx_destroy (void *ctx_)
{
    return zmq_ctx_term (ctx_);
245 246 247 248
}


// Sockets
249

250 251 252 253 254 255 256 257 258 259
static zmq::socket_base_t *as_socket_base_t (void *s_)
{
    zmq::socket_base_t *s = static_cast<zmq::socket_base_t *> (s_);
    if (!s_ || !s->check_tag ()) {
        errno = ENOTSOCK;
        return NULL;
    }
    return s;
}

260
void *zmq_socket (void *ctx_, int type_)
Martin Sustrik's avatar
Martin Sustrik committed
261
{
262
    if (!ctx_ || !((zmq::ctx_t *) ctx_)->check_tag ()) {
263 264 265
        errno = EFAULT;
        return NULL;
    }
266
    zmq::ctx_t *ctx = (zmq::ctx_t *) ctx_;
267
    zmq::socket_base_t *s = ctx->create_socket (type_);
268
    return (void *) s;
Martin Sustrik's avatar
Martin Sustrik committed
269 270
}

Martin Sustrik's avatar
Martin Sustrik committed
271
int zmq_close (void *s_)
Martin Sustrik's avatar
Martin Sustrik committed
272
{
273 274
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
275
        return -1;
276
    s->close ();
Martin Sustrik's avatar
Martin Sustrik committed
277 278 279
    return 0;
}

280 281
int zmq_setsockopt (void *s_, int option_, const void *optval_,
    size_t optvallen_)
Martin Sustrik's avatar
Martin Sustrik committed
282
{
283 284
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
285
        return -1;
286
    return s->setsockopt (option_, optval_, optvallen_);
Martin Sustrik's avatar
Martin Sustrik committed
287 288
}

289 290
int zmq_getsockopt (void *s_, int option_, void *optval_, size_t *optvallen_)
{
291 292
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
293
        return -1;
294
    return s->getsockopt (option_, optval_, optvallen_);
295 296
}

297 298
int zmq_socket_monitor (void *s_, const char *addr_, int events_)
{
299 300
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
301
        return -1;
302
    return s->monitor (addr_, events_);
303 304
}

somdoron's avatar
somdoron committed
305 306
int zmq_join (void *s_, const char* group_)
{
307 308
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
somdoron's avatar
somdoron committed
309
        return -1;
310
    return s->join (group_);
somdoron's avatar
somdoron committed
311 312 313 314
}

int zmq_leave (void *s_, const char* group_)
{
315 316
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
somdoron's avatar
somdoron committed
317
        return -1;
318
    return s->leave (group_);
somdoron's avatar
somdoron committed
319 320
}

321
int zmq_bind (void *s_, const char *addr_)
Martin Sustrik's avatar
Martin Sustrik committed
322
{
323 324
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
325
        return -1;
326
    return s->bind (addr_);
327 328 329 330
}

int zmq_connect (void *s_, const char *addr_)
{
331 332
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
333
        return -1;
334
    return s->connect (addr_);
skaller's avatar
skaller committed
335 336
}

337
int zmq_unbind (void *s_, const char *addr_)
338
{
339 340
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
341
        return -1;
342
    return s->term_endpoint (addr_);
343 344
}

345
int zmq_disconnect (void *s_, const char *addr_)
346
{
347 348
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
349
        return -1;
350
    return s->term_endpoint (addr_);
351 352
}

353 354
// Sending functions.

355
static inline int
356
s_sendmsg (zmq::socket_base_t *s_, zmq_msg_t *msg_, int flags_)
skaller's avatar
skaller committed
357
{
Min RK's avatar
Min RK committed
358
    size_t sz = zmq_msg_size (msg_);
359
    int rc = s_->send ((zmq::msg_t *) msg_, flags_);
skaller's avatar
skaller committed
360 361
    if (unlikely (rc < 0))
        return -1;
362 363 364 365 366 367 368

    //  This is what I'd like to do, my C++ fu is too weak -- PH 2016/02/09
    //  int max_msgsz = s_->parent->get (ZMQ_MAX_MSGSZ);
    size_t max_msgsz = INT_MAX;

    //  Truncate returned size to INT_MAX to avoid overflow to negative values
    return (int) (sz < max_msgsz? sz: max_msgsz);
skaller's avatar
skaller committed
369 370
}

371
/*  To be deprecated once zmq_msg_send() is stable                           */
skaller's avatar
skaller committed
372 373
int zmq_sendmsg (void *s_, zmq_msg_t *msg_, int flags_)
{
374
    return zmq_msg_send (msg_, s_, flags_);
Martin Sustrik's avatar
Martin Sustrik committed
375 376
}

377
int zmq_send (void *s_, const void *buf_, size_t len_, int flags_)
378
{
379 380
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
skaller's avatar
skaller committed
381
        return -1;
382
    zmq_msg_t msg;
383
    if (zmq_msg_init_size (&msg, len_))
384 385
        return -1;

386 387 388 389 390 391
    //  We explicitly allow a send from NULL, size zero
    if (len_) {
        assert (buf_);
        memcpy (zmq_msg_data (&msg), buf_, len_);
    }
    int rc = s_sendmsg (s, &msg, flags_);
392
    if (unlikely (rc < 0)) {
393 394 395 396 397 398 399 400
        int err = errno;
        int rc2 = zmq_msg_close (&msg);
        errno_assert (rc2 == 0);
        errno = err;
        return -1;
    }
    //  Note the optimisation here. We don't close the msg object as it is
    //  empty anyway. This may change when implementation of zmq_msg_t changes.
401
    return rc;
Uli Köhler's avatar
Uli Köhler committed
402 403
}

404
int zmq_send_const (void *s_, const void *buf_, size_t len_, int flags_)
Uli Köhler's avatar
Uli Köhler committed
405
{
406 407
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
Uli Köhler's avatar
Uli Köhler committed
408 409
        return -1;
    zmq_msg_t msg;
410
    int rc = zmq_msg_init_data (&msg, (void *)buf_, len_, NULL, NULL);
411
    if (rc != 0)
Uli Köhler's avatar
Uli Köhler committed
412 413
        return -1;

414 415
    rc = s_sendmsg (s, &msg, flags_);
    if (unlikely (rc < 0)) {
Uli Köhler's avatar
Uli Köhler committed
416 417 418 419 420 421 422 423
        int err = errno;
        int rc2 = zmq_msg_close (&msg);
        errno_assert (rc2 == 0);
        errno = err;
        return -1;
    }
    //  Note the optimisation here. We don't close the msg object as it is
    //  empty anyway. This may change when implementation of zmq_msg_t changes.
424
    return rc;
425 426
}

427

skaller's avatar
skaller committed
428
// Send multiple messages.
429
// TODO: this function has no man page
skaller's avatar
skaller committed
430 431 432
//
// If flag bit ZMQ_SNDMORE is set the vector is treated as
// a single multi-part message, i.e. the last message has
skaller's avatar
skaller committed
433
// ZMQ_SNDMORE bit switched off.
skaller's avatar
skaller committed
434
//
435
int zmq_sendiov (void *s_, iovec *a_, size_t count_, int flags_)
skaller's avatar
skaller committed
436
{
437 438
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
skaller's avatar
skaller committed
439
        return -1;
440 441 442 443 444
    if (unlikely (count_ <= 0 || !a_)) {
        errno = EINVAL;
        return -1;
    }

skaller's avatar
skaller committed
445 446
    int rc = 0;
    zmq_msg_t msg;
447

448
    for (size_t i = 0; i < count_; ++i) {
skaller's avatar
skaller committed
449
        rc = zmq_msg_init_size (&msg, a_[i].iov_len);
450
        if (rc != 0) {
skaller's avatar
skaller committed
451 452 453 454
            rc = -1;
            break;
        }
        memcpy (zmq_msg_data (&msg), a_[i].iov_base, a_[i].iov_len);
455 456
        if (i == count_ - 1)
            flags_ = flags_ & ~ZMQ_SNDMORE;
457 458
        rc = s_sendmsg (s, &msg, flags_);
        if (unlikely (rc < 0)) {
skaller's avatar
skaller committed
459 460 461 462 463 464 465 466
           int err = errno;
           int rc2 = zmq_msg_close (&msg);
           errno_assert (rc2 == 0);
           errno = err;
           rc = -1;
           break;
        }
    }
467
    return rc;
skaller's avatar
skaller committed
468 469
}

470 471
// Receiving functions.

472
static int
473
s_recvmsg (zmq::socket_base_t *s_, zmq_msg_t *msg_, int flags_)
skaller's avatar
skaller committed
474
{
475
    int rc = s_->recv ((zmq::msg_t *) msg_, flags_);
skaller's avatar
skaller committed
476 477
    if (unlikely (rc < 0))
        return -1;
478 479

    //  Truncate returned size to INT_MAX to avoid overflow to negative values
Min RK's avatar
Min RK committed
480
    size_t sz = zmq_msg_size (msg_);
481
    return (int) (sz < INT_MAX? sz: INT_MAX);
skaller's avatar
skaller committed
482 483
}

484
/*  To be deprecated once zmq_msg_recv() is stable                           */
skaller's avatar
skaller committed
485 486
int zmq_recvmsg (void *s_, zmq_msg_t *msg_, int flags_)
{
487
    return zmq_msg_recv (msg_, s_, flags_);
skaller's avatar
skaller committed
488 489 490
}


491
int zmq_recv (void *s_, void *buf_, size_t len_, int flags_)
492
{
493 494
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
skaller's avatar
skaller committed
495
        return -1;
496 497 498 499
    zmq_msg_t msg;
    int rc = zmq_msg_init (&msg);
    errno_assert (rc == 0);

500
    int nbytes = s_recvmsg (s, &msg, flags_);
501
    if (unlikely (nbytes < 0)) {
502
        int err = errno;
503 504
        rc = zmq_msg_close (&msg);
        errno_assert (rc == 0);
505 506 507 508
        errno = err;
        return -1;
    }

509
    //  An oversized message is silently truncated.
510
    size_t to_copy = size_t (nbytes) < len_ ? size_t (nbytes) : len_;
511

512 513 514 515 516
    //  We explicitly allow a null buffer argument if len is zero
    if (to_copy) {
        assert (buf_);
        memcpy (buf_, zmq_msg_data (&msg), to_copy);
    }
517 518 519
    rc = zmq_msg_close (&msg);
    errno_assert (rc == 0);

520
    return nbytes;
521 522
}

skaller's avatar
skaller committed
523
// Receive a multi-part message
524
//
skaller's avatar
skaller committed
525 526 527 528 529 530 531 532 533 534
// Receives up to *count_ parts of a multi-part message.
// Sets *count_ to the actual number of parts read.
// ZMQ_RCVMORE is set to indicate if a complete multi-part message was read.
// Returns number of message parts read, or -1 on error.
//
// Note: even if -1 is returned, some parts of the message
// may have been read. Therefore the client must consult
// *count_ to retrieve message parts successfully read,
// even if -1 is returned.
//
535
// The iov_base* buffers of each iovec *a_ filled in by this
skaller's avatar
skaller committed
536
// function may be freed using free().
537
// TODO: this function has no man page
skaller's avatar
skaller committed
538
//
539
int zmq_recviov (void *s_, iovec *a_, size_t *count_, int flags_)
skaller's avatar
skaller committed
540
{
541 542
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
skaller's avatar
skaller committed
543
        return -1;
544 545 546 547 548
    if (unlikely (!count_ || *count_ <= 0 || !a_)) {
        errno = EINVAL;
        return -1;
    }

549
    size_t count = *count_;
skaller's avatar
skaller committed
550 551
    int nread = 0;
    bool recvmore = true;
552

553
    *count_ = 0;
skaller's avatar
skaller committed
554

555
    for (size_t i = 0; recvmore && i < count; ++i) {
556

skaller's avatar
skaller committed
557 558 559 560
        zmq_msg_t msg;
        int rc = zmq_msg_init (&msg);
        errno_assert (rc == 0);

561
        int nbytes = s_recvmsg (s, &msg, flags_);
skaller's avatar
skaller committed
562 563 564 565 566 567 568 569 570 571
        if (unlikely (nbytes < 0)) {
            int err = errno;
            rc = zmq_msg_close (&msg);
            errno_assert (rc == 0);
            errno = err;
            nread = -1;
            break;
        }

        a_[i].iov_len = zmq_msg_size (&msg);
572
        a_[i].iov_base = static_cast<char *> (malloc(a_[i].iov_len));
573
        if (unlikely (!a_[i].iov_base)) {
574 575 576 577 578
            errno = ENOMEM;
            return -1;
        }
        memcpy(a_[i].iov_base,static_cast<char *> (zmq_msg_data (&msg)),
               a_[i].iov_len);
skaller's avatar
skaller committed
579
        // Assume zmq_socket ZMQ_RVCMORE is properly set.
meox's avatar
meox committed
580 581
        zmq::msg_t* p_msg = reinterpret_cast<zmq::msg_t*>(&msg);
        recvmore = p_msg->flags() & zmq::msg_t::more;
582 583 584 585
        rc = zmq_msg_close(&msg);
        errno_assert (rc == 0);
        ++*count_;
        ++nread;
skaller's avatar
skaller committed
586
    }
587
    return nread;
skaller's avatar
skaller committed
588 589
}

590 591
// Message manipulators.

592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
int zmq_msg_init (zmq_msg_t *msg_)
{
    return ((zmq::msg_t*) msg_)->init ();
}

int zmq_msg_init_size (zmq_msg_t *msg_, size_t size_)
{
    return ((zmq::msg_t*) msg_)->init_size (size_);
}

int zmq_msg_init_data (zmq_msg_t *msg_, void *data_, size_t size_,
    zmq_free_fn *ffn_, void *hint_)
{
    return ((zmq::msg_t*) msg_)->init_data (data_, size_, ffn_, hint_);
}

608
int zmq_msg_send (zmq_msg_t *msg_, void *s_, int flags_)
609
{
610 611
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
612
        return -1;
613
    return s_sendmsg (s, msg_, flags_);
614 615
}

616
int zmq_msg_recv (zmq_msg_t *msg_, void *s_, int flags_)
617
{
618 619
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
620
        return -1;
621
    return s_recvmsg (s, msg_, flags_);
622 623
}

624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
int zmq_msg_close (zmq_msg_t *msg_)
{
    return ((zmq::msg_t*) msg_)->close ();
}

int zmq_msg_move (zmq_msg_t *dest_, zmq_msg_t *src_)
{
    return ((zmq::msg_t*) dest_)->move (*(zmq::msg_t*) src_);
}

int zmq_msg_copy (zmq_msg_t *dest_, zmq_msg_t *src_)
{
    return ((zmq::msg_t*) dest_)->copy (*(zmq::msg_t*) src_);
}

void *zmq_msg_data (zmq_msg_t *msg_)
{
    return ((zmq::msg_t*) msg_)->data ();
}

644
size_t zmq_msg_size (const zmq_msg_t *msg_)
645 646 647 648
{
    return ((zmq::msg_t*) msg_)->size ();
}

649
int zmq_msg_more (const zmq_msg_t *msg_)
650
{
651
    return zmq_msg_get (msg_, ZMQ_MORE);
652 653
}

654
int zmq_msg_get (const zmq_msg_t *msg_, int property_)
655
{
656 657
    const char* fd_string;

658
    switch (property_) {
659
        case ZMQ_MORE:
660
            return (((zmq::msg_t*) msg_)->flags () & zmq::msg_t::more)? 1: 0;
661
        case ZMQ_SRCFD:
662 663 664 665 666
            fd_string = zmq_msg_gets(msg_, "__fd");
            if (fd_string == NULL)
                return (int)-1;

            return atoi(fd_string);
667
        case ZMQ_SHARED:
668 669
            return (((zmq::msg_t*) msg_)->is_cmsg ()) ||
                   (((zmq::msg_t*) msg_)->flags () & zmq::msg_t::shared)? 1: 0;
670
        default:
671 672
            errno = EINVAL;
            return -1;
673 674 675
    }
}

676
int zmq_msg_set (zmq_msg_t *, int, int)
677
{
678
    //  No properties supported at present
679 680
    errno = EINVAL;
    return -1;
681 682
}

683 684
int zmq_msg_set_routing_id (zmq_msg_t *msg_, uint32_t routing_id_)
{
685
    return ((zmq::msg_t *) msg_)->set_routing_id (routing_id_);
686 687
}

688
uint32_t zmq_msg_routing_id (zmq_msg_t *msg_)
689
{
690
    return ((zmq::msg_t *) msg_)->get_routing_id ();
691
}
692

somdoron's avatar
somdoron committed
693 694 695 696 697 698 699 700 701 702
int zmq_msg_set_group (zmq_msg_t *msg_, const char *group_)
{
    return ((zmq::msg_t *) msg_)->set_group (group_);
}

const char *zmq_msg_group (zmq_msg_t *msg_)
{
    return ((zmq::msg_t *) msg_)->group ();
}

703 704
//  Get message metadata string

705
const char *zmq_msg_gets (const zmq_msg_t *msg_, const char *property_)
706
{
707
    zmq::metadata_t *metadata = ((zmq::msg_t *) msg_)->metadata ();
708
    const char *value = NULL;
709
    if (metadata)
710 711 712 713 714
        value = metadata->get (std::string (property_));
    if (value)
        return value;
    else {
        errno = EINVAL;
715
        return NULL;
716
    }
717 718
}

719 720
// Polling.

721 722 723 724 725
#if defined ZMQ_HAVE_POLLER
inline int zmq_poller_poll (zmq_pollitem_t *items_, int nitems_, long timeout_)
{
    // implement zmq_poll on top of zmq_poller
    int rc;
726
    zmq_poller_event_t *events;
727
    zmq::socket_poller_t poller;
728
    events = new (std::nothrow) zmq_poller_event_t[nitems_];
729 730
    alloc_assert(events);

731
    bool repeat_items = false;
732 733
    //  Register sockets with poller
    for (int i = 0; i < nitems_; i++) {
734
        items_[i].revents = 0;
735 736 737

        bool modify = false;
        short e = items_[i].events;
738 739
        if (items_[i].socket) {
            //  Poll item is a 0MQ socket.
740 741 742 743 744 745 746 747 748
            for (int j = 0; j < i; ++j) {
                // Check for repeat entries
                if (items_[j].socket == items_[i].socket) {
                    repeat_items = true;
                    modify = true;
                    e |= items_[j].events;
                }
            }
            if (modify) {
749
                rc = zmq_poller_modify (&poller, items_[i].socket, e);
750
            } else {
751
                rc = zmq_poller_add (&poller, items_[i].socket, NULL, e);
752
            }
753
            if (rc < 0) {
754
                delete [] events;
755 756 757 758
                return rc;
            }
        } else {
            //  Poll item is a raw file descriptor.
759 760
            for (int j = 0; j < i; ++j) {
                // Check for repeat entries
761
                if (!items_[j].socket && items_[j].fd == items_[i].fd) {
762 763 764 765 766 767
                    repeat_items = true;
                    modify = true;
                    e |= items_[j].events;
                }
            }
            if (modify) {
768
                rc = zmq_poller_modify_fd (&poller, items_[i].fd, e);
769
            } else {
770
                rc = zmq_poller_add_fd (&poller, items_[i].fd, NULL, e);
771
            }
772
            if (rc < 0) {
773
                delete [] events;
774 775 776 777 778 779
                return rc;
            }
        }
    }

    //  Wait for events
780
    rc = zmq_poller_wait_all (&poller, events, nitems_, timeout_);
781
    if (rc < 0) {
782
        delete [] events;
783
        if (zmq_errno() == EAGAIN) {
Min RK's avatar
Min RK committed
784 785
            return 0;
        }
786 787 788
        return rc;
    }

789
    //  Transform poller events into zmq_pollitem events.
790
    //  items_ contains all items, while events only contains fired events.
791 792
    //  If no sockets are repeated (likely), the two are still co-ordered, so step through the items
    //  checking for matches only on the first event.
793 794 795 796 797 798 799
    //  If there are repeat items, they cannot be assumed to be co-ordered,
    //  so each pollitem must check fired events from the beginning.
    int j_start = 0, found_events = rc;
    for (int i = 0; i < nitems_; i++) {
        for (int j = j_start; j < found_events; ++j) {
            if (
                (items_[i].socket && items_[i].socket == events[j].socket) ||
800
                (!(items_[i].socket || events[j].socket) && items_[i].fd == events[j].fd)
801 802 803 804 805 806 807 808 809 810 811 812
            ) {
                items_[i].revents = events[j].events & items_[i].events;
                if (!repeat_items) {
                    // no repeats, we can ignore events we've already seen
                    j_start++;
                }
                break;
            }
            if (!repeat_items) {
                // no repeats, never have to look at j > j_start
                break;
            }
813
        }
814 815 816
    }

    //  Cleanup
817
    delete [] events;
818 819 820 821
    return rc;
}
#endif // ZMQ_HAVE_POLLER

822 823
int zmq_poll (zmq_pollitem_t *items_, int nitems_, long timeout_)
{
824 825
    //  TODO: the function implementation can just call zmq_pollfd_poll with
    //  pollfd as NULL, however pollfd is not yet stable.
826 827 828 829
#if defined ZMQ_HAVE_POLLER
    // if poller is present, use that.
    return zmq_poller_poll(items_, nitems_, timeout_);
#else
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
#if defined ZMQ_POLL_BASED_ON_POLL
    if (unlikely (nitems_ < 0)) {
        errno = EINVAL;
        return -1;
    }
    if (unlikely (nitems_ == 0)) {
        if (timeout_ == 0)
            return 0;
#if defined ZMQ_HAVE_WINDOWS
        Sleep (timeout_ > 0 ? timeout_ : INFINITE);
        return 0;
#elif defined ZMQ_HAVE_ANDROID
        usleep (timeout_ * 1000);
        return 0;
#else
        return usleep (timeout_ * 1000);
#endif
    }

    if (!items_) {
        errno = EFAULT;
        return -1;
    }

    zmq::clock_t clock;
    uint64_t now = 0;
    uint64_t end = 0;
    pollfd spollfds[ZMQ_POLLITEMS_DFLT];
    pollfd *pollfds = spollfds;

    if (nitems_ > ZMQ_POLLITEMS_DFLT) {
        pollfds = (pollfd*) malloc (nitems_ * sizeof (pollfd));
        alloc_assert (pollfds);
    }

    //  Build pollset for poll () system call.
    for (int i = 0; i != nitems_; i++) {

        //  If the poll item is a 0MQ socket, we poll on the file descriptor
        //  retrieved by the ZMQ_FD socket option.
        if (items_ [i].socket) {
            size_t zmq_fd_size = sizeof (zmq::fd_t);
            if (zmq_getsockopt (items_ [i].socket, ZMQ_FD, &pollfds [i].fd,
                &zmq_fd_size) == -1) {
                if (pollfds != spollfds)
                    free (pollfds);
                return -1;
            }
            pollfds [i].events = items_ [i].events ? POLLIN : 0;
        }
        //  Else, the poll item is a raw file descriptor. Just convert the
        //  events to normal POLLIN/POLLOUT for poll ().
        else {
            pollfds [i].fd = items_ [i].fd;
            pollfds [i].events =
                (items_ [i].events & ZMQ_POLLIN ? POLLIN : 0) |
                (items_ [i].events & ZMQ_POLLOUT ? POLLOUT : 0) |
                (items_ [i].events & ZMQ_POLLPRI ? POLLPRI : 0);
        }
    }

    bool first_pass = true;
    int nevents = 0;

    while (true) {
        //  Compute the timeout for the subsequent poll.
        int timeout;
        if (first_pass)
            timeout = 0;
        else
        if (timeout_ < 0)
            timeout = -1;
        else
            timeout = end - now;

        //  Wait for events.
906
        {
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
            int rc = poll (pollfds, nitems_, timeout);
            if (rc == -1 && errno == EINTR) {
                if (pollfds != spollfds)
                    free (pollfds);
                return -1;
            }
            errno_assert (rc >= 0);
        }
        //  Check for the events.
        for (int i = 0; i != nitems_; i++) {

            items_ [i].revents = 0;

            //  The poll item is a 0MQ socket. Retrieve pending events
            //  using the ZMQ_EVENTS socket option.
            if (items_ [i].socket) {
                size_t zmq_events_size = sizeof (uint32_t);
                uint32_t zmq_events;
                if (zmq_getsockopt (items_ [i].socket, ZMQ_EVENTS, &zmq_events,
                    &zmq_events_size) == -1) {
                    if (pollfds != spollfds)
                        free (pollfds);
                    return -1;
                }
                if ((items_ [i].events & ZMQ_POLLOUT) &&
                      (zmq_events & ZMQ_POLLOUT))
                    items_ [i].revents |= ZMQ_POLLOUT;
                if ((items_ [i].events & ZMQ_POLLIN) &&
                      (zmq_events & ZMQ_POLLIN))
                    items_ [i].revents |= ZMQ_POLLIN;
            }
            //  Else, the poll item is a raw file descriptor, simply convert
            //  the events to zmq_pollitem_t-style format.
            else {
                if (pollfds [i].revents & POLLIN)
                    items_ [i].revents |= ZMQ_POLLIN;
                if (pollfds [i].revents & POLLOUT)
                    items_ [i].revents |= ZMQ_POLLOUT;
                if (pollfds [i].revents & POLLPRI)
                   items_ [i].revents |= ZMQ_POLLPRI;
                if (pollfds [i].revents & ~(POLLIN | POLLOUT | POLLPRI))
                    items_ [i].revents |= ZMQ_POLLERR;
            }

            if (items_ [i].revents)
                nevents++;
        }

955
        //  If timeout is zero, exit immediately whether there are events or not.
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
        if (timeout_ == 0)
            break;

        //  If there are events to return, we can exit immediately.
        if (nevents)
            break;

        //  At this point we are meant to wait for events but there are none.
        //  If timeout is infinite we can just loop until we get some events.
        if (timeout_ < 0) {
            if (first_pass)
                first_pass = false;
            continue;
        }

        //  The timeout is finite and there are no events. In the first pass
        //  we get a timestamp of when the polling have begun. (We assume that
        //  first pass have taken negligible time). We also compute the time
        //  when the polling should time out.
        if (first_pass) {
            now = clock.now_ms ();
            end = now + timeout_;
            if (now == end)
                break;
            first_pass = false;
            continue;
        }

        //  Find out whether timeout have expired.
        now = clock.now_ms ();
        if (now >= end)
            break;
    }

    if (pollfds != spollfds)
        free (pollfds);
    return nevents;

#elif defined ZMQ_POLL_BASED_ON_SELECT

    if (unlikely (nitems_ < 0)) {
        errno = EINVAL;
        return -1;
    }
    if (unlikely (nitems_ == 0)) {
        if (timeout_ == 0)
            return 0;
#if defined ZMQ_HAVE_WINDOWS
        Sleep (timeout_ > 0 ? timeout_ : INFINITE);
        return 0;
#else
        return usleep (timeout_ * 1000);
#endif
    }
    zmq::clock_t clock;
    uint64_t now = 0;
    uint64_t end = 0;

    //  Ensure we do not attempt to select () on more than FD_SETSIZE
    //  file descriptors.
    zmq_assert (nitems_ <= FD_SETSIZE);

1018 1019 1020 1021 1022 1023
    fd_set pollset_in;
    FD_ZERO (&pollset_in);
    fd_set pollset_out;
    FD_ZERO (&pollset_out);
    fd_set pollset_err;
    FD_ZERO (&pollset_err);
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083

    zmq::fd_t maxfd = 0;

    //  Build the fd_sets for passing to select ().
    for (int i = 0; i != nitems_; i++) {

        //  If the poll item is a 0MQ socket we are interested in input on the
        //  notification file descriptor retrieved by the ZMQ_FD socket option.
        if (items_ [i].socket) {
            size_t zmq_fd_size = sizeof (zmq::fd_t);
            zmq::fd_t notify_fd;
            if (zmq_getsockopt (items_ [i].socket, ZMQ_FD, &notify_fd,
                &zmq_fd_size) == -1)
                return -1;
            if (items_ [i].events) {
                FD_SET (notify_fd, &pollset_in);
                if (maxfd < notify_fd)
                    maxfd = notify_fd;
            }
        }
        //  Else, the poll item is a raw file descriptor. Convert the poll item
        //  events to the appropriate fd_sets.
        else {
            if (items_ [i].events & ZMQ_POLLIN)
                FD_SET (items_ [i].fd, &pollset_in);
            if (items_ [i].events & ZMQ_POLLOUT)
                FD_SET (items_ [i].fd, &pollset_out);
            if (items_ [i].events & ZMQ_POLLERR)
                FD_SET (items_ [i].fd, &pollset_err);
            if (maxfd < items_ [i].fd)
                maxfd = items_ [i].fd;
        }
    }

    bool first_pass = true;
    int nevents = 0;
    fd_set inset, outset, errset;

    while (true) {

        //  Compute the timeout for the subsequent poll.
        timeval timeout;
        timeval *ptimeout;
        if (first_pass) {
            timeout.tv_sec = 0;
            timeout.tv_usec = 0;
            ptimeout = &timeout;
        }
        else
        if (timeout_ < 0)
            ptimeout = NULL;
        else {
            timeout.tv_sec = (long) ((end - now) / 1000);
            timeout.tv_usec = (long) ((end - now) % 1000 * 1000);
            ptimeout = &timeout;
        }

        //  Wait for events. Ignore interrupts if there's infinite timeout.
        while (true) {
#if defined ZMQ_HAVE_WINDOWS
1084 1085 1086 1087 1088 1089 1090
            // On Windows we don't need to copy the whole fd_set.
            // SOCKETS are continuous from the beginning of fd_array in fd_set.
            // We just need to copy fd_count elements of fd_array.
            // We gain huge memcpy() improvement if number of used SOCKETs is much lower than FD_SETSIZE.
            memcpy (&inset,  &pollset_in , (char *) (pollset_in.fd_array  + pollset_in.fd_count ) - (char *) &pollset_in );
            memcpy (&outset, &pollset_out, (char *) (pollset_out.fd_array + pollset_out.fd_count) - (char *) &pollset_out);
            memcpy (&errset, &pollset_err, (char *) (pollset_err.fd_array + pollset_err.fd_count) - (char *) &pollset_err);
1091 1092 1093 1094 1095 1096 1097
            int rc = select (0, &inset, &outset, &errset, ptimeout);
            if (unlikely (rc == SOCKET_ERROR)) {
                errno = zmq::wsa_error_to_errno (WSAGetLastError ());
                wsa_assert (errno == ENOTSOCK);
                return -1;
            }
#else
1098 1099 1100
            memcpy (&inset,  &pollset_in,  sizeof (fd_set));
            memcpy (&outset, &pollset_out, sizeof (fd_set));
            memcpy (&errset, &pollset_err, sizeof (fd_set));
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
            int rc = select (maxfd + 1, &inset, &outset, &errset, ptimeout);
            if (unlikely (rc == -1)) {
                errno_assert (errno == EINTR || errno == EBADF);
                return -1;
            }
#endif
            break;
        }

        //  Check for the events.
        for (int i = 0; i != nitems_; i++) {

            items_ [i].revents = 0;

            //  The poll item is a 0MQ socket. Retrieve pending events
            //  using the ZMQ_EVENTS socket option.
            if (items_ [i].socket) {
                size_t zmq_events_size = sizeof (uint32_t);
                uint32_t zmq_events;
                if (zmq_getsockopt (items_ [i].socket, ZMQ_EVENTS, &zmq_events,
                      &zmq_events_size) == -1)
                    return -1;
                if ((items_ [i].events & ZMQ_POLLOUT) &&
                      (zmq_events & ZMQ_POLLOUT))
                    items_ [i].revents |= ZMQ_POLLOUT;
                if ((items_ [i].events & ZMQ_POLLIN) &&
                      (zmq_events & ZMQ_POLLIN))
                    items_ [i].revents |= ZMQ_POLLIN;
            }
            //  Else, the poll item is a raw file descriptor, simply convert
            //  the events to zmq_pollitem_t-style format.
            else {
                if (FD_ISSET (items_ [i].fd, &inset))
                    items_ [i].revents |= ZMQ_POLLIN;
                if (FD_ISSET (items_ [i].fd, &outset))
                    items_ [i].revents |= ZMQ_POLLOUT;
                if (FD_ISSET (items_ [i].fd, &errset))
                    items_ [i].revents |= ZMQ_POLLERR;
            }

            if (items_ [i].revents)
                nevents++;
        }

1145
        //  If timeout is zero, exit immediately whether there are events or not.
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
        if (timeout_ == 0)
            break;

        //  If there are events to return, we can exit immediately.
        if (nevents)
            break;

        //  At this point we are meant to wait for events but there are none.
        //  If timeout is infinite we can just loop until we get some events.
        if (timeout_ < 0) {
            if (first_pass)
                first_pass = false;
            continue;
        }

        //  The timeout is finite and there are no events. In the first pass
        //  we get a timestamp of when the polling have begun. (We assume that
        //  first pass have taken negligible time). We also compute the time
        //  when the polling should time out.
        if (first_pass) {
            now = clock.now_ms ();
            end = now + timeout_;
            if (now == end)
                break;
            first_pass = false;
            continue;
        }

        //  Find out whether timeout have expired.
        now = clock.now_ms ();
        if (now >= end)
          break;
    }

    return nevents;

#else
    //  Exotic platforms that support neither poll() nor select().
    errno = ENOTSUP;
    return -1;
#endif
1187
#endif // ZMQ_HAVE_POLLER
1188
}
1189

1190 1191
//  The poller functionality

1192
void *zmq_poller_new (void)
1193 1194 1195 1196 1197 1198
{
    zmq::socket_poller_t *poller = new (std::nothrow) zmq::socket_poller_t;
    alloc_assert (poller);
    return poller;
}

1199
int zmq_poller_destroy (void **poller_p_)
1200
{
1201 1202 1203
    void *poller;
    if (!poller_p_ || !(poller = *poller_p_) ||
            !((zmq::socket_poller_t*) poller)->check_tag ()) {
1204 1205 1206 1207
        errno = EFAULT;
        return -1;
    }

1208 1209
    delete ((zmq::socket_poller_t*) poller);
    *poller_p_ = NULL;
1210 1211 1212
    return 0;
}

1213
int zmq_poller_add (void *poller_, void *s_, void *user_data_, short events_)
1214 1215 1216 1217 1218 1219
{
    if (!poller_ || !((zmq::socket_poller_t*)poller_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }

1220 1221 1222 1223 1224 1225 1226
    if (!s_ || !((zmq::socket_base_t*)s_)->check_tag ()) {
        errno = ENOTSOCK;
        return -1;
    }
    zmq::socket_base_t *socket = (zmq::socket_base_t*)s_;

    return ((zmq::socket_poller_t*)poller_)->add (socket, user_data_, events_);
1227 1228 1229
}

#if defined _WIN32
1230
int zmq_poller_add_fd (void *poller_, SOCKET fd_, void *user_data_, short events_)
1231
#else
1232
int zmq_poller_add_fd (void *poller_, int fd_, void *user_data_, short events_)
1233 1234 1235 1236 1237 1238
#endif
{
    if (!poller_ || !((zmq::socket_poller_t*)poller_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }
1239
    if (fd_ == zmq::retired_fd) {
1240
        errno = EBADF;
1241 1242
        return -1;
    }
1243

1244
    return ((zmq::socket_poller_t*)poller_)->add_fd (fd_, user_data_, events_);
1245 1246
}

1247

1248
int zmq_poller_modify (void *poller_, void *s_, short events_)
1249 1250 1251 1252 1253 1254
{
    if (!poller_ || !((zmq::socket_poller_t*)poller_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }

1255 1256 1257 1258 1259 1260 1261
    if (!s_ || !((zmq::socket_base_t*)s_)->check_tag ()) {
        errno = ENOTSOCK;
        return -1;
    }
    zmq::socket_base_t *socket = (zmq::socket_base_t*)s_;

    return ((zmq::socket_poller_t*)poller_)->modify (socket, events_);
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
}


#if defined _WIN32
int zmq_poller_modify_fd (void *poller_, SOCKET fd_, short events_)
#else
int zmq_poller_modify_fd (void *poller_, int fd_, short events_)
#endif
{
    if (!poller_ || !((zmq::socket_poller_t*)poller_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }
1275
    if (fd_ == zmq::retired_fd) {
1276
        errno = EBADF;
1277 1278
        return -1;
    }
1279 1280 1281 1282 1283

    return ((zmq::socket_poller_t*)poller_)->modify_fd (fd_, events_);
}


1284
int zmq_poller_remove (void *poller_, void *s_)
1285 1286 1287 1288
{
    if (!poller_ || !((zmq::socket_poller_t*)poller_)->check_tag ()) {
        errno = EFAULT;
        return -1;
somdoron's avatar
somdoron committed
1289
    }
1290

1291 1292 1293 1294 1295 1296
    if (!s_ || !((zmq::socket_base_t*)s_)->check_tag ()) {
        errno = ENOTSOCK;
        return -1;
    }
    zmq::socket_base_t *socket = (zmq::socket_base_t*)s_;

1297
    return ((zmq::socket_poller_t*)poller_)->remove (socket);
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
}

#if defined _WIN32
int zmq_poller_remove_fd (void *poller_, SOCKET fd_)
#else
int zmq_poller_remove_fd (void *poller_, int fd_)
#endif
{
    if (!poller_ || !((zmq::socket_poller_t*)poller_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }
1310
    if (fd_ == zmq::retired_fd) {
1311
        errno = EBADF;
1312 1313
        return -1;
    }
1314 1315 1316

    return ((zmq::socket_poller_t*)poller_)->remove_fd (fd_);
}
somdoron's avatar
somdoron committed
1317

1318

1319
int zmq_poller_wait (void *poller_, zmq_poller_event_t *event_, long timeout_)
1320 1321 1322 1323 1324
{
    if (!poller_ || !((zmq::socket_poller_t*)poller_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }
1325 1326 1327 1328
    if (!event_) {
        errno = EFAULT;
        return -1;
    }
1329

1330
    int rc = zmq_poller_wait_all(poller_, event_, 1, timeout_);
1331

1332
    if (rc < 0) {
1333
        memset (event_, 0, sizeof(zmq_poller_event_t));
1334
    }
1335 1336
    // wait_all returns number of events, but we return 0 for any success
    return rc >= 0 ? 0 : rc;
1337 1338
}

1339
int zmq_poller_wait_all (void *poller_, zmq_poller_event_t *events_, int n_events, long timeout_)
1340 1341 1342 1343 1344
{
    if (!poller_ || !((zmq::socket_poller_t*)poller_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }
1345 1346 1347 1348
    if (!events_) {
        errno = EFAULT;
        return -1;
    }
1349 1350 1351 1352
    if (n_events < 0) {
        errno = EINVAL;
        return -1;
    }
1353

1354
    int rc = ((zmq::socket_poller_t*)poller_)->wait ((zmq::socket_poller_t::event_t *)events_, n_events, timeout_);
1355 1356 1357 1358

    return rc;
}

1359 1360
//  Peer-specific state

1361
int zmq_socket_get_peer_state (void *s_,
1362 1363
                               const void *routing_id_,
                               size_t routing_id_size_)
1364
{
1365 1366 1367 1368
    zmq::socket_base_t *s = as_socket_base_t (s_);
    if (!s)
        return -1;

1369
    return s->get_peer_state (routing_id_, routing_id_size_);
1370 1371
}

somdoron's avatar
somdoron committed
1372 1373
//  Timers

1374
void *zmq_timers_new (void)
somdoron's avatar
somdoron committed
1375 1376 1377 1378 1379 1380
{
    zmq::timers_t *timers = new (std::nothrow) zmq::timers_t;
    alloc_assert (timers);
    return timers;
}

1381
int zmq_timers_destroy (void **timers_p_)
somdoron's avatar
somdoron committed
1382
{
1383 1384
    void *timers = *timers_p_;
    if (!timers || !((zmq::timers_t *) timers)->check_tag ()) {
somdoron's avatar
somdoron committed
1385 1386 1387
        errno = EFAULT;
        return -1;
    }
1388 1389
    delete ((zmq::timers_t *) timers);
    *timers_p_ = NULL;
somdoron's avatar
somdoron committed
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
    return 0;
}

int zmq_timers_add (void *timers_, size_t interval_, zmq_timer_fn handler_, void *arg_)
{
    if (!timers_ || !((zmq::timers_t*)timers_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }

    return ((zmq::timers_t*)timers_)->add (interval_, handler_, arg_);
}

int zmq_timers_cancel (void *timers_, int timer_id_)
{
    if (!timers_ || !((zmq::timers_t*)timers_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }

    return ((zmq::timers_t*)timers_)->cancel (timer_id_);
}

int zmq_timers_set_interval (void *timers_, int timer_id_, size_t interval_)
{
    if (!timers_ || !((zmq::timers_t*)timers_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }

    return ((zmq::timers_t*)timers_)->set_interval (timer_id_, interval_);
}

int zmq_timers_reset (void *timers_, int timer_id_)
{
    if (!timers_ || !((zmq::timers_t*)timers_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }

    return ((zmq::timers_t*)timers_)->reset (timer_id_);
}

long zmq_timers_timeout (void *timers_)
{
    if (!timers_ || !((zmq::timers_t*)timers_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }

    return ((zmq::timers_t*)timers_)->timeout ();
}

int zmq_timers_execute (void *timers_)
{
    if (!timers_ || !((zmq::timers_t*)timers_)->check_tag ()) {
        errno = EFAULT;
        return -1;
    }

    return ((zmq::timers_t*)timers_)->execute ();
}

1453 1454
//  The proxy functionality

1455 1456
int zmq_proxy (void *frontend_, void *backend_, void *capture_)
{
1457 1458 1459 1460
    if (!frontend_ || !backend_) {
        errno = EFAULT;
        return -1;
    }
1461
    return zmq::proxy (
1462 1463
        (zmq::socket_base_t*) frontend_,
        (zmq::socket_base_t*) backend_,
1464 1465 1466 1467
        (zmq::socket_base_t*) capture_);
}

int zmq_proxy_steerable (void *frontend_, void *backend_, void *capture_, void *control_)
Pieter Hintjens's avatar
Pieter Hintjens committed
1468
{
1469 1470 1471 1472
    if (!frontend_ || !backend_) {
        errno = EFAULT;
        return -1;
    }
1473
    return zmq::proxy (
1474 1475
        (zmq::socket_base_t*) frontend_,
        (zmq::socket_base_t*) backend_,
1476
        (zmq::socket_base_t*) capture_,
1477 1478
        (zmq::socket_base_t*) control_);
}
Pieter Hintjens's avatar
Pieter Hintjens committed
1479

1480
//  The deprecated device functionality
Pieter Hintjens's avatar
Pieter Hintjens committed
1481

1482
int zmq_device (int /* type */, void *frontend_, void *backend_)
1483 1484
{
    return zmq::proxy (
1485
        (zmq::socket_base_t*) frontend_,
1486
        (zmq::socket_base_t*) backend_, NULL);
Pieter Hintjens's avatar
Pieter Hintjens committed
1487
}
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508

//  Probe library capabilities; for now, reports on transport and security

int zmq_has (const char *capability)
{
#if !defined (ZMQ_HAVE_WINDOWS) && !defined (ZMQ_HAVE_OPENVMS)
    if (strcmp (capability, "ipc") == 0)
        return true;
#endif
#if defined (ZMQ_HAVE_OPENPGM)
    if (strcmp (capability, "pgm") == 0)
        return true;
#endif
#if defined (ZMQ_HAVE_TIPC)
    if (strcmp (capability, "tipc") == 0)
        return true;
#endif
#if defined (ZMQ_HAVE_NORM)
    if (strcmp (capability, "norm") == 0)
        return true;
#endif
1509
#if defined (ZMQ_HAVE_CURVE)
1510 1511 1512 1513 1514 1515
    if (strcmp (capability, "curve") == 0)
        return true;
#endif
#if defined (HAVE_LIBGSSAPI_KRB5)
    if (strcmp (capability, "gssapi") == 0)
        return true;
Ilya Kulakov's avatar
Ilya Kulakov committed
1516 1517 1518 1519
#endif
#if defined (ZMQ_HAVE_VMCI)
    if (strcmp (capability, "vmci") == 0)
        return true;
1520 1521 1522 1523
#endif
#if defined (ZMQ_BUILD_DRAFT_API)
    if (strcmp (capability, "draft") == 0)
        return true;
1524 1525 1526 1527
#endif
    //  Whatever the application asked for, we don't have
    return false;
}