org.zeromq

Class ZMQ.Event

java.lang.Object

org.zeromq.ZMQ.Event

Enclosing class:

ZMQ

public static class ZMQ.Event
extends Object

Inner class: Event. Monitor socket event class

Constructor Summary

Constructors

Constructor and Description
Event(int event, Object value, String address)

Method Summary

Modifier and Type	Method and Description
String	getAddress()
int	getEvent()
Object	getValue()
boolean	isError() Used to check if the event is an error.
boolean	isWarn() Used to check if the event is a warning.
static ZMQ.Event	recv(ZMQ.Socket socket) Receive an event from a monitor socket.
static ZMQ.Event	recv(ZMQ.Socket socket, int flags) Receive an event from a monitor socket.
<M> M	resolveValue() Return the argument as an integer or a Enum of the appropriate type if available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Event

public Event(int event,
             Object value,
             String address)

Method Detail

recv

public static ZMQ.Event recv(ZMQ.Socket socket,
                             int flags)

Receive an event from a monitor socket.

Parameters:

socket - the socket

flags - the flags to apply to the receive operation.

Returns:

the received event or null if no message was received.

Throws:

ZMQException

recv

public static ZMQ.Event recv(ZMQ.Socket socket)

Receive an event from a monitor socket. Does a blocking recv.

Parameters:

socket - the socket

Returns:

the received event.

Throws:

ZMQException

getEvent

public int getEvent()

getValue

public Object getValue()

getAddress

public String getAddress()

isError

public boolean isError()

Used to check if the event is an error.

Generally, any event that define the errno is considered as an error.

Returns:

true if the evant was an error

isWarn

public boolean isWarn()

Used to check if the event is a warning.

Generally, any event that return an authentication failure is considered as a warning.

Returns:

resolveValue

public <M> M resolveValue()

Return the argument as an integer or a Enum of the appropriate type if available. It return objects of type:

• ZMonitor.ProtocolCode for a handshake protocol error.
• ZMQ.Error for any other error.
• Integer when available.
• null when no relevant value available.

Type Parameters:

M - The expected type of the returned object

Returns:

The resolved value.