org.zeromq.jzmq.sockets

Class SocketBuilder

java.lang.Object

org.zeromq.jzmq.sockets.SocketBuilder

All Implemented Interfaces:

Bindable, Connectable

Direct Known Subclasses:

DealerSocketBuilder, PairSocketBuilder, PubSocketBuilder, PullSocketBuilder, PushSocketBuilder, RepSocketBuilder, ReqSocketBuilder, RouterSocketBuilder, SubSocketBuilder, XPubSocketBuilder, XSubSocketBuilder

public class SocketBuilder
extends Object
implements Bindable, Connectable

SocketBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SocketBuilder.SocketSpec

Field Summary

Fields

Modifier and Type	Field and Description
protected ManagedContext	context
protected SocketBuilder.SocketSpec	socketSpec

Constructor Summary

Constructors

Constructor and Description
SocketBuilder(ManagedContext context, SocketType socketType)

Method Summary

Modifier and Type	Method and Description
Routable	asRoutable() Coerce the SocketBuilder to be Routable.
Subscribable	asSubscribable() Coerce the SocketBuilder to be Subscribable.
Socket	bind(String url) Bind to a url.
Socket	bind(String url, String... additionalUrls) Bind to a url.
protected void	bind(org.zeromq.ZMQ.Socket socket, String url, String[] additionalUrls)
Socket	connect(String url) Connect to a url.
Socket	connect(String url, String... additionalUrls) Connect to a url.
protected void	connect(org.zeromq.ZMQ.Socket socket, String url, String[] additionalUrls)
protected org.zeromq.ZMQ.Socket	createBindableSocketWithStandardSettings()
protected org.zeromq.ZMQ.Socket	createConnectableSocketWithStandardSettings()
byte[]	getIdentity() Return the identity of the socket
int	getLinger() Returns the linger period in millis
int	getReceiveHighWaterMark() Returns the receive high water mark.
int	getSendHighWaterMark() Get the send high watermark.
SocketBuilder.SocketSpec	getSocketSpec()
SocketType	getSocketType() Returns the underlying socket type
long	getSwap() Return the swap size in bytes
protected Socket	newManagedSocket(org.zeromq.ZMQ.Socket socket)
SocketBuilder	withBackgroundable(Backgroundable backgroundable)
SocketBuilder	withIdentity(byte[] identity) Set the socket identity of the specified socket.
SocketBuilder	withLinger(int lingerMS) Set the linger period for the specified socket.
SocketBuilder	withLinger(long lingerMS) Deprecated. The linger option has only integer range, use withLinger(int) instead.
SocketBuilder	withReceiveHighWatermark(int receiveHWM) The RECVHWM option shall set the high water mark (HWM) for inbound messages on the specified socket.
SocketBuilder	withReceiveHighWatermark(long receiveHWM) Deprecated. This option uses integer range, use withReceiveHighWatermark(int) instead.
SocketBuilder	withReceiveTimeout(int receiveTimeout)
SocketBuilder	withSendHighWatermark(int sendHWM) Set the send high watermark.
SocketBuilder	withSendHighWatermark(long sendHWM) Deprecated. This option uses integer range, use withSendHighWatermark(int) instead.
SocketBuilder	withSendTimeout(int sendTimeout)
SocketBuilder	withSwap(long swapSize) The swap option shall set the disk offload (swap) size for the specified socket.

Methods inherited from class java.lang.Object

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

Field Detail

context

protected ManagedContext context

socketSpec

protected SocketBuilder.SocketSpec socketSpec

Constructor Detail

SocketBuilder

public SocketBuilder(ManagedContext context,
                     SocketType socketType)

Method Detail

getSocketType

public SocketType getSocketType()

Returns the underlying socket type

Returns:

socket type

withLinger

@Deprecated
public SocketBuilder withLinger(long lingerMS)

Deprecated. The linger option has only integer range, use withLinger(int) instead.

Set the linger period for the specified socket. The linger period determines how long pending which have yet to sent to a peer shall linger in memory after a socket is closed.

Parameters:

lingerMS - the linger period in millis

Returns:

builder object

withLinger

public SocketBuilder withLinger(int lingerMS)

Set the linger period for the specified socket. The linger period determines how long pending which have yet to sent to a peer shall linger in memory after a socket is closed.

Parameters:

lingerMS - the linger period in millis

Returns:

builder object

getLinger

public int getLinger()

Returns the linger period in millis

Returns:

linger period

withIdentity

