summaryrefslogtreecommitdiff
path: root/src/fd_signaler.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/fd_signaler.hpp')
-rw-r--r--src/fd_signaler.hpp92
1 files changed, 92 insertions, 0 deletions
diff --git a/src/fd_signaler.hpp b/src/fd_signaler.hpp
new file mode 100644
index 0000000..34c5e8c
--- /dev/null
+++ b/src/fd_signaler.hpp
@@ -0,0 +1,92 @@
+/*
+ Copyright (c) 2007-2009 FastMQ Inc.
+
+ 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 __ZS_FD_SIGNALER_HPP_INCLUDED__
+#define __ZS_FD_SIGNALER_HPP_INCLUDED__
+
+#include "platform.hpp"
+#include "i_signaler.hpp"
+#include "fd.hpp"
+#include "stdint.hpp"
+
+namespace zs
+{
+
+ // 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:
+
+ typedef uint64_t signals_t;
+
+ // Initialise the object.
+ fd_signaler_t ();
+
+ // Destroy the object.
+ ~fd_signaler_t ();
+
+ // Send specific signal.
+ void signal (int signal_);
+
+ // Retrieves signals. Returns a set of signals in form of a bitmap.
+ // Signal with index 0 corresponds to value 1, index 1 to value 2,
+ // index 2 to value 4 etc. If there is no signal available,
+ // it returns zero immediately.
+ signals_t check ();
+
+ // Get the file descriptor associated with the object.
+ 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
+
+#if defined ZS_HAVE_EVENTFD
+ // 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