org.zeromq.api

Enum SocketType

java.lang.Object

java.lang.Enum<SocketType>

org.zeromq.api.SocketType

All Implemented Interfaces:

Serializable, Comparable<SocketType>

public enum SocketType
extends Enum<SocketType>

Values for Socket types

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEALER A socket of type ZMQ_DEALER is an advanced pattern used for extending request/reply sockets.
PAIR A socket of type ZMQ_PAIR can only be connected to a single peer at any one time.
PUB A socket of type ZMQ_PUB is used by a publisher to distribute data.
PULL A socket of type ZMQ_PULL is used by a pipeline node to receive messages from upstream pipeline nodes.
PUSH A socket of type ZMQ_PUSH is used by a pipeline node to send messages to downstream pipeline nodes.
REP A socket of type ZMQ_REQ is used by a client to send requests to and receive replies from a service.
REQ A socket of type ZMQ_REP is used by a service to receive requests from and send replies to a client.
ROUTER A socket of type ZMQ_ROUTER is an advanced socket type used for extending request/reply sockets.
SUB A socket of type ZMQ_SUB is used by a subscriber to subscribe to data distributed by a publisher.
XPUB Same as ZMQ_PUB except that you can receive subscriptions from the peers in form of incoming messages.
XSUB Same as ZMQ_SUB except that you subscribe by sending subscription messages to the socket.

Method Summary

Modifier and Type	Method and Description
org.zeromq.SocketType	getType() Socket type which determines the semantics of communication over the socket.
static SocketType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SocketType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PAIR

public static final SocketType PAIR

A socket of type ZMQ_PAIR can only be connected to a single peer at any one time. No message routing or filtering is performed on messages sent over a ZMQ_PAIR socket.

PUB

public static final SocketType PUB

A socket of type ZMQ_PUB is used by a publisher to distribute data. Messages sent are distributed in a fan out fashion to all connected peers.

SUB

public static final SocketType SUB

A socket of type ZMQ_SUB is used by a subscriber to subscribe to data distributed by a publisher. Initially a ZMQ_SUB socket is not subscribed to any messages.

REQ

public static final SocketType REQ

A socket of type ZMQ_REP is used by a service to receive requests from and send replies to a client. This socket type allows only an alternating sequence of receive(request) and subsequent send(reply) calls.

REP

public static final SocketType REP

A socket of type ZMQ_REQ is used by a client to send requests to and receive replies from a service. This socket type allows only an alternating sequence of send(request) and subsequent receive(reply) calls.

DEALER

public static final SocketType DEALER

A socket of type ZMQ_DEALER is an advanced pattern used for extending request/reply sockets. Each message sent is round-robined among all connected peers, and each message received is fair-queued from all connected peers.

ROUTER

public static final SocketType ROUTER

A socket of type ZMQ_ROUTER is an advanced socket type used for extending request/reply sockets. When receiving messages a ZMQ_ROUTER socket shall prepend a message part containing the identity of the originating peer to the message before passing it to the application.

PULL

public static final SocketType PULL

A socket of type ZMQ_PULL is used by a pipeline node to receive messages from upstream pipeline nodes. Messages are fair-queued from among all connected upstream nodes.

PUSH

public static final SocketType PUSH

A socket of type ZMQ_PUSH is used by a pipeline node to send messages to downstream pipeline nodes. Messages are round-robined to all connected downstream nodes.

XPUB

public static final SocketType XPUB

Same as ZMQ_PUB except that you can receive subscriptions from the peers in form of incoming messages.

XSUB

public static final SocketType XSUB

Same as ZMQ_SUB except that you subscribe by sending subscription messages to the socket.

Method Detail

values

public static SocketType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SocketType c : SocketType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SocketType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getType

public org.zeromq.SocketType getType()

Socket type which determines the semantics of communication over the socket.

Returns:

socket type