org.zeromq

Class Sockets

java.lang.Object

org.zeromq.Sockets

public class Sockets
extends Object

Class containing utility methods for creating ØMQ Sockets and other related objects without using a ØMQ Context directly.

Method Summary

Modifier and Type	Method and Description
static Socket	bind(SocketType socketType, String url) Create a ØMQ Socket and bind it to a given url.
static PollerBuilder	buildPoller() Create a builder capable of constructing a ØMQ Poller.
static ReactorBuilder	buildReactor() Create a builder capable of constructing a ØMQ Reactor.
static SocketBuilder	buildSocket(SocketType socketType) Create a builder capable of constructing ØMQ Sockets of the given socket type.
static Socket	connect(SocketType socketType, String url) Create a ØMQ Socket and connect it to a given url.
static Socket	fork(Backgroundable backgroundable) Run a background thread with an inproc PAIR socket for communication.
static void	forward(Socket frontEnd, Socket backEnd) Create a ØMQ proxy and start it up on another thread that exits when the context is closed.
static Poller	newPoller(PollListener listener, List<Socket> sockets, List<SelectableChannel> channels) Create a ØMQ Poller with a single PollListener which handles incoming messages from the given ØMQ Sockets and SelectableChannels.
static Poller	newPoller(PollListener listener, SelectableChannel... channels) Create a ØMQ Poller with a single PollListener which handles incoming messages from the given SelectableChannels.
static Poller	newPoller(PollListener listener, Socket... sockets) Create a ØMQ Poller with a single PollListener which handles incoming messages from the given ØMQ Sockets.
static Poller	newPoller(PollListener listener, Socket socket, SelectableChannel channel) Create a ØMQ Poller with a single PollListener which handles incoming messages from the given ØMQ Socket and SelectableChannel.
static Reactor	newReactor(LoopHandler handler, List<Socket> sockets, List<SelectableChannel> channels) Create a ØMQ Reactor with a single LoopHandler which handles incoming messages from the given ØMQ Sockets and SelectableChannels.
static Reactor	newReactor(LoopHandler handler, long interval, TimeUnit unit) Create a ØMQ Reactor with a single LoopHandler which initially handles a repeating timer with the given interval.
static Reactor	newReactor(LoopHandler handler, SelectableChannel... channels) Create a ØMQ Reactor with a single LoopHandler which handles incoming messages from the given SelectableChannels.
static Reactor	newReactor(LoopHandler handler, Socket... sockets) Create a ØMQ Reactor with a single LoopHandler which handles incoming messages from the given ØMQ Sockets.
static Reactor	newReactor(LoopHandler handler, Socket socket, SelectableChannel channel) Create a ØMQ Reactor with a single LoopHandler which handles incoming messages from the given ØMQ Socket and SelectableChannel.
static void	proxy(Socket frontEnd, Socket backEnd) Create a ØMQ proxy and start it up.
static void	start(DeviceType deviceType, String frontendUrl, String backendUrl) Start a ØMQ Device of the given type, which will run in the background to bridge two networks together.

Methods inherited from class java.lang.Object

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

Method Detail

buildSocket

public static SocketBuilder buildSocket(SocketType socketType)

Create a builder capable of constructing ØMQ Sockets of the given socket type.

Parameters:

socketType - The socket type

Returns:

A builder for constructing ØMQ Sockets

connect

public static Socket connect(SocketType socketType,
                             String url)

Create a ØMQ Socket and connect it to a given url.

Parameters:

socketType - The socket type

url - The url to connect to

Returns:

A ØMQ Socket

bind

public static Socket bind(SocketType socketType,
                          String url)

Create a ØMQ Socket and bind it to a given url.

Parameters:

socketType - The socket type

url - The url to bind to

Returns:

A ØMQ Socket

buildPoller

public static PollerBuilder buildPoller()

Create a builder capable of constructing a ØMQ Poller.

Returns:

A builder for constructing a ØMQ Poller

newPoller

public static Poller newPoller(PollListener listener,
                               Socket... sockets)

Create a ØMQ Poller with a single PollListener which handles incoming messages from the given ØMQ Sockets.

Parameters:

listener - A listener for handling incoming messages

sockets - One or more ØMQ Sockets

Returns:

A new ØMQ Poller

newPoller

public static Poller newPoller(PollListener listener,
                               SelectableChannel... channels)

Create a ØMQ Poller with a single PollListener which handles incoming messages from the given SelectableChannels.

Parameters:

listener - A listener for handling incoming messages

