ZMQ.Socket (JeroMQ 0.3.5 API)

java.lang.Object
- org.zeromq.ZMQ.Socket

All Implemented Interfaces:: Closeable, AutoCloseable

Enclosing class:: ZMQ

public static class ZMQ.Socket
extends Object
implements Closeable

Constructor Summary

Constructors
Modifier Constructor and Description

protected ZMQ.Socket(SocketBase base)

protected ZMQ.Socket(ZMQ.Context context, int type)
Class constructor.

Constructors
Modifier	Constructor and Description
`protected`	`ZMQ.Socket(SocketBase base)`
`protected`	`ZMQ.Socket(ZMQ.Context context, int type)` Class constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`SocketBase`	`base()` DO NOT USE if you're trying to build a special proxy
`void`	`bind(String addr)` Bind to network interface.
`int`	`bindToRandomPort(String addr)` Bind to network interface to a random port.
`int`	`bindToRandomPort(String addr, int min, int max)` Bind to network interface to a random port.
`void`	`close()` This is an explicit "destructor".
`void`	`connect(String addr)` Connect to remote application.
`boolean`	`disconnect(String addr)` Disconnect to remote application.
`long`	`getAffinity()`
`long`	`getBacklog()`
`boolean`	`getDelayAttachOnConnect()`
`int`	`getEvents()` The 'ZMQ_EVENTS' option shall retrieve event flags for the specified socket.
`SelectableChannel`	`getFD()` The 'ZMQ_FD' option shall retrieve file descriptor associated with the 0MQ socket.
`long`	`getHWM()` Deprecated.
`byte[]`	`getIdentity()`
`boolean`	`getIPv4Only()`
`long`	`getLinger()`
`long`	`getMaxMsgSize()`
`long`	`getMulticastHops()`
`long`	`getRate()`
`long`	`getRcvHWM()`
`long`	`getReceiveBufferSize()`
`int`	`getReceiveTimeOut()`
`long`	`getReconnectIVL()`
`long`	`getReconnectIVLMax()`
`long`	`getRecoveryInterval()`
`long`	`getSendBufferSize()`
`int`	`getSendTimeOut()`
`long`	`getSndHWM()`
`long`	`getSwap()` Deprecated.
`int`	`getTCPKeepAlive()`
`long`	`getTCPKeepAliveCount()`
`long`	`getTCPKeepAliveIdle()`
`long`	`getTCPKeepAliveInterval()`
`long`	`getTCPKeepAliveSetting()`
`int`	`getType()` The 'ZMQ_TYPE option shall retrieve the socket type for the specified 'socket'.
`boolean`	`hasMulticastLoop()` Deprecated.
`boolean`	`hasReceiveMore()` The 'ZMQ_RCVMORE' option shall return a boolean value indicating if the multi-part message currently being read from the specified 'socket' has more message parts to follow.
`boolean`	`monitor(String addr, int events)` Start a monitoring socket where events can be received.
`byte[]`	`recv()` Receive a message.
`int`	`recv(byte[] buffer, int offset, int len, int flags)` Receive a message in to a specified buffer.
`byte[]`	`recv(int flags)` Receive a message.
`int`	`recvByteBuffer(ByteBuffer buffer, int flags)` Receive a message into the specified ByteBuffer
`String`	`recvStr()`
`String`	`recvStr(int flags)`
`boolean`	`send(byte[] data)`
`boolean`	`send(byte[] data, int flags)`
`boolean`	`send(byte[] data, int off, int length, int flags)`
`boolean`	`send(String data)`
`boolean`	`send(String data, int flags)`
`int`	`sendByteBuffer(ByteBuffer data, int flags)` Send a message
`boolean`	`sendMore(byte[] data)`
`boolean`	`sendMore(String data)`
`void`	`setAffinity(long value)` Get the Affinity.
`void`	`setBacklog(long value)`
`void`	`setDecoder(Class<? extends DecoderBase> cls)` Set custom Decoder
`void`	`setDelayAttachOnConnect(boolean value)` Accept messages only when connections are made If set to true, will delay the attachment of a pipe on connect until the underlying connection has completed.
`void`	`setEncoder(Class<? extends EncoderBase> cls)` Set custom Encoder
`void`	`setHWM(long hwm)` The 'ZMQ_HWM' option shall set the high water mark for the specified 'socket'.
`void`	`setIdentity(byte[] identity)` The 'ZMQ_IDENTITY' option shall set the identity of the specified 'socket'.
`void`	`setIPv4Only(boolean v4only)` The 'ZMQ_IPV4ONLY' option shall set the underlying native socket type.
`void`	`setLinger(long value)` The 'ZMQ_LINGER' option shall retrieve the period for pending outbound messages to linger in memory after closing the socket.
`void`	`setMaxMsgSize(long value)`
`void`	`setMulticastHops(long value)` Sets the time-to-live field in every multicast packet sent from this socket.
`void`	`setMulticastLoop(boolean multicastLoop)` Deprecated.
`void`	`setRate(long value)` The 'ZMQ_RATE' option shall set the maximum send or receive data rate for multicast transports such as in the man page of zmq_pgm[7] using the specified 'socket'.
`void`	`setRcvHWM(long value)`
`void`	`setReceiveBufferSize(long value)` The 'ZMQ_RCVBUF' option shall set the underlying kernel receive buffer size for the 'socket' to the specified size in bytes.
`void`	`setReceiveTimeOut(int value)` Sets the timeout for receive operation on the socket.
`void`	`setReconnectIVL(long value)`
`void`	`setReconnectIVLMax(long value)`
`void`	`setRecoveryInterval(long value)` The 'ZMQ_RECOVERY_IVL' option shall set the recovery interval for multicast transports using the specified 'socket'.
`void`	`setRouterHandlover(boolean handlover)` If two clients use the same identity when connecting to a ROUTER, the results shall depend on the ZMQ_ROUTER_HANDOVER option setting
`void`	`setRouterMandatory(boolean mandatory)` Sets the ROUTER socket behavior when an unroutable message is encountered.
`void`	`setSendBufferSize(long value)` The 'ZMQ_SNDBUF' option shall set the underlying kernel transmit buffer size for the 'socket' to the specified size in bytes.
`void`	`setSendTimeOut(int value)` Sets the timeout for send operation on the socket.
`void`	`setSndHWM(long value)`
`void`	`setSwap(long value)` Deprecated.
`void`	`setTCPKeepAlive(int optVal)` Override SO_KEEPALIVE socket option (where supported by OS) to enable keep-alive packets for a socket connection.
`void`	`setTCPKeepAlive(long value)` Override SO_KEEPALIVE socket option (where supported by OS) to enable keep-alive packets for a socket connection.
`void`	`setTCPKeepAliveCount(long value)` Override TCP_KEEPCNT socket option (where supported by OS).
`void`	`setTCPKeepAliveIdle(long value)` Override TCP_KEEPCNT (or TCP_KEEPALIVE on some OS) socket option (where supported by OS).
`void`	`setTCPKeepAliveInterval(long value)` Override TCP_KEEPINTVL socket option (where supported by OS).
`void`	`setXpubVerbose(boolean verbose)` Sets the XPUB socket behavior on new subscriptions and unsubscriptions.
`void`	`subscribe(byte[] topic)` The 'ZMQ_SUBSCRIBE' option shall establish a new message filter on a 'ZMQ_SUB' socket.
`boolean`	`unbind(String addr)` Stop accepting connections on a socket.
`void`	`unsubscribe(byte[] topic)` The 'ZMQ_UNSUBSCRIBE' option shall remove an existing message filter on a 'ZMQ_SUB' socket.

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

