mirror of
https://github.com/zeromq/libzmq.git
synced 2024-12-13 02:42:58 +01:00
11a410b658
definitions as aliases, to be removed in release 3.0. Also renamed the source files implementing these two socket types. This change does not break existing applications nor bindings, but allows us to fix the documentation and user guide now, rather than keeping the old (confusing) names.
236 lines
8.3 KiB
C
236 lines
8.3 KiB
C
/*
|
|
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
|
|
|
|
/* Win32 needs special handling for DLL exports */
|
|
#if defined _WIN32
|
|
# if defined DLL_EXPORT
|
|
# define ZMQ_EXPORT __declspec(dllexport)
|
|
# else
|
|
# define ZMQ_EXPORT __declspec(dllimport)
|
|
# endif
|
|
#else
|
|
# define ZMQ_EXPORT
|
|
#endif
|
|
|
|
/******************************************************************************/
|
|
/* 0MQ versioning support. */
|
|
/******************************************************************************/
|
|
|
|
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)
|
|
#define ETERM (ZMQ_HAUSNUMERO + 53)
|
|
|
|
/* 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 that uses different CRT library. */
|
|
ZMQ_EXPORT int zmq_errno ();
|
|
|
|
/* 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_MORE 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. */
|
|
/******************************************************************************/
|
|
|
|
ZMQ_EXPORT void *zmq_init (int io_threads);
|
|
ZMQ_EXPORT int zmq_term (void *context);
|
|
|
|
/******************************************************************************/
|
|
/* 0MQ socket definition. */
|
|
/******************************************************************************/
|
|
|
|
/* Socket types. */
|
|
#define ZMQ_PAIR 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_PULL 7
|
|
#define ZMQ_PUSH 8
|
|
#define ZMQ_UPSTREAM ZMQ_PULL /* Old alias, remove in 3.x */
|
|
#define ZMQ_DOWNSTREAM ZMQ_PUSH /* Old alias, remove in 3.x */
|
|
|
|
/* Socket options. */
|
|
#define ZMQ_HWM 1
|
|
/* ZMQ_LWM 2 no longer supported */
|
|
#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_RCVMORE 13
|
|
|
|
/* Send/recv options. */
|
|
#define ZMQ_NOBLOCK 1
|
|
#define ZMQ_SNDMORE 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_getsockopt (void *s, int option, 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_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);
|
|
|
|
/******************************************************************************/
|
|
/* Devices */
|
|
/******************************************************************************/
|
|
|
|
#define ZMQ_QUEUE 1
|
|
#define ZMQ_FORWARDER 2
|
|
#define ZMQ_STREAMER 3
|
|
|
|
ZMQ_EXPORT int zmq_device (int device, void * insocket, void* outsocket);
|
|
|
|
#undef ZMQ_EXPORT
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|