Package dev.getelements.elements.rt.remote.jeromq

Class JeroMQControlClient

java.lang.Object

dev.getelements.elements.rt.remote.jeromq.JeroMQControlClient

All Implemented Interfaces:

ControlClient, AutoCloseable

public class JeroMQControlClient
extends Object
implements ControlClient

Implements the control protocol for interfacing with the JeroMQInstanceConnectionService. This client is responsible for performing control operations such as registering a node, deregistering a node, and querying available nodes. This class is designed to be used by a single thread and destroyed.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.getelements.elements.rt.remote.ControlClient

ControlClient.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_TIMEOUT
static final TimeUnit	DEFAULT_TIMEOUT_UNITS

Constructor Summary

Constructors

Constructor	Description
JeroMQControlClient(org.zeromq.ZContext zContext, String instanceConnectAddress, JeroMQSecurity securityChain)
JeroMQControlClient(org.zeromq.ZContext zContext, String instanceConnectAddress, JeroMQSecurity jeroMQSecurity, long timeout, TimeUnit timeUnit)	Creates a JeroMQControlClient connecting to the remote instance to perform basic discover and control operations.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this instance of ControlClient
void	closeBinding(NodeId nodeId)	Issues the command to close a binding.
void	closeRoutesViaInstance(InstanceId instanceId, String instanceConnectAddress)	Close the routes via the InstanceId.
InstanceStatus	getInstanceStatus()	Gets the InstanceId for the remote instance.
RoutingStatus	getRoutingStatus()	Gets the routing status for the system.
static org.zeromq.ZMQ.Socket	open(JeroMQSecurity securityChain, org.zeromq.ZContext zContext)	Opens and configures the ZMQ.Socket type used to connect to the remote JeroMQCommandServer.
InstanceConnectionService.InstanceBinding	openBinding(NodeId nodeId)	Opens an InstanceConnectionService.InstanceBinding provided the NodeId and returns the InstanceConnectionService.InstanceBinding.
String	openRouteToNode(NodeId nodeId, String instanceInvokerAddress)	Issues the command to open up a route to the node.
static org.zeromq.ZMsg	recv(org.zeromq.ZMQ.Socket socket)	Receives a message from the supplied ZMQ.Socket instance.
static boolean	send(org.zeromq.ZMsg zMsg, org.zeromq.ZMQ.Socket socket)	Sends the supplied ZMsg on the supplied ZMQ.Socket, adding header and delimiter information as necessary
void	setReceiveTimeout(long timeout, TimeUnit timeUnit)	Allows for the adjustment of this ControlClient's receive timeout.
static void	trace(org.zeromq.ZMsg zMsg, StackTraceElement[] trace)	Embeds the supplied stack trace in the supplied ZMsg.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TIMEOUT

public static final long DEFAULT_TIMEOUT

See Also:

• Constant Field Values

DEFAULT_TIMEOUT_UNITS

public static final TimeUnit DEFAULT_TIMEOUT_UNITS

Constructor Details

JeroMQControlClient

public JeroMQControlClient(org.zeromq.ZContext zContext,
 String instanceConnectAddress,
 JeroMQSecurity securityChain)

JeroMQControlClient

public JeroMQControlClient(org.zeromq.ZContext zContext,
 String instanceConnectAddress,
 JeroMQSecurity jeroMQSecurity,
 long timeout,
 TimeUnit timeUnit)

Creates a JeroMQControlClient connecting to the remote instance to perform basic discover and control operations. This uses ZContext.shadow(ZContext) to make a shadow copy of the ZContext and then closes it later.

Parameters:

zContext - the ZContext used to communicate

instanceConnectAddress -

Method Details

open

public static org.zeromq.ZMQ.Socket open(JeroMQSecurity securityChain,
 org.zeromq.ZContext zContext)

Opens and configures the ZMQ.Socket type used to connect to the remote JeroMQCommandServer.

Parameters:

zContext - the context which to use when creating the socket

Returns:

the ZMQ.Socket type

getRoutingStatus

public RoutingStatus getRoutingStatus()

Description copied from interface: ControlClient

Gets the routing status for the system.

Specified by:

getRoutingStatus in interface ControlClient

Returns:

the routing status.

getInstanceStatus

public InstanceStatus getInstanceStatus()

Description copied from interface: ControlClient

Gets the InstanceId for the remote instance.

Specified by:

getInstanceStatus in interface ControlClient

Returns:

the InstanceStatus

openRouteToNode

public String openRouteToNode(NodeId nodeId,
 String instanceInvokerAddress)

Description copied from interface: ControlClient

Issues the command to open up a route to the node.

Specified by:

openRouteToNode in interface ControlClient

Parameters:

nodeId - the NodeId

instanceInvokerAddress -

Returns:

the connect address for the node

closeRoutesViaInstance

public void closeRoutesViaInstance(InstanceId instanceId,
 String instanceConnectAddress)

Description copied from interface: ControlClient

Close the routes via the InstanceId. If no routes are known, then nothing happens.

Specified by:

closeRoutesViaInstance in interface ControlClient

Parameters:

instanceId - the InstanceId

openBinding

public InstanceConnectionService.InstanceBinding openBinding(NodeId nodeId)

Description copied from interface: ControlClient

Opens an InstanceConnectionService.InstanceBinding provided the NodeId and returns the InstanceConnectionService.InstanceBinding.

Specified by:

openBinding in interface ControlClient

Parameters:

nodeId - the NodeId

Returns:

the InstanceConnectionService.InstanceBinding

closeBinding

public void closeBinding(NodeId nodeId)

Description copied from interface: ControlClient

Issues the command to close a binding. This will invalidate all InstanceConnectionService.InstanceBindings to that NodeId.

Specified by:

closeBinding in interface ControlClient

Parameters:

nodeId -

setReceiveTimeout

public void setReceiveTimeout(long timeout,
 TimeUnit timeUnit)

Description copied from interface: ControlClient

Allows for the adjustment of this ControlClient's receive timeout.

Specified by:

setReceiveTimeout in interface ControlClient

Parameters:

timeout - the timeout

timeUnit - the TimeUnit

send

public static boolean send(org.zeromq.ZMsg zMsg,
 org.zeromq.ZMQ.Socket socket)

Sends the supplied ZMsg on the supplied ZMQ.Socket, adding header and delimiter information as necessary

Parameters:

zMsg - the ZMsg to send

socket - the ZMQ.Socket to use to send the request

trace

public static void trace(org.zeromq.ZMsg zMsg,
 StackTraceElement[] trace)

Embeds the supplied stack trace in the supplied ZMsg. The remote end will ignore the trace, however it will be visible in the debugger so it is possible to know where in the client code the message originated.

Parameters:

zMsg - the message

trace - the trace

recv

public static org.zeromq.ZMsg recv(org.zeromq.ZMQ.Socket socket)

Receives a message from the supplied ZMQ.Socket instance.

Parameters:

socket - the socket on which to receive the incoming message.

Returns:

the ZMsg instance

close

public void close()

Description copied from interface: ControlClient

Closes this instance of ControlClient

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ControlClient