org.zeromq.api

Interface Context

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ManagedContext

public interface Context
extends Closeable

A ØMQ context is thread safe and may be shared among as many application threads as necessary, without any additional locking required on the part of the caller.

Method Summary

Modifier and Type	Method and Description
BeaconReactorBuilder	buildBeaconReactor() Create a new BeaconReactor, which will send and receive UDP beacons on a broadcast address, with event-driven handling of received beacons.
BinaryStarReactorBuilder	buildBinaryStarReactor() Create a new BinaryStarReactor, which will create one half of an HA-pair with event-driven polling of a client Socket.
BinaryStarSocketBuilder	buildBinaryStarSocket() Create a ØMQ Socket, backed by a background agent that is connecting to a BinaryStarReactor HA-pair.
CloneClientBuilder	buildCloneClient() Create a new CloneClient, connected to an HA-pair, for publishing key/value data to anonymous peers.
CloneServerBuilder	buildCloneServer() Create a new CloneServer, which will create one half of an HA-pair for distributing key/value data to clients.
DeviceBuilder	buildDevice(DeviceType deviceType) Create a ØMQ Device of type DeviceType, which will bridge two networks together using patterns for specific SocketTypes.
PollerBuilder	buildPoller() Create a new Poller, which will allow callback-based polling of Sockets.
ReactorBuilder	buildReactor() Create a new Reactor, which will allow event-driven and timer-based polling of Sockets.
SocketBuilder	buildSocket(SocketType type) Create a ØMQ Socket of type SocketType
void	close() Close the context and any open sockets.
Socket	fork(Backgroundable backgroundable) Run a background thread with an inproc PAIR socket for communication.
void	fork(Socket socket, Backgroundable backgroundable) Run a background thread using the given socket for communication.
void	forward(Socket frontEnd, Socket backEnd) Create a ØMQ proxy and start it up on another thread that exits when the context is closed.
int	getFullVersion()
String	getVersionString()
Pollable	newPollable(SelectableChannel channel, PollerType... options) Create a new Pollable from the socket, with the requested options.
Pollable	newPollable(Socket socket, PollerType... options) Create a new Pollable from the socket, with the requested options.
void	proxy(Socket frontEnd, Socket backEnd) Create a ØMQ proxy and start it up.
void	queue(Socket frontEnd, Socket backEnd) Alias of forward(org.zeromq.api.Socket, org.zeromq.api.Socket).
Context	shadow() Create a new Context with the same underlying ØMQ context, with an empty (separate) list of managed Sockets and Backgroundables.
void	terminate() Asynchronously terminate the context without closing any open sockets, forcing pollers and waiters to abort.

Method Detail

buildSocket

SocketBuilder buildSocket(SocketType type)

Create a ØMQ Socket of type SocketType

Parameters:

type - socket type

Returns:

A builder for constructing and connecting ØMQ Sockets

getVersionString

String getVersionString()

Returns:

The ØMQ version, in a pretty-printed String.

getFullVersion

int getFullVersion()

Returns:

The ØMQ version, in integer form.

buildPoller

PollerBuilder buildPoller()

Create a new Poller, which will allow callback-based polling of Sockets.

Returns:

A builder for constructing ØMQ Pollers

See Also:

Pollable, PollerType

buildReactor

ReactorBuilder buildReactor()

Create a new Reactor, which will allow event-driven and timer-based polling of Sockets.

Returns:

A builder for constructing a Reactor

buildBinaryStarReactor

BinaryStarReactorBuilder buildBinaryStarReactor()

Create a new BinaryStarReactor, which will create one half of an HA-pair with event-driven polling of a client Socket.

Returns:

A builder for constructing a BinaryStarReactor

buildBinaryStarSocket

BinaryStarSocketBuilder buildBinaryStarSocket()

Create a ØMQ Socket, backed by a background agent that is connecting to a BinaryStarReactor HA-pair.

Returns:

A builder for constructing connecting a BinaryStarReactor client Socket

buildCloneServer

CloneServerBuilder buildCloneServer()

Create a new CloneServer, which will create one half of an HA-pair for distributing key/value data to clients.

Returns:

A builder for constructing a CloneServer

buildCloneClient

CloneClientBuilder buildCloneClient()

Create a new CloneClient, connected to an HA-pair, for publishing key/value data to anonymous peers.

Returns:

A builder for constructing a CloneClient

buildBeaconReactor

BeaconReactorBuilder buildBeaconReactor()

Create a new BeaconReactor, which will send and receive UDP beacons on a broadcast address, with event-driven handling of received beacons.

Returns:

A builder for constructing a BeaconReactor

buildDevice

DeviceBuilder buildDevice(DeviceType deviceType)

Create a ØMQ Device of type DeviceType, which will bridge two networks together using patterns for specific SocketTypes.

Parameters:

deviceType - The device type, specifying the pattern to use

Returns:

A builder for constructing ØMQ Devices

newPollable

Pollable newPollable(Socket socket,
                     PollerType... options)

Create a new Pollable from the socket, with the requested options.

Parameters:

socket - A socket to wrap for polling

options - Polling options (IN, OUT, ERROR)

Returns:

A new Pollable, for use with a Poller.

newPollable

Pollable newPollable(SelectableChannel channel,
                     PollerType... options)

Create a new Pollable from the socket, with the requested options.

Parameters:

channel - A channel to wrap for polling

options - Polling options (IN, OUT, ERROR)

Returns:

A new Pollable, for use with a Poller.

proxy

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

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

queue

void queue(Socket frontEnd,
           Socket backEnd)

Alias of forward(org.zeromq.api.Socket, org.zeromq.api.Socket).

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

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

fork

void fork(Socket socket,
          Backgroundable backgroundable)

Run a background thread using the given socket for communication.

Parameters:

socket - The socket owned by the background thread

backgroundable - The task to be performed on the background thread

shadow

Context shadow()

Create a new Context with the same underlying ØMQ context, with an empty (separate) list of managed Sockets and Backgroundables.

The returned context will not attempt to terminate the underlying ØMQ context when closed, and will only close managed sockets, etc.

Returns:

A new context with the same underlying ØMQ context

close

void close()

Close the context and any open sockets.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

terminate

void terminate()

Asynchronously terminate the context without closing any open sockets, forcing pollers and waiters to abort.