- Constructor Detail
  - ZMQ.Socket
```
protected ZMQ.Socket(ZMQ.Context context,
          int type)
```
    Class constructor.
    
    Parameters:
    context - a 0MQ context previously created.
    type - the socket type.
  - ZMQ.Socket
```
protected ZMQ.Socket(SocketBase base)
```
- Method Detail
  - base
```
public SocketBase base()
```
    DO NOT USE if you're trying to build a special proxy
    
    Returns:
    raw zmq.SocketBase
  - close
```
public void close()
```
    This is an explicit "destructor". It can be called to ensure the corresponding 0MQ Socket has been disposed of.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - getType
```
public final int getType()
```
    The 'ZMQ_TYPE option shall retrieve the socket type for the specified 'socket'. The socket type is specified at socket creation time and cannot be modified afterwards.
    
    Returns:
    the socket type.
  - getLinger
```
public final long getLinger()
```
    Returns:
    the linger period.
    See Also:
    setLinger(long)
  - setLinger
```
public final void setLinger(long value)
```
    The 'ZMQ_LINGER' option shall retrieve the period for pending outbound messages to linger in memory after closing the socket. Value of -1 means infinite. Pending messages will be kept until they are fully transferred to the peer. Value of 0 means that all the pending messages are dropped immediately when socket is closed. Positive value means number of milliseconds to keep trying to send the pending messages before discarding them.
    
    Parameters:
    value - the linger period in milliseconds.
  - getReconnectIVL