public SocketBuilder withIdentity(byte[] identity)

Set the socket identity of the specified socket. Socket identity determines if existing 0MQ infrastructure (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 the application is completely independent of other runs. The identity can only be between 0 and 256 bytes long exclusive.

Parameters:

identity - the identity

Returns:

builder object

getIdentity

public byte[] getIdentity()

Return the identity of the socket

Returns:

the identity

withSwap

public SocketBuilder withSwap(long swapSize)

The swap option shall set the disk offload (swap) size for the specified socket. A socket which has a positive value may exceed it's high water mark; in the case of outstanding messages, they shall be offloaded to storage on disk.

Parameters:

swapSize - swap in bytes

Returns:

builder object

getSwap

public long getSwap()

Return the swap size in bytes

Returns:

the swap size

withSendHighWatermark

@Deprecated
public SocketBuilder withSendHighWatermark(long sendHWM)

Deprecated. This option uses integer range, use withSendHighWatermark(int) instead.

Set the send high watermark.

Parameters:

sendHWM - The send high watermark

Returns:

builder object

withSendHighWatermark

public SocketBuilder withSendHighWatermark(int sendHWM)

Set the send high watermark.

Parameters:

sendHWM - The send high watermark

Returns:

builder object

getSendHighWaterMark

public int getSendHighWaterMark()

Get the send high watermark.

Returns:

send high watermark

withReceiveHighWatermark

@Deprecated
public SocketBuilder withReceiveHighWatermark(long receiveHWM)

Deprecated. This option uses integer range, use withReceiveHighWatermark(int) instead.

The RECVHWM option shall set the high water mark (HWM) for inbound messages on the specified socket. The HWM is a hard limit on the maximum number of outstanding 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 zmq_socket(3) for details on the exact action taken for each socket type.

Parameters:

receiveHWM - recv high water mark

Returns:

builder object

withReceiveHighWatermark

public SocketBuilder withReceiveHighWatermark(int receiveHWM)

The RECVHWM option shall set the high water mark (HWM) for inbound messages on the specified socket. The HWM is a hard limit on the maximum number of outstanding 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 zmq_socket(3) for details on the exact action taken for each socket type.

Parameters:

receiveHWM - recv high water mark

Returns:

builder object

getReceiveHighWaterMark

public int getReceiveHighWaterMark()

Returns the receive high water mark.

Returns:

receive high water mark

getSocketSpec

public SocketBuilder.SocketSpec getSocketSpec()

withReceiveTimeout

public SocketBuilder withReceiveTimeout(int receiveTimeout)

withSendTimeout

public SocketBuilder withSendTimeout(int sendTimeout)

withBackgroundable

public SocketBuilder withBackgroundable(Backgroundable backgroundable)

connect

public Socket connect(String url)

Connect to a url.

Specified by:

connect in interface Connectable

Parameters:

url - the url to connect to

Returns:

the socket

connect

public Socket connect(String url,
                      String... additionalUrls)

Description copied from interface: Connectable

Connect to a url.

Specified by:

connect in interface Connectable

Parameters:

url - the url to connect to

additionalUrls - additional urls to connect to

Returns:

the socket

connect

protected void connect(org.zeromq.ZMQ.Socket socket,
                       String url,
                       String[] additionalUrls)

createConnectableSocketWithStandardSettings

protected org.zeromq.ZMQ.Socket createConnectableSocketWithStandardSettings()

bind

public Socket bind(String url)

Bind to a url.

Specified by:

bind in interface Bindable

Parameters:

url - the url to bind to

Returns:

the socket

bind

public Socket bind(String url,
                   String... additionalUrls)

Description copied from interface: Bindable

Bind to a url.

Specified by:

bind in interface Bindable

Parameters:

url - the url to bind to

additionalUrls - additional urls to bind to

Returns:

the socket

bind

protected void bind(org.zeromq.ZMQ.Socket socket,
                    String url,
                    String[] additionalUrls)

createBindableSocketWithStandardSettings

protected org.zeromq.ZMQ.Socket createBindableSocketWithStandardSettings()

newManagedSocket

protected Socket newManagedSocket(org.zeromq.ZMQ.Socket socket)

asSubscribable

public Subscribable asSubscribable()

Coerce the SocketBuilder to be Subscribable.

Returns:

This builder object as a Subscribable

asRoutable

public Routable asRoutable()

Coerce the SocketBuilder to be Routable.

Returns:

This builder object as a Routable