channels - One or more channels that can be multiplexed with ØMQ Sockets

Returns:

A new ØMQ Poller

newPoller

public static Poller newPoller(PollListener listener,
                               Socket socket,
                               SelectableChannel channel)

Create a ØMQ Poller with a single PollListener which handles incoming messages from the given ØMQ Socket and SelectableChannel.

Parameters:

listener - A listener for handling incoming messages

socket - A ØMQ Socket

channel - A selectable channel that can be multiplexed with ØMQ Sockets

Returns:

A new ØMQ Poller

newPoller

public static Poller newPoller(PollListener listener,
                               List<Socket> sockets,
                               List<SelectableChannel> channels)

Create a ØMQ Poller with a single PollListener which handles incoming messages from the given ØMQ Sockets and SelectableChannels.

Parameters:

listener - A listener for handling incoming messages

sockets - One or more ØMQ Sockets

channels - One or more channels that can be multiplexed with ØMQ Sockets

Returns:

A new ØMQ Poller

buildReactor

public static ReactorBuilder buildReactor()

Create a builder capable of constructing a ØMQ Reactor.

Returns:

A builder for constructing a ØMQ Reactor

newReactor

public static Reactor newReactor(LoopHandler handler,
                                 Socket... sockets)

Create a ØMQ Reactor with a single LoopHandler which handles incoming messages from the given ØMQ Sockets.

Parameters:

handler - A handler for executing event-driven polling of Sockets

sockets - One or more ØMQ Sockets

Returns:

A new ØMQ Reactor

newReactor

public static Reactor newReactor(LoopHandler handler,
                                 SelectableChannel... channels)

Create a ØMQ Reactor with a single LoopHandler which handles incoming messages from the given SelectableChannels.

Parameters:

handler - A handler for executing event-driven polling of Sockets

channels - One or more channels that can be multiplexed with ØMQ Sockets

Returns:

A new ØMQ Reactor

newReactor

public static Reactor newReactor(LoopHandler handler,
                                 Socket socket,
                                 SelectableChannel channel)

Create a ØMQ Reactor with a single LoopHandler which handles incoming messages from the given ØMQ Socket and SelectableChannel.

Parameters:

handler - A handler for executing event-driven polling of Sockets

socket - A ØMQ Socket

channel - A selectable channel that can be multiplexed with ØMQ Sockets

Returns:

A new ØMQ Reactor

newReactor

public static Reactor newReactor(LoopHandler handler,
                                 long interval,
                                 TimeUnit unit)

Create a ØMQ Reactor with a single LoopHandler which initially handles a repeating timer with the given interval.

Parameters:

handler - A handler for executing event-driven polling of Sockets

interval - The initial and subsequet delay for a repeating timer event

unit - The time unit for the timer interval

Returns:

A new ØMQ Reactor

newReactor

public static Reactor newReactor(LoopHandler handler,
                                 List<Socket> sockets,
                                 List<SelectableChannel> channels)

Create a ØMQ Reactor with a single LoopHandler which handles incoming messages from the given ØMQ Sockets and SelectableChannels.

Parameters:

handler - A handler for executing event-driven polling of Sockets

sockets - One or more ØMQ Sockets

channels - One or more channels that can be multiplexed with ØMQ Sockets

Returns:

A new ØMQ Poller

start

public static void start(DeviceType deviceType,
                         String frontendUrl,
                         String backendUrl)

Start a ØMQ Device of the given type, which will run in the background to bridge two networks together.

Parameters:

deviceType - The device type, specifying the pattern to use

frontendUrl - The front-end socket which will be proxied to/from the back-end

backendUrl - The back-end socket which will be proxied to/from the front-end

proxy

public static void proxy(Socket frontEnd,
                         Socket backEnd)

Create a ØMQ proxy and start it up. Returns when the context is closed.

Parameters:

frontEnd - The front-end socket which will be proxied to/from the back-end

backEnd - The back-end socket which will be proxied to/from the front-end

forward

public static void forward(Socket frontEnd,
                           Socket backEnd)

Create a ØMQ proxy and start it up on another thread that exits when the context is closed.

Parameters:

frontEnd - The front-end socket which will be proxied to/from the back-end

backEnd - The back-end socket which will be proxied to/from the front-end

fork

public static Socket fork(Backgroundable backgroundable)

Run a background thread with an inproc PAIR socket for communication.

Parameters:

backgroundable - The task to be performed on the background thread

Returns:

The inproc PAIR socket for communicating with the background thread