ManagedContext (jzmq-api 0.2.0-SNAPSHOT API)

java.lang.Object
- org.zeromq.jzmq.ManagedContext

All Implemented Interfaces:

Closeable, AutoCloseable, Context
```
public class ManagedContext
extends Object
implements Context
```
Manage JZMQ Context

Constructor Summary

Constructors
Constructor and Description
`ManagedContext()`
`ManagedContext(int ioThreads)`
`ManagedContext(org.zeromq.ZMQ.Context context)`
`ManagedContext(org.zeromq.ZMQ.Context context, boolean termContext)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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.
`void`	`destroySocket(Socket socket)`
`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()`
`Collection<Socket>`	`getSockets()`
`String`	`getVersionString()`
`org.zeromq.ZMQ.Context`	`getZMQContext()`
`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.
`org.zeromq.ZMQ.Poller`	`newZmqPoller()` Deprecated.
`org.zeromq.ZMQ.Poller`	`newZmqPoller(int initialNumberOfItems)` Deprecated.
`void`	`proxy(Socket frontEnd, Socket backEnd)` Create a ØMQ proxy and start it up.
`void`	`queue(Socket frontEnd, Socket backEnd)` Alias of `Context.forward(org.zeromq.api.Socket, org.zeromq.api.Socket)`.
`ManagedContext`	`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ManagedContext
```
public ManagedContext()
```
  - ManagedContext
```
public ManagedContext(int ioThreads)
```
  - ManagedContext
```
public ManagedContext(org.zeromq.ZMQ.Context context)
```
  - ManagedContext
```
public ManagedContext(org.zeromq.ZMQ.Context context,
                      boolean termContext)
```
- Method Detail
  - getZMQContext
```
public org.zeromq.ZMQ.Context getZMQContext()
```
  - getSockets
```
public Collection<Socket> getSockets()
```
  - destroySocket
```
public void destroySocket(Socket socket)
```
  - shadow
```
public ManagedContext shadow()
```
    Description copied from interface: Context
    
    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.
    
    Specified by:
    
    shadow in interface Context
    
    Returns:
    
    A new context with the same underlying ØMQ context
  - close
```
public void close()
```
    Description copied from interface: Context
    
    Close the context and any open sockets.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Context
  - terminate
```
public void terminate()
```
    Description copied from interface: Context
    
    Asynchronously terminate the context without closing any open sockets, forcing pollers and waiters to abort.
    
    Specified by:
    
    terminate in interface Context
  - buildSocket
```
public SocketBuilder buildSocket(SocketType type)
```
    Description copied from interface: Context
    
    Create a ØMQ Socket of type SocketType
    
    Specified by:
    
    buildSocket in interface Context
    
    Parameters:
    
    type - socket type
    
    Returns:
    
    A builder for constructing and connecting ØMQ Sockets
  - getVersionString
```
public String getVersionString()
```
    Specified by:
    
    getVersionString in interface Context
    
    Returns:
    
    The ØMQ version, in a pretty-printed String.
  - getFullVersion
```
public int getFullVersion()
```
    Specified by:
    
    getFullVersion in interface Context
    
    Returns:
    
    The ØMQ version, in integer form.
  - buildPoller
```
public PollerBuilder buildPoller()
```
    Description copied from interface: Context
    
    Create a new Poller, which will allow callback-based polling of Sockets.
    
    Specified by:
    
    buildPoller in interface Context
    
    Returns:
    
    A builder for constructing ØMQ Pollers
    
    See Also:
    
    Pollable, PollerType
  - newZmqPoller
```
@Deprecated
public org.zeromq.ZMQ.Poller newZmqPoller(int initialNumberOfItems)
```
    Deprecated.
  - newZmqPoller
```
@Deprecated
public org.zeromq.ZMQ.Poller newZmqPoller()
```
    Deprecated.
  - newPollable
```
public Pollable newPollable(Socket socket,
                            PollerType... options)
```
    Description copied from interface: Context
    
    Create a new Pollable from the socket, with the requested options.
    
    Specified by:
    
    newPollable in interface Context
    
    Parameters:
    
    socket - A socket to wrap for polling
    
    options - Polling options (IN, OUT, ERROR)
    
    Returns:
    
    A new Pollable, for use with a Poller.
  - newPollable
```
public Pollable newPollable(SelectableChannel channel,
                            PollerType... options)
```
    Description copied from interface: Context
    
    Create a new Pollable from the socket, with the requested options.
    
    Specified by:
    
    newPollable in interface Context
    
    Parameters:
    
    channel - A channel to wrap for polling
    
    options - Polling options (IN, OUT, ERROR)
    
    Returns:
    
    A new Pollable, for use with a Poller.
  - buildReactor
```
public ReactorBuilder buildReactor()
```
    Description copied from interface: Context
    
    Create a new Reactor, which will allow event-driven and timer-based polling of Sockets.
    
    Specified by:
    
    buildReactor in interface Context
    
    Returns:
    
    A builder for constructing a Reactor
  - buildBinaryStarReactor
```
public BinaryStarReactorBuilder buildBinaryStarReactor()
```
    Description copied from interface: Context
    
    Create a new BinaryStarReactor, which will create one half of an HA-pair with event-driven polling of a client Socket.
    
    Specified by:
    
    buildBinaryStarReactor in interface Context
    
    Returns:
    
    A builder for constructing a BinaryStarReactor
  - buildBinaryStarSocket
```
public BinaryStarSocketBuilder buildBinaryStarSocket()
```
    Description copied from interface: Context
    
    Create a ØMQ Socket, backed by a background agent that is connecting to a BinaryStarReactor HA-pair.
    
    Specified by:
    
    buildBinaryStarSocket in interface Context
    
    Returns:
    
    A builder for constructing connecting a BinaryStarReactor client Socket
  - buildCloneServer
```
public CloneServerBuilder buildCloneServer()
```
    Description copied from interface: Context
    
    Create a new CloneServer, which will create one half of an HA-pair for distributing key/value data to clients.
    
    Specified by:
    
    buildCloneServer in interface Context
    
    Returns:
    
    A builder for constructing a CloneServer
  - buildCloneClient
```
public CloneClientBuilder buildCloneClient()
```
    Description copied from interface: Context
    
    Create a new CloneClient, connected to an HA-pair, for publishing key/value data to anonymous peers.
    
    Specified by:
    
    buildCloneClient in interface Context
    
    Returns:
    
    A builder for constructing a CloneClient
  - buildBeaconReactor
```
public BeaconReactorBuilder buildBeaconReactor()
```
    Description copied from interface: Context
    
    Create a new BeaconReactor, which will send and receive UDP beacons on a broadcast address, with event-driven handling of received beacons.
    
    Specified by:
    
    buildBeaconReactor in interface Context
    
    Returns:
    
    A builder for constructing a BeaconReactor
  - buildDevice
```
public DeviceBuilder buildDevice(DeviceType deviceType)
```
    Description copied from interface: Context
    
    Create a ØMQ Device of type DeviceType, which will bridge two networks together using patterns for specific SocketTypes.
    
    Specified by:
    
    buildDevice in interface Context
    
    Parameters:
    
    deviceType - The device type, specifying the pattern to use
    
    Returns:
    
    A builder for constructing ØMQ Devices
  - proxy
```
public void proxy(Socket frontEnd,
                  Socket backEnd)
```
    Description copied from interface: Context
    
    Create a ØMQ proxy and start it up. Returns when the context is closed.
    
    Specified by:
    
    proxy in interface Context
    
    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 void forward(Socket frontEnd,
                    Socket backEnd)
```
    Description copied from interface: Context
    
    Create a ØMQ proxy and start it up on another thread that exits when the context is closed.
    
    Specified by:
    
    forward in interface Context
    
    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
```
public void queue(Socket frontEnd,
                  Socket backEnd)
```
    Description copied from interface: Context
    
    Alias of Context.forward(org.zeromq.api.Socket, org.zeromq.api.Socket).
    
    Specified by:
    
    queue in interface Context
    
    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 Socket fork(Backgroundable backgroundable)
```
    Description copied from interface: Context
    
    Run a background thread with an inproc PAIR socket for communication.
    
    Specified by:
    
    fork in interface Context
    
    Parameters:
    
    backgroundable - The task to be performed on the background thread
    
    Returns:
    
    The inproc PAIR socket for communicating with the background thread
  - fork
```
public void fork(Socket socket,
                 Backgroundable backgroundable)
```
    Description copied from interface: Context
    
    Run a background thread using the given socket for communication.
    
    Specified by:
    
    fork in interface Context
    
    Parameters:
    
    socket - The socket owned by the background thread
    
    backgroundable - The task to be performed on the background thread

Class ManagedContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ManagedContext

ManagedContext

ManagedContext

ManagedContext

Method Detail

getZMQContext

getSockets

destroySocket

shadow

close

terminate

buildSocket

getVersionString

getFullVersion

buildPoller

newZmqPoller

newZmqPoller

newPollable

newPollable

buildReactor

buildBinaryStarReactor

buildBinaryStarSocket

buildCloneServer

buildCloneClient

buildBeaconReactor

buildDevice

proxy

forward

queue

fork

fork