libzmq/src/signaler.hpp

/*
    Copyright (c) 2007-2010 iMatix Corporation

    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/>.
*/

#ifndef __ZMQ_SIGNALER_HPP_INCLUDED__
#define __ZMQ_SIGNALER_HPP_INCLUDED__

#include <stddef.h>

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

namespace zmq
{

    //  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 signaler_t
    {
    public:

        signaler_t ();
        ~signaler_t ();

        static const uint32_t no_signal;

        void signal (uint32_t signal_);
        uint32_t poll ();
        uint32_t check ();
        fd_t get_fd ();

    private:

         void xpoll ();
         void xcheck ();

#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

        //  Write & read end of the socketpair.
        fd_t w;
        fd_t r;

        //  Signal buffer.
        uint32_t buffer [signal_buffer_size];

        //  Position of the next signal in the buffer to return to the user.
        size_t current;

        //  Number of signals in the signal buffer.
        size_t count;

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

}

#endif