summaryrefslogtreecommitdiff
path: root/bindings
diff options
context:
space:
mode:
Diffstat (limited to 'bindings')
-rw-r--r--bindings/c/zmq.h216
-rw-r--r--bindings/cpp/zmq.hpp283
-rw-r--r--bindings/java/Makefile.am2
3 files changed, 500 insertions, 1 deletions
diff --git a/bindings/c/zmq.h b/bindings/c/zmq.h
new file mode 100644
index 0000000..732ecb9
--- /dev/null
+++ b/bindings/c/zmq.h
@@ -0,0 +1,216 @@
+/*
+ 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 __ZMQ_H_INCLUDED__
+#define __ZMQ_H_INCLUDED__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stddef.h>
+
+#if defined ZMQ_BUILDING_LIBZMQ_WITH_MSVC
+#define ZMQ_EXPORT __declspec(dllexport)
+#else
+#define ZMQ_EXPORT
+#endif
+
+// 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 & notification types.
+#define ZMQ_GAP 1
+#define ZMQ_DELIMITER 31
+#define ZMQ_VSM 32
+
+// Socket options.
+#define ZMQ_HWM 1 // int64_t
+#define ZMQ_LWM 2 // int64_t
+#define ZMQ_SWAP 3 // int64_t
+#define ZMQ_AFFINITY 4 // int64_t
+#define ZMQ_IDENTITY 5 // string
+#define ZMQ_SUBSCRIBE 6 // string
+#define ZMQ_UNSUBSCRIBE 7 // string
+#define ZMQ_RATE 8 // int64_t
+#define ZMQ_RECOVERY_IVL 9 // int64_t
+#define ZMQ_MCAST_LOOP 10 // int64_t
+
+// The operation should be performed in non-blocking mode. I.e. if it cannot
+// be processed immediately, error should be returned with errno set to EAGAIN.
+#define ZMQ_NOBLOCK 1
+
+// zmq_send should not flush the message downstream immediately. Instead, it
+// should batch ZMQ_NOFLUSH messages and send them downstream only if zmq_flush
+// is invoked. This is an optimisation for cases where several messages are
+// sent in a single business transaction. However, the effect is measurable
+// only in extremely high-perf scenarios (million messages a second or so).
+// If that's not your case, use standard flushing send instead. See exchange
+// example for illustration of ZMQ_NOFLUSH functionality.
+#define ZMQ_NOFLUSH 2
+
+// Socket to communicate with a single peer. Allows for a singe connect or a
+// single accept. There's no message routing or message filtering involved.
+#define ZMQ_P2P 0
+
+// Socket to distribute data. Recv fuction is not implemented for this socket
+// type. Messages are distributed in fanout fashion to all peers.
+#define ZMQ_PUB 1
+
+// Socket to subscribe to distributed data. Send function is not implemented
+// for this socket type. However, subscribe function can be used to modify the
+// message filter.
+#define ZMQ_SUB 2
+
+// Socket to send requests on and receive replies from. Requests are
+// load-balanced among all the peers. This socket type doesn't allow for more
+// recv's that there were send's.
+#define ZMQ_REQ 3
+
+// Socket to receive requests from and send replies to. This socket type allows
+// only an alternated sequence of recv's and send's. Each send is routed to
+// the peer that the previous recv delivered message from.
+#define ZMQ_REP 4
+
+// Prototype for the message body deallocation functions.
+// It is deliberately defined in the way to comply with standard C free.
+typedef void (zmq_free_fn) (void *data);
+
+// A message. If 'shared' is true, message content pointed to by 'content'
+// is shared, i.e. reference counting is used to manage its lifetime
+// rather than straighforward malloc/free. struct zmq_msg_content is
+// not declared in the API.
+struct zmq_msg_t
+{
+ void *content;
+ unsigned char shared;
+ unsigned char vsm_size;
+ unsigned char vsm_data [ZMQ_MAX_VSM_SIZE];
+};
+
+// Initialise an empty message (zero bytes long).
+ZMQ_EXPORT int zmq_msg_init (struct zmq_msg_t *msg);
+
+// Initialise a message 'size' bytes long.
+//
+// Errors: ENOMEM - the size is too large to allocate.
+ZMQ_EXPORT int zmq_msg_init_size (struct zmq_msg_t *msg, size_t size);
+
+// Initialise a message from an existing buffer. Message isn't copied,
+// instead 0MQ infrastructure take ownership of the buffer and call
+// deallocation functio (ffn) once it's not needed anymore.
+ZMQ_EXPORT int zmq_msg_init_data (struct zmq_msg_t *msg, void *data,
+ size_t size, zmq_free_fn *ffn);
+
+// Deallocate the message.
+ZMQ_EXPORT int zmq_msg_close (struct zmq_msg_t *msg);
+
+// Move the content of the message from 'src' to 'dest'. The content isn't
+// copied, just moved. 'src' is an empty message after the call. Original
+// content of 'dest' message is deallocated.
+ZMQ_EXPORT int zmq_msg_move (struct zmq_msg_t *dest, struct zmq_msg_t *src);
+
+// Copy the 'src' message to 'dest'. The content isn't copied, instead
+// reference count is increased. Don't modify the message data after the
+// call as they are shared between two messages. Original content of 'dest'
+// message is deallocated.
+ZMQ_EXPORT int zmq_msg_copy (struct zmq_msg_t *dest, struct zmq_msg_t *src);
+
+// Returns pointer to message data.
+ZMQ_EXPORT void *zmq_msg_data (struct zmq_msg_t *msg);
+
+// Return size of message data (in bytes).
+ZMQ_EXPORT size_t zmq_msg_size (struct zmq_msg_t *msg);
+
+// Returns type of the message.
+ZMQ_EXPORT int zmq_msg_type (struct zmq_msg_t *msg);
+
+// Initialise 0MQ context. 'app_threads' specifies maximal number
+// of application threads that can have open sockets at the same time.
+// 'io_threads' specifies the size of thread pool to handle I/O operations.
+//
+// Errors: EINVAL - one of the arguments is less than zero or there are no
+// threads declared at all.
+ZMQ_EXPORT void *zmq_init (int app_threads, int io_threads);
+
+// Deinitialise 0MQ context including all the open sockets. Closing
+// sockets after zmq_term has been called will result in undefined behaviour.
+ZMQ_EXPORT int zmq_term (void *context);
+
+// Open a socket.
+//
+// Errors: EINVAL - invalid socket type.
+// EMFILE - the number of application threads entitled to hold open
+// sockets at the same time was exceeded.
+ZMQ_EXPORT void *zmq_socket (void *context, int type);
+
+// Close the socket.
+ZMQ_EXPORT int zmq_close (void *s);
+
+// Sets an option on the socket.
+// EINVAL - unknown option, a value with incorrect length or an invalid value.
+ZMQ_EXPORT int zmq_setsockopt (void *s, int option_, const void *optval_,
+ size_t optvallen_);
+
+// Bind the socket to a particular address.
+ZMQ_EXPORT int zmq_bind (void *s, const char *addr);
+
+// Connect the socket to a particular address.
+ZMQ_EXPORT int zmq_connect (void *s, const char *addr);
+
+// Send the message 'msg' to the socket 's'. 'flags' argument can be
+// combination of following values:
+// ZMQ_NOBLOCK - if message cannot be sent, return immediately.
+// ZMQ_NOFLUSH - message won't be sent immediately. It'll be sent with either
+// subsequent flushing send or explicit call to zmq_flush
+// function.
+//
+// Errors: EAGAIN - message cannot be sent at the moment (applies only to
+// non-blocking send).
+// EFAULT - function isn't supported by particular socket type.
+ZMQ_EXPORT int zmq_send (void *s, struct zmq_msg_t *msg, int flags);
+
+// Flush the messages that were send using ZMQ_NOFLUSH flag down the stream.
+//
+// Errors: FAULT - function isn't supported by particular socket type.
+ZMQ_EXPORT int zmq_flush (void *s);
+
+// Send a message from the socket 's'. 'flags' argument can be combination
+// of following values:
+// ZMQ_NOBLOCK - if message cannot be received, return immediately.
+//
+// Errors: EAGAIN - message cannot be received at the moment (applies only to
+// non-blocking receive).
+// EFAULT - function isn't supported by particular socket type.
+ZMQ_EXPORT int zmq_recv (void *s, struct zmq_msg_t *msg, int flags);
+
+// Helper functions used by perf tests so that they don't have to care
+// about minutiae of time-related functions on different OS platforms.
+ZMQ_EXPORT void *zmq_stopwatch_start ();
+ZMQ_EXPORT unsigned long zmq_stopwatch_stop (void *watch_);
+ZMQ_EXPORT void zmq_sleep (int seconds_);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/bindings/cpp/zmq.hpp b/bindings/cpp/zmq.hpp
new file mode 100644
index 0000000..471d1d8
--- /dev/null
+++ b/bindings/cpp/zmq.hpp
@@ -0,0 +1,283 @@
+/*
+ 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 __ZMQ_HPP_INCLUDED__
+#define __ZMQ_HPP_INCLUDED__
+
+#include "zmq.h"
+
+#include <assert.h>
+#include <errno.h>
+#include <string.h>
+#include <exception>
+
+namespace zmq
+{
+
+ typedef zmq_free_fn free_fn;
+
+ enum message_type_t
+ {
+ message_data = 1 << 0,
+ message_gap = 1 << ZMQ_GAP,
+ message_delimiter = 1 << ZMQ_DELIMITER
+ };
+
+ // The class masquerades POSIX-style errno error as a C++ exception.
+ class error_t : public std::exception
+ {
+ public:
+
+ error_t () : errnum (errno) {}
+
+ virtual const char *what () const throw ()
+ {
+#if defined _MSC_VER
+#pragma warning (push)
+#pragma warning (disable:4996)
+#endif
+ return strerror (errnum);
+#if defined _MSC_VER
+#pragma warning (pop)
+#endif
+ }
+
+ private:
+
+ int errnum;
+ };
+
+ // A message. Caution: Don't change the body of the message once you've
+ // copied it - the behaviour is undefined. Don't change the body of the
+ // received message either - other threads may be accessing it in parallel.
+
+ class message_t : private zmq_msg_t
+ {
+ friend class socket_t;
+
+ public:
+
+ // Creates message size_ bytes long.
+ inline message_t (size_t size_ = 0)
+ {
+ int rc = zmq_msg_init_size (this, size_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ // Creates message from the supplied buffer. 0MQ takes care of
+ // deallocating the buffer once it is not needed. The deallocation
+ // function is supplied in ffn_ parameter. If ffn_ is NULL, no
+ // deallocation happens - this is useful for sending static buffers.
+ inline message_t (void *data_, size_t size_,
+ free_fn *ffn_)
+ {
+ int rc = zmq_msg_init_data (this, data_, size_, ffn_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ // Destroys the message.
+ inline ~message_t ()
+ {
+ int rc = zmq_msg_close (this);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ // Destroys old content of the message and allocates buffer for the
+ // new message body. Having this as a separate function allows user
+ // to reuse once-allocated message for multiple times.
+ 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 ();
+ }
+
+ // Same as above, however, the message is rebuilt from the supplied
+ // buffer. See appropriate constructor for discussion of buffer
+ // deallocation mechanism.
+ inline void rebuild (void *data_, size_t size_, free_fn *ffn_)
+ {
+ int rc = zmq_msg_close (this);
+ if (rc != 0)
+ throw error_t ();
+ rc = zmq_msg_init_data (this, data_, size_, ffn_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ // Moves the message content from one message to the another. If the
+ // destination message have contained data prior to the operation
+ // these get deallocated. The source message will contain 0 bytes
+ // of data after the operation.
+ inline void move_to (message_t *msg_)
+ {
+ int rc = zmq_msg_move (this, (zmq_msg_t*) msg_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ // Copies the message content from one message to the another. If the
+ // destination message have contained data prior to the operation
+ // these get deallocated.
+ inline void copy_to (message_t *msg_)
+ {
+ int rc = zmq_msg_copy (this, (zmq_msg_t*) msg_);
+ if (rc != 0)
+ throw error_t ();
+ }
+
+ // Returns message type.
+ inline message_type_t type ()
+ {
+ return (message_type_t) (1 << zmq_msg_type (this));
+ }
+
+ // Returns pointer to message's data buffer.
+ inline void *data ()
+ {
+ return zmq_msg_data (this);
+ }
+
+ // Returns the size of message data buffer.
+ 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_)
+ {
+ ptr = zmq_init (app_threads_, io_threads_);
+ if (ptr == NULL)
+ throw error_t ();
+ }
+
+ inline ~context_t ()
+ {
+ int rc = zmq_term (ptr);
+ assert (rc == 0);
+ }
+
+ private:
+
+ void *ptr;
+
+ // Disable copying.
+ context_t (const context_t&);
+ void operator = (const context_t&);
+ };
+
+ class socket_t
+ {
+ public:
+
+ inline socket_t (context_t &context_, int type_ = 0)
+ {
+ 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 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 && 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 && errno == EAGAIN)
+ return false;
+ throw error_t ();
+ }
+
+ private:
+
+ void *ptr;
+
+ // Disable copying.
+ socket_t (const socket_t&);
+ void operator = (const socket_t&);
+ };
+
+}
+
+#endif
diff --git a/bindings/java/Makefile.am b/bindings/java/Makefile.am
index 966f77d..c9e430c 100644
--- a/bindings/java/Makefile.am
+++ b/bindings/java/Makefile.am
@@ -22,7 +22,7 @@ libjzmq_la_SOURCES = \
org_zmq_Socket.h
libjzmq_la_CXXFLAGS = -I$(top_srcdir)/src/libzmq \
-@JAVA_INCLUDE@ -I$(top_srcdir)/c -Wall
+@JAVA_INCLUDE@ -I$(top_srcdir)/bindings/c -Wall
libjzmq_la_LDFLAGS = -version-info @JLTVER@
libjzmq_la_LIBADD = $(top_builddir)/src/libzmq.la