```
public final long getReconnectIVL()
```
    Returns:
    the reconnectIVL.
    See Also:
    setReconnectIVL(long)
  - setReconnectIVL
```
public final void setReconnectIVL(long value)
```
  - getBacklog
```
public final long getBacklog()
```
    Returns:
    the backlog.
    See Also:
    setBacklog(long)
  - setBacklog
```
public final void setBacklog(long value)
```
  - getReconnectIVLMax
```
public final long getReconnectIVLMax()
```
    Returns:
    the reconnectIVLMax.
    See Also:
    setReconnectIVLMax(long)
  - setReconnectIVLMax
```
public final void setReconnectIVLMax(long value)
```
  - getMaxMsgSize
```
public final long getMaxMsgSize()
```
    Returns:
    the maxMsgSize.
    See Also:
    setMaxMsgSize(long)
  - setMaxMsgSize
```
public final void setMaxMsgSize(long value)
```
  - getSndHWM
```
public final long getSndHWM()
```
    Returns:
    the SndHWM.
    See Also:
    setSndHWM(long)
  - setSndHWM
```
public final void setSndHWM(long value)
```
  - getRcvHWM
```
public final long getRcvHWM()
```
    Returns:
    the recvHWM period.
    See Also:
    setRcvHWM(long)
  - setRcvHWM
```
public final void setRcvHWM(long value)
```
  - getHWM
```
@Deprecated
public final long getHWM()
```
    Deprecated.
    
    Returns:
    the High Water Mark.
    See Also:
    setHWM(long)
  - setHWM
```
public final void setHWM(long hwm)
```
    The 'ZMQ_HWM' option shall set the high water mark for the specified 'socket'. The high water mark is a hard limit on the maximum number of outstanding messages 0MQ shall queue in memory for any single peer that the specified 'socket' is communicating with. If this limit has been reached the socket shall enter an exceptional state and depending on the socket type, 0MQ shall take appropriate action such as blocking or dropping sent messages. Refer to the individual socket descriptions in the man page of zmq_socket[3] for details on the exact action taken for each socket type.
    
    Parameters:
    hwm - the number of messages to queue.
  - getSwap
```
@Deprecated
public final long getSwap()
```
    Deprecated.
    
    Returns:
    the number of messages to swap at most.
    See Also:
    setSwap(long)
  - setSwap
```
@Deprecated
public final void setSwap(long value)
```
    Deprecated.
    
    Get the Swap. The 'ZMQ_SWAP' option shall set the disk offload (swap) size for the specified 'socket'. A socket which has 'ZMQ_SWAP' set to a non-zero value may exceed its high water mark; in this case outstanding messages shall be offloaded to storage on disk rather than held in memory.
    
    Parameters:
    value - The value of 'ZMQ_SWAP' defines the maximum size of the swap space in bytes.
  - getAffinity
