fd_signaler.hpp 2.37 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2010 iMatix Corporation
Martin Sustrik's avatar
Martin Sustrik committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

    This file is part of 0MQ.

    0MQ is free software; you can redistribute it and/or modify it under
    the terms of the Lesser GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    0MQ 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
    Lesser GNU General Public License for more details.

    You should have received a copy of the Lesser GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

Martin Sustrik's avatar
Martin Sustrik committed
20 21
#ifndef __ZMQ_FD_SIGNALER_HPP_INCLUDED__
#define __ZMQ_FD_SIGNALER_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
22 23 24 25 26 27

#include "platform.hpp"
#include "i_signaler.hpp"
#include "fd.hpp"
#include "stdint.hpp"

Martin Sustrik's avatar
Martin Sustrik committed
28
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42
{

    //  This object can be used to send individual signals from one thread to
    //  another. The specific of this pipe is that it has associated file
    //  descriptor and so it can be polled on. Same signal cannot be sent twice
    //  unless signals are retrieved by the reader side in the meantime.

    class fd_signaler_t : public i_signaler
    {
    public:

        fd_signaler_t ();
        ~fd_signaler_t ();

43
        //  i_signaler interface implementation.
Martin Sustrik's avatar
Martin Sustrik committed
44
        void signal (int signal_);
45 46
        uint64_t poll ();
        uint64_t check ();
Martin Sustrik's avatar
Martin Sustrik committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
        fd_t get_fd ();

    private:

#if defined ZMQ_HAVE_OPENVMS

         //  Whilst OpenVMS supports socketpair - it maps to AF_INET only.
         //  Further, it does not set the socket options TCP_NODELAY and
         //  TCP_NODELACK which can lead to performance problems. We'll
         //  overload the socketpair function for this class.
         //
         //  The bug will be fixed in V5.6 ECO4 and beyond.  In the
         //  meantime, we'll create the socket pair manually.
         static int socketpair (int domain_, int type_, int protocol_,
             int sv_ [2]);

#endif

Martin Sustrik's avatar
Martin Sustrik committed
65
#if defined ZMQ_HAVE_EVENTFD
Martin Sustrik's avatar
Martin Sustrik committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
        //  Eventfd descriptor.
        fd_t fd;
#else
        //  Write & read end of the socketpair.
        fd_t w;
        fd_t r;
#endif

        //  Disable copying of fd_signeler object.
        fd_signaler_t (const fd_signaler_t&);
        void operator = (const fd_signaler_t&);
    };

}

#endif