summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
Diffstat (limited to 'include')
-rw-r--r--include/zmq.h249
-rw-r--r--include/zmq.hpp266
2 files changed, 515 insertions, 0 deletions
diff --git a/include/zmq.h b/include/zmq.h
new file mode 100644
index 0000000..7d8d8ad
--- /dev/null
+++ b/include/zmq.h
@@ -0,0 +1,249 @@
+/*
+ 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_H_INCLUDED__
+#define __ZMQ_H_INCLUDED__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <errno.h>
+#include <stddef.h>
+#if defined _WIN32
+#include "winsock2.h"
+#endif
+
+// Microsoft Visual Studio uses non-standard way to export/import symbols.
+#if defined ZMQ_BUILDING_LIBZMQ_WITH_MSVC
+#define ZMQ_EXPORT __declspec(dllexport)
+#elif defined _MSC_VER
+#define ZMQ_EXPORT __declspec(dllimport)
+#else
+#define ZMQ_EXPORT
+#endif
+
+////////////////////////////////////////////////////////////////////////////////
+// 0MQ versioning supprt.
+////////////////////////////////////////////////////////////////////////////////
+
+ZMQ_EXPORT void zmq_version (int *major, int *minor, int *patch);
+
+////////////////////////////////////////////////////////////////////////////////
+// 0MQ errors.
+////////////////////////////////////////////////////////////////////////////////
+
+// A number random anough not to collide with different errno ranges on
+// different OSes. The assumption is that error_t is at least 32-bit type.
+#define ZMQ_HAUSNUMERO 156384712
+
+// On Windows platform some of the standard POSIX errnos are not defined.
+#ifndef ENOTSUP
+#define ENOTSUP (ZMQ_HAUSNUMERO + 1)
+#endif
+#ifndef EPROTONOSUPPORT
+#define EPROTONOSUPPORT (ZMQ_HAUSNUMERO + 2)
+#endif
+#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
+#ifndef ECONNREFUSED
+#define ECONNREFUSED (ZMQ_HAUSNUMERO + 7)
+#endif
+#ifndef EINPROGRESS
+#define EINPROGRESS (ZMQ_HAUSNUMERO + 8)
+#endif
+
+// Native 0MQ error codes.
+#define EMTHREAD (ZMQ_HAUSNUMERO + 50)
+#define EFSM (ZMQ_HAUSNUMERO + 51)
+#define ENOCOMPATPROTO (ZMQ_HAUSNUMERO + 52)
+
+// Resolves system errors and 0MQ errors to human-readable string.
+ZMQ_EXPORT const char *zmq_strerror (int errnum);
+
+////////////////////////////////////////////////////////////////////////////////
+// 0MQ message definition.
+////////////////////////////////////////////////////////////////////////////////
+
+// Maximal size of "Very Small Message". VSMs are passed by value
+// to avoid excessive memory allocation/deallocation.
+// If VMSs larger than 255 bytes are required, type of 'vsm_size'
+// field in zmq_msg_t structure should be modified accordingly.
+#define ZMQ_MAX_VSM_SIZE 30
+
+// Message types. These integers may be stored in 'content' member of the
+// message instead of regular pointer to the data.
+#define ZMQ_DELIMITER 31
+#define ZMQ_VSM 32
+
+// Message flags. ZMQ_MSG_SHARED is strictly speaking not a message flag
+// (it has no equivalent in the wire format), however, making it a flag
+// allows us to pack the stucture tigher and thus improve performance.
+#define ZMQ_MSG_TBC 1
+#define ZMQ_MSG_SHARED 128
+
+// A message. Note that 'content' is not a pointer to the raw data.
+// Rather it is pointer to zmq::msg_content_t structure
+// (see src/msg_content.hpp for its definition).
+typedef struct
+{
+ void *content;
+ unsigned char flags;
+ unsigned char vsm_size;
+ unsigned char vsm_data [ZMQ_MAX_VSM_SIZE];
+} zmq_msg_t;
+
+typedef void (zmq_free_fn) (void *data, void *hint);
+
+ZMQ_EXPORT int zmq_msg_init (zmq_msg_t *msg);
+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,
+ size_t size, zmq_free_fn *ffn, void *hint);
+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);
+ZMQ_EXPORT size_t zmq_msg_size (zmq_msg_t *msg);
+
+////////////////////////////////////////////////////////////////////////////////
+// 0MQ infrastructure (a.k.a. context) initialisation & termination.
+////////////////////////////////////////////////////////////////////////////////
+
+#define ZMQ_POLL 1
+
+ZMQ_EXPORT void *zmq_init (int app_threads, int io_threads, int flags);
+ZMQ_EXPORT int zmq_term (void *context);
+
+////////////////////////////////////////////////////////////////////////////////
+// 0MQ socket definition.
+////////////////////////////////////////////////////////////////////////////////
+
+// Addresses are composed of the name of the protocol to use followed by ://
+// and a protocol-specific address. Available protocols:
+//
+// tcp - the address is composed of IP address and port delimited by colon
+// sign (:). The IP address can be a hostname (with 'connect') or
+// a network interface name (with 'bind'). Examples "tcp://eth0:5555",
+// "tcp://192.168.0.1:20000", "tcp://hq.mycompany.com:80".
+//
+// pgm & udp - both protocols have same address format. It's network interface
+// to use, semicolon (;), multicast group IP address, colon (:) and
+// port. Examples: "pgm://eth2;224.0.0.1:8000",
+// "udp://192.168.0.111;224.1.1.1:5555".
+
+#define ZMQ_P2P 0
+#define ZMQ_PUB 1
+#define ZMQ_SUB 2
+#define ZMQ_REQ 3
+#define ZMQ_REP 4
+#define ZMQ_XREQ 5
+#define ZMQ_XREP 6
+#define ZMQ_UPSTREAM 7
+#define ZMQ_DOWNSTREAM 8
+
+#define ZMQ_HWM 1
+#define ZMQ_LWM 2
+#define ZMQ_SWAP 3
+#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_MCAST_LOOP 10
+#define ZMQ_SNDBUF 11
+#define ZMQ_RCVBUF 12
+
+#define ZMQ_NOBLOCK 1
+#define ZMQ_NOFLUSH 2
+
+ZMQ_EXPORT void *zmq_socket (void *context, int type);
+ZMQ_EXPORT int zmq_close (void *s);
+ZMQ_EXPORT int zmq_setsockopt (void *s, int option, const void *optval,
+ size_t optvallen);
+ZMQ_EXPORT int zmq_bind (void *s, const char *addr);
+ZMQ_EXPORT int zmq_connect (void *s, const char *addr);
+ZMQ_EXPORT int zmq_send (void *s, zmq_msg_t *msg, int flags);
+ZMQ_EXPORT int zmq_flush (void *s);
+ZMQ_EXPORT int zmq_recv (void *s, zmq_msg_t *msg, int flags);
+
+////////////////////////////////////////////////////////////////////////////////
+// I/O multiplexing.
+////////////////////////////////////////////////////////////////////////////////
+
+#define ZMQ_POLLIN 1
+#define ZMQ_POLLOUT 2
+#define ZMQ_POLLERR 4
+
+typedef struct
+{
+ void *socket;
+#if defined _WIN32
+ SOCKET fd;
+#else
+ int fd;
+#endif
+ short events;
+ short revents;
+} zmq_pollitem_t;
+
+ZMQ_EXPORT int zmq_poll (zmq_pollitem_t *items, int nitems, long timeout);
+
+////////////////////////////////////////////////////////////////////////////////
+// Experimental.
+////////////////////////////////////////////////////////////////////////////////
+
+// 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
+// compiled with different CRT library.
+ZMQ_EXPORT int zmq_errno ();
+
+////////////////////////////////////////////////////////////////////////////////
+// Helper functions.
+////////////////////////////////////////////////////////////////////////////////
+
+// 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 ();
+
+// 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_);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/include/zmq.hpp b/include/zmq.hpp
new file mode 100644
index 0000000..3ddc043
--- /dev/null
+++ b/include/zmq.hpp
@@ -0,0 +1,266 @@
+/*
+ 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_HPP_INCLUDED__
+#define __ZMQ_HPP_INCLUDED__
+
+#include "zmq.h"
+
+#include <assert.h>
+#include <string.h>
+#include <exception>
+
+namespace zmq
+{
+
+ typedef zmq_free_fn free_fn;
+ typedef zmq_pollitem_t pollitem_t;
+
+ class error_t : public std::exception
+ {
+ public:
+
+ error_t () : errnum (zmq_errno ()) {}
+
+ virtual const char *what () const throw ()
+ {
+ return zmq_strerror (errnum);
+ }
+
+ private:
+
+ int errnum;
+ };
+
+ inline int poll (zmq_pollitem_t *items_, int nitems_, long timeout_ = -1)
+ {
+ int rc = zmq_poll (items_, nitems_, timeout_);
+ if (rc < 0)
+ throw error_t ();
+ return rc;
+ }
+
+ class message_t : private zmq_msg_t
+ {
+ friend class socket_t;
+
+ public:
+
+ inline message_t ()
+ {
+ int rc = zmq_msg_init (this);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline message_t (size_t size_)
+ {
+ int rc = zmq_msg_init_size (this, size_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline message_t (void *data_, size_t size_, free_fn *ffn_,
+ void *hint_ = NULL)
+ {
+ int rc = zmq_msg_init_data (this, data_, size_, ffn_, hint_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline ~message_t ()
+ {
+ int rc = zmq_msg_close (this);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline void rebuild ()
+ {
+ int rc = zmq_msg_close (this);
+ if (rc != 0)
+ throw error_t ();
+ rc = zmq_msg_init (this);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline void rebuild (size_t size_)
+ {
+ int rc = zmq_msg_close (this);
+ if (rc != 0)
+ throw error_t ();
+ rc = zmq_msg_init_size (this, size_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline void rebuild (void *data_, size_t size_, free_fn *ffn_,
+ void *hint_ = NULL)
+ {
+ int rc = zmq_msg_close (this);
+ if (rc != 0)
+ throw error_t ();
+ rc = zmq_msg_init_data (this, data_, size_, ffn_, hint_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline void move (message_t *msg_)
+ {
+ int rc = zmq_msg_move (this, (zmq_msg_t*) msg_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline void copy (message_t *msg_)
+ {
+ int rc = zmq_msg_copy (this, (zmq_msg_t*) msg_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline void *data ()
+ {
+ return zmq_msg_data (this);
+ }
+
+ inline size_t size ()
+ {
+ return zmq_msg_size (this);
+ }
+
+ private:
+
+ // Disable implicit message copying, so that users won't use shared
+ // messages (less efficient) without being aware of the fact.
+ message_t (const message_t&);
+ void operator = (const message_t&);
+ };
+
+ class context_t
+ {
+ friend class socket_t;
+
+ public:
+
+ inline context_t (int app_threads_, int io_threads_, int flags_ = 0)
+ {
+ ptr = zmq_init (app_threads_, io_threads_, flags_);
+ if (ptr == NULL)
+ throw error_t ();
+ }
+
+ inline ~context_t ()
+ {
+ int rc = zmq_term (ptr);
+ assert (rc == 0);
+ }
+
+ private:
+
+ void *ptr;
+
+ context_t (const context_t&);
+ void operator = (const context_t&);
+ };
+
+ class socket_t
+ {
+ public:
+
+ inline socket_t (context_t &context_, int type_)
+ {
+ ptr = zmq_socket (context_.ptr, type_);
+ if (ptr == NULL)
+ throw error_t ();
+ }
+
+ inline ~socket_t ()
+ {
+ int rc = zmq_close (ptr);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline operator void* ()
+ {
+ return ptr;
+ }
+
+ inline void setsockopt (int option_, const void *optval_,
+ size_t optvallen_)
+ {
+ int rc = zmq_setsockopt (ptr, option_, optval_, optvallen_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline void bind (const char *addr_)
+ {
+ int rc = zmq_bind (ptr, addr_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline void connect (const char *addr_)
+ {
+ int rc = zmq_connect (ptr, addr_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline bool send (message_t &msg_, int flags_ = 0)
+ {
+ int rc = zmq_send (ptr, &msg_, flags_);
+ if (rc == 0)
+ return true;
+ if (rc == -1 && zmq_errno () == EAGAIN)
+ return false;
+ throw error_t ();
+ }
+
+ inline void flush ()
+ {
+ int rc = zmq_flush (ptr);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ inline bool recv (message_t *msg_, int flags_ = 0)
+ {
+ int rc = zmq_recv (ptr, msg_, flags_);
+ if (rc == 0)
+ return true;
+ if (rc == -1 && zmq_errno () == EAGAIN)
+ return false;
+ throw error_t ();
+ }
+
+ private:
+
+ void *ptr;
+
+ socket_t (const socket_t&);
+ void operator = (const socket_t&);
+ };
+
+}
+
+#endif
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-25 17:17:31 +0000