```
public final long getAffinity()
```
    Returns:
    the affinity.
    See Also:
    setAffinity(long)
  - setAffinity
```
public final void setAffinity(long value)
```
    Get the Affinity. The 'ZMQ_AFFINITY' option shall set the I/O thread affinity for newly created connections on the specified 'socket'. Affinity determines which threads from the 0MQ I/O thread pool associated with the socket's _context_ shall handle newly created connections. A value of zero specifies no affinity, meaning that work shall be distributed fairly among all 0MQ I/O threads in the thread pool. For non-zero values, the lowest bit corresponds to thread 1, second lowest bit to thread 2 and so on. For example, a value of 3 specifies that subsequent connections on 'socket' shall be handled exclusively by I/O threads 1 and 2. See also in the man page of init[3] for details on allocating the number of I/O threads for a specific _context_.
    
    Parameters:
    value - the io_thread affinity.
  - getIdentity
```
public final byte[] getIdentity()
```
    Returns:
    the Identitiy.
    See Also:
    setIdentity(byte[])
  - setIdentity
```
public final void setIdentity(byte[] identity)
```
    The 'ZMQ_IDENTITY' option shall set the identity of the specified 'socket'. Socket identity determines if existing 0MQ infastructure (_message queues_, _forwarding devices_) shall be identified with a specific application and persist across multiple runs of the application. If the socket has no identity, each run of an application is completely separate from other runs. However, with identity set the socket shall re-use any existing 0MQ infrastructure configured by the previous run(s). Thus the application may receive messages that were sent in the meantime, _message queue_ limits shall be shared with previous run(s) and so on. Identity should be at least one byte and at most 255 bytes long. Identities starting with binary zero are reserved for use by 0MQ infrastructure.
    
    Parameters:
    identity -
  - getRate
```
public final long getRate()
```
    Returns:
    the Rate.
    See Also:
    setRate(long)
  - setRate
```
public final void setRate(long value)
```
    The 'ZMQ_RATE' option shall set the maximum send or receive data rate for multicast transports such as in the man page of zmq_pgm[7] using the specified 'socket'.
    
    Parameters:
    value - maximum send or receive data rate for multicast, default 100
  - getRecoveryInterval
```
public final long getRecoveryInterval()
```
    Returns:
    the RecoveryIntervall.
    See Also:
    setRecoveryInterval(long)
  - setRecoveryInterval
```
public final void setRecoveryInterval(long value)
```
    The 'ZMQ_RECOVERY_IVL' option shall set the recovery interval for multicast transports using the specified 'socket'. The recovery interval determines the maximum time in seconds that a receiver can be absent from a multicast group before unrecoverable data loss will occur. CAUTION: Excersize care when setting large recovery intervals as the data needed for recovery will be held in memory. For example, a 1 minute recovery interval at a data rate of 1Gbps requires a 7GB in-memory buffer. {Purpose of this Method}
    
    Parameters:
    value - recovery interval for multicast in milliseconds, default 10000
  - hasMulticastLoop
```
@Deprecated
public final boolean hasMulticastLoop()
```
    Deprecated.
    
    Returns:
    the Multicast Loop.
    See Also:
    setMulticastLoop(boolean)
  - setMulticastLoop
```
@Deprecated
public final void setMulticastLoop(boolean multicastLoop)
```
    Deprecated.
    
    The 'ZMQ_MCAST_LOOP' option shall control whether data sent via multicast transports using the specified 'socket' can also be received by the sending host via loopback. A value of zero disables the loopback functionality, while the default value of 1 enables the loopback functionality. Leaving multicast loopback enabled when it is not required can have a negative impact on performance. Where possible, disable 'ZMQ_MCAST_LOOP' in production environments.
    
    Parameters:
    multicastLoop -
  - getMulticastHops
```
public final long getMulticastHops()
```
    Returns:
    the Multicast Hops.
    See Also:
    setMulticastHops(long)
  - setMulticastHops
