org.zeromq.ZMQ Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jeromq Show documentation
Show all versions of jeromq Show documentation
Pure Java implementation of libzmq
/*
Copyright (c) 1991-2011 iMatix Corporation
Copyright other contributors as noted in the AUTHORS file.
This file is part of 0MQ.
0MQ is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser 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
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see
* Since ZeroMQ 3.0, the timeout parameter is in milliseconds,
* but prior to this the unit was microseconds.
*
* @param tout
* the timeout, as per zmq_poll ();
* if -1, it will block indefinitely until an event
* happens; if 0, it will return immediately;
* otherwise, it will wait for at most that many
* milliseconds/microseconds (see above).
*
* @see "http://api.zeromq.org/3-0:zmq-poll"
*
* @return how many objects where signaled by poll ()
*/
public int poll(long tout) {
zmq.PollItem[] pollItems = new zmq.PollItem[next];
for (int i = 0; i < next; i++)
pollItems[i] = items[i].base ();
return zmq.ZMQ.zmq_poll (pollItems, next, tout);
}
/**
* Check whether the specified element in the poll set was signaled for input.
*
* @param index
*
* @return true if the element was signaled.
*/
public boolean pollin (int index) {
if (index < 0 || index >= this.next)
return false;
return items [index].isReadable();
}
/**
* Check whether the specified element in the poll set was signaled for output.
*
* @param index
*
* @return true if the element was signaled.
*/
public boolean pollout (int index) {
if (index < 0 || index >= this.next)
return false;
return items [index].isWritable ();
}
/**
* Check whether the specified element in the poll set was signaled for error.
*
* @param index
*
* @return true if the element was signaled.
*/
public boolean pollerr (int index) {
if (index < 0 || index >= this.next)
return false;
return items [index].isError();
}
}
public static class PollItem {
private final zmq.PollItem base;
private final Socket socket;
public PollItem (Socket socket, int ops) {
this.socket = socket;
base = new zmq.PollItem (socket.base, ops);
}
public PollItem (SelectableChannel channel, int ops) {
base = new zmq.PollItem (channel, ops);
socket = null;
}
protected final zmq.PollItem base() {
return base;
}
public final SelectableChannel getRawSocket () {
return base.getRawSocket ();
}
public final Socket getSocket() {
return socket;
}
public final boolean isReadable() {
return base.isReadable();
}
public final boolean isWritable() {
return base.isWritable ();
}
public final boolean isError () {
return base.isError ();
}
public final int readyOps () {
return base.readyOps ();
}
@Override
public boolean equals (Object obj)
{
if (!(obj instanceof PollItem))
return false;
PollItem target = (PollItem) obj;
if (socket != null && socket == target.socket)
return true;
if (getRawSocket () != null && getRawSocket () == target.getRawSocket ())
return true;
return false;
}
}
public enum Error {
ENOTSUP(ZError.ENOTSUP),
EPROTONOSUPPORT(ZError.EPROTONOSUPPORT),
ENOBUFS(ZError.ENOBUFS),
ENETDOWN(ZError.ENETDOWN),
EADDRINUSE(ZError.EADDRINUSE),
EADDRNOTAVAIL(ZError.EADDRNOTAVAIL),
ECONNREFUSED(ZError.ECONNREFUSED),
EINPROGRESS(ZError.EINPROGRESS),
EMTHREAD(ZError.EMTHREAD),
EFSM(ZError.EFSM),
ENOCOMPATPROTO(ZError.ENOCOMPATPROTO),
ETERM(ZError.ETERM);
private final int code;
Error(int code) {
this.code = code;
}
public int getCode() {
return code;
}
public static Error findByCode(int code) {
for (Error e : Error.class.getEnumConstants()) {
if (e.getCode() == code) {
return e;
}
}
throw new IllegalArgumentException("Unknown " + Error.class.getName() + " enum code:" + code);
}
}
@Deprecated
public static boolean device (int type_, Socket frontend, Socket backend)
{
return zmq.ZMQ.zmq_proxy (frontend.base, backend.base, null);
}
/**
* Starts the built-in 0MQ proxy in the current application thread.
* The proxy connects a frontend socket to a backend socket. Conceptually, data flows from frontend to backend.
* Depending on the socket types, replies may flow in the opposite direction. The direction is conceptual only;
* the proxy is fully symmetric and there is no technical difference between frontend and backend.
*
* Before calling ZMQ.proxy() you must set any socket options, and connect or bind both frontend and backend sockets.
* The two conventional proxy models are:
*
* ZMQ.proxy() runs in the current thread and returns only if/when the current context is closed.
* @param frontend ZMQ.Socket
* @param backend ZMQ.Socket
* @param capture If the capture socket is not NULL, the proxy shall send all messages, received on both
* frontend and backend, to the capture socket. The capture socket should be a
* ZMQ_PUB, ZMQ_DEALER, ZMQ_PUSH, or ZMQ_PAIR socket.
*/
public static boolean proxy (Socket frontend, Socket backend, Socket capture)
{
return zmq.ZMQ.zmq_proxy (frontend.base, backend.base, capture != null ? capture.base: null);
}
public static int poll(PollItem[] items, long timeout)
{
return poll(items, items.length, timeout);
}
public static int poll(PollItem[] items, int count, long timeout) {
zmq.PollItem[] items_ = new zmq.PollItem[count];
for (int i = 0; i < count; i++) {
items_[i] = items[i].base;
}
return zmq.ZMQ.zmq_poll(items_, count, timeout);
}
/**
* @return Major version number of the ZMQ library.
*/
public static int getMajorVersion ()
{
return zmq.ZMQ.ZMQ_VERSION_MAJOR;
}
/**
* @return Major version number of the ZMQ library.
*/
public static int getMinorVersion ()
{
return zmq.ZMQ.ZMQ_VERSION_MINOR;
}
/**
* @return Major version number of the ZMQ library.
*/
public static int getPatchVersion ()
{
return zmq.ZMQ.ZMQ_VERSION_PATCH;
}
/**
* @return Full version number of the ZMQ library used for comparing versions.
*/
public static int getFullVersion() {
return zmq.ZMQ.ZMQ_MAKE_VERSION(zmq.ZMQ.ZMQ_VERSION_MAJOR,
zmq.ZMQ.ZMQ_VERSION_MINOR,
zmq.ZMQ.ZMQ_VERSION_PATCH);
}
/**
* @param major Version major component.
* @param minor Version minor component.
* @param patch Version patch component.
*
* @return Comparible single int version number.
*/
public static int makeVersion ( final int major,
final int minor,
final int patch )
{
return zmq.ZMQ.ZMQ_MAKE_VERSION ( major, minor, patch );
}
/**
* @return String version number in the form major.minor.patch.
*/
public static String getVersionString() {
return "" + zmq.ZMQ.ZMQ_VERSION_MAJOR + "." +
zmq.ZMQ.ZMQ_VERSION_MINOR + "." +
zmq.ZMQ.ZMQ_VERSION_PATCH;
}
/**
* Inner class: Event.
* Monitor socket event class
*/
public static class Event {
private final int event;
private final Object value;
private final String address;
public Event(int event, Object value, String address) {
this.event = event;
this.value = value;
this.address = address;
}
public int getEvent() {
return event;
}
public Object getValue() {
return value;
}
public String getAddress() {
return address;
}
/**
* Receive an event from a monitor socket.
* @param socket the socket
* @param flags the flags to apply to the receive operation.
* @return the received event or null if no message was received.
* @throws ZMQException
*/
public static Event recv(Socket socket, int flags) {
zmq.ZMQ.Event e = zmq.ZMQ.Event.read(socket.base, flags);
return e != null ? new Event(e.event, e.arg, e.addr) : null;
}
/**
* Receive an event from a monitor socket.
* Does a blocking recv.
* @param socket the socket
* @return the received event.
* @throws ZMQException
*/
public static Event recv(Socket socket) {
return Event.recv(socket, 0);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy