ZContext (JeroMQ 0.5.3 API)

java.lang.Object
- org.zeromq.ZContext

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class ZContext
extends Object
implements Closeable
```
ZContext provides a high-level ZeroMQ context management class It manages open sockets in the context and automatically closes these before terminating the context. It provides a simple way to set the linger timeout on sockets, and configure contexts for number of I/O threads. Sets-up signal (interrupt) handling for the process.

Constructor Summary

Constructors
Constructor and Description

ZContext()
Class Constructor

ZContext(int ioThreads)

Constructors
Constructor and Description
`ZContext()` Class Constructor
`ZContext(int ioThreads)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`closeSelector(Selector selector)` Deprecated. `createSelector()` was exposed by mistake. while waiting for the API to disappear, this method is provided to allow releasing resources.
`ZMQ.Poller`	`createPoller(int size)`
`Selector`	`createSelector()` Deprecated. this was exposed by mistake.
`ZMQ.Socket`	`createSocket(int type)` Deprecated. use `createSocket(SocketType)`
`ZMQ.Socket`	`createSocket(SocketType type)` Creates a new managed socket within this ZContext instance.
`void`	`destroy()` Destructor.
`void`	`destroySocket(ZMQ.Socket s)` Deprecated. Not to be used any more. `ZMQ.Socket` handle the close itself. It also override linger settings.
`ZMQ.Socket`	`fork(ZThread.IAttachedRunnable runnable, Object... args)` Create an attached thread, An attached thread gets a ctx and a PAIR pipe back to its parent.
`ZMQ.Context`	`getContext()`
`int`	`getIoThreads()`
`int`	`getLinger()`
`Thread.UncaughtExceptionHandler`	`getNotificationExceptionHandler()`
`List<ZMQ.Socket>`	`getSockets()` Return a copy of the list of currently open sockets.
`Thread.UncaughtExceptionHandler`	`getUncaughtExceptionHandler()`
`boolean`	`isClosed()`
`boolean`	`isEmpty()`
`boolean`	`isMain()`
`void`	`setContext(ZMQ.Context ctx)` Deprecated. This value should not be changed after the ZContext is initialized.
`void`	`setIoThreads(int ioThreads)` Deprecated. This value should not be changed after the context is initialized.
`void`	`setLinger(int linger)`
`void`	`setMain(boolean main)` Deprecated. This value should not be changed after the context is initialized.
`void`	`setNotificationExceptionHandler(Thread.UncaughtExceptionHandler handler)` In `Poller.run()`, some non-fatal exceptions can be thrown.
`void`	`setRcvHWM(int rcvhwm)` Set initial receive HWM for all new normal sockets created in context.
`void`	`setSndHWM(int sndhwm)` Set initial receive HWM for all new normal sockets created in context.
`void`	`setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler handler)` Set the handler invoked when a `Poller` abruptly terminates due to an uncaught exception.
`ZContext`	`shadow()` Creates new shadow context.
`static ZContext`	`shadow(ZContext ctx)` Deprecated. use the instance method directly

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

- Constructor Detail
  - ZContext
```
public ZContext()
```
    Class Constructor
  - ZContext
```
public ZContext(int ioThreads)
```
- Method Detail
  - destroy
```
public void destroy()
```
    Destructor. Call this to gracefully terminate context and close any managed 0MQ sockets
  - createSocket
```
public ZMQ.Socket createSocket(SocketType type)
```
    Creates a new managed socket within this ZContext instance. Use this to get automatic management of the socket at shutdown.
    The newly created socket will inherited it's linger value from the one defined for this context.
    
    Parameters:
    
    type - socket type
    
    Returns:
    
    Newly created Socket object
  - createSocket
```
@Deprecated
public ZMQ.Socket createSocket(int type)
```
    Deprecated. use createSocket(SocketType)
    
    Parameters:
    
    type - socket type (see ZMQ static class members)
    
    Returns:
    
    Newly created Socket object
  - destroySocket
```
@Deprecated
public void destroySocket(ZMQ.Socket s)
```
    Deprecated. Not to be used any more. ZMQ.Socket handle the close itself. It also override linger settings.
    
    Destroys a managed socket within this context and remove from sockets list. This method should be used only for fast or emergency close as is set linger instead of using the socket current value.
    
    Parameters:
    
    s - ZMQ.Socket object to destroy
  - createSelector
```
@Deprecated
public Selector createSelector()
```
    Deprecated. this was exposed by mistake.
    
    Creates a selector. It needs to be closed by closeSelector(Selector).
    
    Returns:
    
    a newly created selector.
  - closeSelector
```
@Deprecated
public void closeSelector(Selector selector)
```
    Deprecated. createSelector() was exposed by mistake. while waiting for the API to disappear, this method is provided to allow releasing resources.
    
    Closes a selector. This is a DRAFT method, and may change without notice.
    
    Parameters:
    
    selector - the selector to close. It needs to have been created by createSelector().
  - createPoller
```
public ZMQ.Poller createPoller(int size)
```
  - shadow
```
@Deprecated
public static ZContext shadow(ZContext ctx)
```
    Deprecated. use the instance method directly
    
    Creates new shadow context. Shares same underlying org.zeromq.Context instance but has own list of managed sockets, io thread count etc.
    
    Parameters:
    
    ctx - Original ZContext to create shadow of
    
    Returns:
    
    New ZContext
  - shadow
```
public ZContext shadow()
```
    Creates new shadow context. Shares same underlying org.zeromq.Context instance but has own list of managed sockets, io thread count etc.
    
    Returns:
    
    New ZContext
  - fork
```
public ZMQ.Socket fork(ZThread.IAttachedRunnable runnable,
                       Object... args)
```
    Create an attached thread, An attached thread gets a ctx and a PAIR pipe back to its parent. It must monitor its pipe, and exit if the pipe becomes unreadable
    
    Parameters:
    
    runnable - attached thread
    
    args - forked runnable args
    
    Returns:
    
    pipe or null if there was an error
  - getIoThreads
```
public int getIoThreads()
```
    Returns:
    
    the ioThreads
  - setIoThreads
```
@Deprecated
public void setIoThreads(int ioThreads)
```
    Deprecated. This value should not be changed after the context is initialized.
    
    A deprecated function that does nothing.
    
    Parameters:
    
    ioThreads - the number of ioThreads to set
  - getLinger
```
public int getLinger()
```
    Returns:
    
    the default linger for sockets.
  - setLinger
```
public void setLinger(int linger)
```
    Parameters:
    
    linger - the linger that will inherited by created socket.
  - setRcvHWM
```
public void setRcvHWM(int rcvhwm)
```
    Set initial receive HWM for all new normal sockets created in context. You can set this per-socket after the socket is created. The default, no matter the underlying ZeroMQ version, is 1,000.
    
    Parameters:
    
    rcvhwm - the rcvhwm
  - setSndHWM
```
public void setSndHWM(int sndhwm)
```
    Set initial receive HWM for all new normal sockets created in context. You can set this per-socket after the socket is created. The default, no matter the underlying ZeroMQ version, is 1,000.
    
    Parameters:
    
    sndhwm - the sndhwm
  - setUncaughtExceptionHandler
```
public void setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler handler)
```
    Set the handler invoked when a Poller abruptly terminates due to an uncaught exception.
    It default to the value of Thread.getDefaultUncaughtExceptionHandler()
    
    Parameters:
    
    handler - The object to use as this thread's uncaught exception handler. If null then this thread has no explicit handler.
  - getUncaughtExceptionHandler
```
public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler()
```
    Returns:
    
    The handler invoked when a Poller abruptly terminates due to an uncaught exception.
  - setNotificationExceptionHandler
```
public void setNotificationExceptionHandler(Thread.UncaughtExceptionHandler handler)
```
    In Poller.run(), some non-fatal exceptions can be thrown. This handler will be notified, so they can be logged.
    Default to Throwable.printStackTrace()
    
    Parameters:
    
    handler - The object to use as this thread's handler for recoverable exceptions notifications.
  - getNotificationExceptionHandler
```
public Thread.UncaughtExceptionHandler getNotificationExceptionHandler()
```
    Returns:
    
    The handler invoked when a non-fatal exceptions is thrown in zmq.poll.Poller#run()
  - isMain
```
public boolean isMain()
```
    Returns:
    
    the main
  - isEmpty
```
public boolean isEmpty()
```
    Returns:
    
    true if no shadow context, no sockets and no selectors are alive.
  - setMain
```
@Deprecated
public void setMain(boolean main)
```
    Deprecated. This value should not be changed after the context is initialized.
    
    Parameters:
    
    main - whether or not the context is being set to main
  - getContext
```
public ZMQ.Context getContext()
```
    Returns:
    
    the context
  - setContext
```
@Deprecated
public void setContext(ZMQ.Context ctx)
```
    Deprecated. This value should not be changed after the ZContext is initialized.
    
    Parameters:
    
    ctx - sets the underlying zmq.Context associated with this ZContext wrapper object
  - getSockets
```
public List<ZMQ.Socket> getSockets()
```
    Return a copy of the list of currently open sockets. Order is not meaningful.
    
    Returns:
    
    the sockets
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - isClosed
```
public boolean isClosed()
```

Class ZContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ZContext

ZContext

Method Detail

destroy

createSocket

createSocket

destroySocket

createSelector

closeSelector

createPoller

shadow

shadow

fork

getIoThreads

setIoThreads

getLinger

setLinger

setRcvHWM

setSndHWM

setUncaughtExceptionHandler

getUncaughtExceptionHandler

setNotificationExceptionHandler

getNotificationExceptionHandler

isMain

isEmpty

setMain

getContext

setContext

getSockets

close

isClosed