```
public final void setMulticastHops(long value)
```
    Sets the time-to-live field in every multicast packet sent from this socket. The default is 1 which means that the multicast packets don't leave the local network.
    
    Parameters:
    value - time-to-live field in every multicast packet, default 1
  - getReceiveTimeOut
```
public final int getReceiveTimeOut()
```
    Returns:
    the Receive Timeout in milliseconds.
    See Also:
    setReceiveTimeOut(int)
  - setReceiveTimeOut
```
public final void setReceiveTimeOut(int value)
```
    Sets the timeout for receive operation on the socket. If the value is 0, recv will return immediately, with null if there is no message to receive. If the value is -1, it will block until a message is available. For all other values, it will wait for a message for that amount of time before returning with a null and an EAGAIN error.
    
    Parameters:
    value - Timeout for receive operation in milliseconds. Default -1 (infinite)
  - getSendTimeOut
```
public final int getSendTimeOut()
```
    Returns:
    the Send Timeout in milliseconds.
    See Also:
    setSendTimeOut(int)
  - setSendTimeOut
```
public final void setSendTimeOut(int value)
```
    Sets the timeout for send operation on the socket. If the value is 0, send will return immediately, with a false if the message cannot be sent. If the value is -1, it will block until the message is sent. For all other values, it will try to send the message for that amount of time before returning with false and an EAGAIN error.
    
    Parameters:
    value - Timeout for send operation in milliseconds. Default -1 (infinite)
  - setTCPKeepAlive
```
public void setTCPKeepAlive(long value)
```
    Override SO_KEEPALIVE socket option (where supported by OS) to enable keep-alive packets for a socket connection. Possible values are -1, 0, 1. The default value -1 will skip all overrides and do the OS default.
    
    Parameters:
    value - The value of 'ZMQ_TCP_KEEPALIVE' to turn TCP keepalives on (1) or off (0).
  - getTCPKeepAliveSetting
```
public long getTCPKeepAliveSetting()
```
    Returns:
    the keep alive setting.
    See Also:
    setTCPKeepAlive(long)
  - setTCPKeepAliveCount
```
public void setTCPKeepAliveCount(long value)
```
    Override TCP_KEEPCNT socket option (where supported by OS). The default value -1 will skip all overrides and do the OS default.
    
    Parameters:
    value - The value of 'ZMQ_TCP_KEEPALIVE_CNT' defines the number of keepalives before death.
  - getTCPKeepAliveCount
```
public long getTCPKeepAliveCount()
```
    Returns:
    the keep alive count.
    See Also:
    setTCPKeepAliveCount(long)
  - setTCPKeepAliveInterval
```
public void setTCPKeepAliveInterval(long value)
```
    Override TCP_KEEPINTVL socket option (where supported by OS). The default value -1 will skip all overrides and do the OS default.
    
    Parameters:
    value - The value of 'ZMQ_TCP_KEEPALIVE_INTVL' defines the interval between keepalives. Unit is OS dependant.
  - getTCPKeepAliveInterval
```
public long getTCPKeepAliveInterval()
```
    Returns:
    the keep alive interval.
    See Also:
    setTCPKeepAliveInterval(long)
  - setTCPKeepAliveIdle
```
public void setTCPKeepAliveIdle(long value)
```
    Override TCP_KEEPCNT (or TCP_KEEPALIVE on some OS) socket option (where supported by OS). The default value -1 will skip all overrides and do the OS default.
    
    Parameters:
    value - The value of 'ZMQ_TCP_KEEPALIVE_IDLE' defines the interval between the last data packet sent over the socket and the first keepalive probe. Unit is OS dependant.
  - getTCPKeepAliveIdle
```
public long getTCPKeepAliveIdle()
```
    Returns:
    the keep alive idle value.
    See Also:
    setTCPKeepAliveIdle(long)
  - getSendBufferSize
```
public final long getSendBufferSize()
```
    Returns:
    the kernel send buffer size.
    See Also:
    setSendBufferSize(long)
  - setSendBufferSize
```
public final void setSendBufferSize(long value)
```
    The 'ZMQ_SNDBUF' option shall set the underlying kernel transmit buffer size for the 'socket' to the specified size in bytes. A value of zero means leave the OS default unchanged. For details please refer to your operating system documentation for the 'SO_SNDBUF' socket option.
    
    Parameters:
    value - underlying kernel transmit buffer size for the 'socket' in bytes A value of zero means leave the OS default unchanged.
  - getReceiveBufferSize
```
public final long getReceiveBufferSize()
```
    Returns:
    the kernel receive buffer size.
    See Also:
    setReceiveBufferSize(long)
  - setReceiveBufferSize
```
public final void setReceiveBufferSize(long value)
```
    The 'ZMQ_RCVBUF' option shall set the underlying kernel receive buffer size for the 'socket' to the specified size in bytes. For details refer to your operating system documentation for the 'SO_RCVBUF' socket option.
    
    Parameters:
    value - Underlying kernel receive buffer size for the 'socket' in bytes. A value of zero means leave the OS default unchanged.
  - hasReceiveMore
```
public final boolean hasReceiveMore()
```
    The 'ZMQ_RCVMORE' option shall return a boolean value indicating if the multi-part message currently being read from the specified 'socket' has more message parts to follow. If there are no message parts to follow or if the message currently being read is not a multi-part message a value of zero shall be returned. Otherwise, a value of 1 shall be returned.
    
    Returns:
    true if there are more messages to receive.
  - getFD
```
public final SelectableChannel getFD()
```
    The 'ZMQ_FD' option shall retrieve file descriptor associated with the 0MQ socket. The descriptor can be used to integrate 0MQ socket into an existing event loop. It should never be used for anything else than polling -- such as reading or writing. The descriptor signals edge-triggered IN event when something has happened within the 0MQ socket. It does not necessarily mean that the messages can be read or written. Check ZMQ_EVENTS option to find out whether the 0MQ socket is readable or writeable.
    
    Returns:
    the underlying file descriptor.
  - getEvents
```
public final int getEvents()
```
    The 'ZMQ_EVENTS' option shall retrieve event flags for the specified socket. If a message can be read from the socket ZMQ_POLLIN flag is set. If message can be written to the socket ZMQ_POLLOUT flag is set.
    
    Returns:
    the mask of outstanding events.
  - subscribe
```
public final void subscribe(byte[] topic)
```
    The 'ZMQ_SUBSCRIBE' option shall establish a new message filter on a 'ZMQ_SUB' socket. Newly created 'ZMQ_SUB' sockets shall filter out all incoming messages, therefore you should call this option to establish an initial message filter. An empty 'option_value' of length zero shall subscribe to all incoming messages. A non-empty 'option_value' shall subscribe to all messages beginning with the specified prefix. Mutiple filters may be attached to a single 'ZMQ_SUB' socket, in which case a message shall be accepted if it matches at least one filter.
    
    Parameters:
    topic -
  - unsubscribe
```
public final void unsubscribe(byte[] topic)
```
    The 'ZMQ_UNSUBSCRIBE' option shall remove an existing message filter on a 'ZMQ_SUB' socket. The filter specified must match an existing filter previously established with the 'ZMQ_SUBSCRIBE' option. If the socket has several instances of the same filter attached the 'ZMQ_UNSUBSCRIBE' option shall remove only one instance, leaving the rest in place and functional.
    
    Parameters:
    topic -
  - setEncoder
```
public final void setEncoder(Class<? extends EncoderBase> cls)
```
    Set custom Encoder
    
    Parameters:
    cls -
  - setDecoder
```
public final void setDecoder(Class<? extends DecoderBase> cls)
```
    Set custom Decoder
    
    Parameters:
    cls -
  - setRouterMandatory
```
public final void setRouterMandatory(boolean mandatory)
```
    Sets the ROUTER socket behavior when an unroutable message is encountered.
    
    Parameters:
    mandatory - A value of false is the default and discards the message silently when it cannot be routed. A value of true returns an EHOSTUNREACH error code if the message cannot be routed.
  - setRouterHandlover
```
public final void setRouterHandlover(boolean handlover)
```
    If two clients use the same identity when connecting to a ROUTER, the results shall depend on the ZMQ_ROUTER_HANDOVER option setting
    
    Parameters:
    handlover - A value of false, (default) the ROUTER socket shall reject clients trying to connect with an already-used identity A value of true, the ROUTER socket shall hand-over the connection to the new client and disconnect the existing one
  - setXpubVerbose
```
public final void setXpubVerbose(boolean verbose)
```
    Sets the XPUB socket behavior on new subscriptions and unsubscriptions.
    
    Parameters:
    verbose - A value of false is the default and passes only new subscription messages to upstream. A value of true passes all subscription messages upstream.
  - getIPv4Only
```
public final boolean getIPv4Only()
```
    Returns:
    the IPV4ONLY
    See Also:
    (boolean)
  - setIPv4Only
```
public void setIPv4Only(boolean v4only)
```
    The 'ZMQ_IPV4ONLY' option shall set the underlying native socket type. An IPv6 socket lets applications connect to and accept connections from both IPv4 and IPv6 hosts.
    
    Parameters:
    v4only - A value of true will use IPv4 sockets, while the value of false will use IPv6 sockets
  - getTCPKeepAlive
```
public int getTCPKeepAlive()
```
    Returns:
    the keep alive setting.
    See Also:
    setTCPKeepAlive(int)
  - setTCPKeepAlive
```
public void setTCPKeepAlive(int optVal)
```
    Override SO_KEEPALIVE socket option (where supported by OS) to enable keep-alive packets for a socket connection. Possible values are -1, 0, 1. The default value -1 will skip all overrides and do the OS default.
    
    Parameters:
    optVal - The value of 'ZMQ_TCP_KEEPALIVE' to turn TCP keepalives on (1) or off (0).
  - getDelayAttachOnConnect
```
public boolean getDelayAttachOnConnect()
```
    Returns:
    the keep alive setting.
    See Also:
    setDelayAttachOnConnect(boolean)
  - setDelayAttachOnConnect
```
public void setDelayAttachOnConnect(boolean value)
```
    Accept messages only when connections are made If set to true, will delay the attachment of a pipe on connect until the underlying connection has completed. This will cause the socket to block if there are no other connections, but will prevent queues from filling on pipes awaiting connection
    
    Parameters:
    value - The value of 'ZMQ_DELAY_ATTACH_ON_CONNECT'. Default false.
  - bind
```
public final void bind(String addr)
```
    Bind to network interface. Start listening for new connections.
    
    Parameters:
    addr - the endpoint to bind to.
  - bindToRandomPort
```
public int bindToRandomPort(String addr)
```
    Bind to network interface to a random port. Start listening for new connections.
    
    Parameters:
    addr - the endpoint to bind to.
  - bindToRandomPort
```
public int bindToRandomPort(String addr,
                   int min,
                   int max)
```
    Bind to network interface to a random port. Start listening for new connections.
    
    Parameters:
    addr - the endpoint to bind to.
    min - The minimum port in the range of ports to try.
    max - The maximum port in the range of ports to try.
  - connect
```
public final void connect(String addr)
```
    Connect to remote application.
    
    Parameters:
    addr - the endpoint to connect to.
  - disconnect
```
public final boolean disconnect(String addr)
```
    Disconnect to remote application.
    
    Parameters:
    addr - the endpoint to disconnect to.
    
    Returns:
    true if successful.
  - unbind
```
public final boolean unbind(String addr)
```
    Stop accepting connections on a socket.
    
    Parameters:
    addr - the endpoint to unbind from.
    
    Returns:
    true if successful.
  - send
```
public final boolean send(String data)
```
  - sendMore
```
public final boolean sendMore(String data)
```
  - send
```
public final boolean send(String data,
           int flags)
```
  - send
```
public final boolean send(byte[] data)
```
  - sendMore
```
public final boolean sendMore(byte[] data)
```
  - send
```
public final boolean send(byte[] data,
           int flags)
```
  - send
```
public final boolean send(byte[] data,
           int off,
           int length,
           int flags)
```
  - sendByteBuffer
```
public final int sendByteBuffer(ByteBuffer data,
                 int flags)
```
    Send a message
    
    Parameters:
    data - ByteBuffer payload
    flags - the flags to apply to the send operation
    
    Returns:
    the number of bytes sent, -1 on error
  - recv
```
public final byte[] recv()
```
    Receive a message.
    
    Returns:
    the message received, as an array of bytes; null on error.
  - recv
```
public final byte[] recv(int flags)
```
    Receive a message.
    
    Parameters:
    flags - the flags to apply to the receive operation.
    
    Returns:
    the message received, as an array of bytes; null on error.
  - recv
```
public final int recv(byte[] buffer,
       int offset,
       int len,
       int flags)
```
    Receive a message in to a specified buffer.
    
    Parameters:
    buffer - byte[] to copy zmq message payload in to.
    offset - offset in buffer to write data
    len - max bytes to write to buffer. If len is smaller than the incoming message size, the message will be truncated.
    flags - the flags to apply to the receive operation.
    
    Returns:
    the number of bytes read, -1 on error
  - recvByteBuffer
```
public final int recvByteBuffer(ByteBuffer buffer,
                 int flags)
```
    Receive a message into the specified ByteBuffer
    
    Parameters:
    buffer - the buffer to copy the zmq message payload into
    flags - the flags to apply to the receive operation
    
    Returns:
    the number of bytes read, -1 on error
  - recvStr
```
public final String recvStr()
```
    Returns:
    the message received, as a String object; null on no message.
  - recvStr
```
public final String recvStr(int flags)
```
    Parameters:
    flags - the flags to apply to the receive operation.
    
    Returns:
    the message received, as a String object; null on no message.
  - monitor
```
public boolean monitor(String addr,
              int events)
```
    Start a monitoring socket where events can be received.
    
    Parameters:
    addr - the endpoint to receive events from. (must be inproc transport)
    events - the events of interest.
    
    Returns:
    true if monitor socket setup is successful
    
    Throws:
    
    ZMQException

Class ZMQ.Socket

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ZMQ.Socket

ZMQ.Socket

Method Detail

base

close

getType

getLinger

setLinger

getReconnectIVL

setReconnectIVL

getBacklog

setBacklog

getReconnectIVLMax

setReconnectIVLMax

getMaxMsgSize

setMaxMsgSize

getSndHWM

setSndHWM

getRcvHWM

setRcvHWM

getHWM

setHWM

getSwap

setSwap

getAffinity

setAffinity

getIdentity

setIdentity

getRate

setRate

getRecoveryInterval

setRecoveryInterval

hasMulticastLoop

setMulticastLoop

getMulticastHops

setMulticastHops

getReceiveTimeOut

setReceiveTimeOut

getSendTimeOut

setSendTimeOut

setTCPKeepAlive

getTCPKeepAliveSetting

setTCPKeepAliveCount

getTCPKeepAliveCount

setTCPKeepAliveInterval

getTCPKeepAliveInterval

setTCPKeepAliveIdle

getTCPKeepAliveIdle

getSendBufferSize

setSendBufferSize

getReceiveBufferSize

setReceiveBufferSize

hasReceiveMore

getFD

getEvents

subscribe

unsubscribe

setEncoder

setDecoder

setRouterMandatory

setRouterHandlover

setXpubVerbose

getIPv4Only

setIPv4Only

getTCPKeepAlive

setTCPKeepAlive

getDelayAttachOnConnect

setDelayAttachOnConnect

bind

bindToRandomPort

bindToRandomPort

connect

disconnect

unbind

send