net.formicary.remoterun.embed

Class RemoteRunMaster

java.lang.Object

org.jboss.netty.channel.SimpleChannelHandler

net.formicary.remoterun.embed.RemoteRunMaster

All Implemented Interfaces:

EventListener, org.jboss.netty.channel.ChannelDownstreamHandler, org.jboss.netty.channel.ChannelFutureListener, org.jboss.netty.channel.ChannelHandler, org.jboss.netty.channel.ChannelUpstreamHandler

public class RemoteRunMaster
extends org.jboss.netty.channel.SimpleChannelHandler
implements org.jboss.netty.channel.ChannelFutureListener

Create a RemoteRunMaster then call bind(java.net.InetSocketAddress) to start a TCP server to listen for agent connections.

Author:

Chris Pearson

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler

org.jboss.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from interface org.jboss.netty.channel.ChannelFutureListener

CLOSE, CLOSE_ON_FAILURE

Constructor Summary

Constructors

Constructor and Description
RemoteRunMaster() The same as new RemoteRunMaster(Executors.newCachedThreadPool(), Executors.newCachedThreadPool(), null).
RemoteRunMaster(AgentConnectionCallback callback) The same as new RemoteRunMaster(Executors.newCachedThreadPool(), Executors.newCachedThreadPool(), callback).
RemoteRunMaster(Executor bossExecutor, Executor workerExecutor, AgentConnectionCallback callback) Creates a new RemoteRunMaster.

Method Summary

Methods

Modifier and Type	Method and Description
InetSocketAddress	bind(InetSocketAddress address) Bind and return the bound address.
void	channelConnected(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.ChannelStateEvent e)
void	channelDisconnected(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.ChannelStateEvent e)
static SSLEngine	createSslEngine()
void	exceptionCaught(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.ExceptionEvent e)
Set<IAgentConnection>	getAgentConnections()
AgentConnectionCallback	getCallback() Get the registered callback.
Collection<IAgentConnection>	getConnectedClients() Get a new copy of a collection containing all the actively connected clients.
static long	getNextRequestId()
void	messageReceived(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.MessageEvent message)
void	operationComplete(org.jboss.netty.channel.ChannelFuture future)
void	setCallback(AgentConnectionCallback callback)
void	shutdown()
String	toString()

Methods inherited from class org.jboss.netty.channel.SimpleChannelHandler

bindRequested, channelBound, channelClosed, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, closeRequested, connectRequested, disconnectRequested, handleDownstream, handleUpstream, setInterestOpsRequested, unbindRequested, writeComplete, writeRequested

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteRunMaster

public RemoteRunMaster()

The same as new RemoteRunMaster(Executors.newCachedThreadPool(), Executors.newCachedThreadPool(), null).

RemoteRunMaster

public RemoteRunMaster(AgentConnectionCallback callback)

The same as new RemoteRunMaster(Executors.newCachedThreadPool(), Executors.newCachedThreadPool(), callback).

RemoteRunMaster

public RemoteRunMaster(Executor bossExecutor,
               Executor workerExecutor,
               AgentConnectionCallback callback)

Creates a new RemoteRunMaster.

Parameters:

bossExecutor - the Executor which will execute the boss threads, see org.jboss.netty.channel.socket.nio.NioServerSocketChannelFactory(Executor, Executor)

workerExecutor - the Executor which will execute the I/O worker threads, see org.jboss.netty.channel.socket.nio.NioServerSocketChannelFactory(Executor, Executor)

callback - optional callback when agents connect/send messages

Method Detail

getNextRequestId

public static long getNextRequestId()

getCallback

public AgentConnectionCallback getCallback()

Get the registered callback. Can be null.

setCallback

public void setCallback(AgentConnectionCallback callback)

createSslEngine

public static SSLEngine createSslEngine()

bind

public InetSocketAddress bind(InetSocketAddress address)

Bind and return the bound address.

Parameters:

address - socket address to bind to

Returns:

where the socket was bound - useful to determine random port if a port of 0 was passed in

exceptionCaught

public void exceptionCaught(org.jboss.netty.channel.ChannelHandlerContext ctx,
                   org.jboss.netty.channel.ExceptionEvent e)
                     throws Exception

Overrides:

exceptionCaught in class org.jboss.netty.channel.SimpleChannelHandler

Throws:

Exception

messageReceived

public void messageReceived(org.jboss.netty.channel.ChannelHandlerContext ctx,
                   org.jboss.netty.channel.MessageEvent message)
                     throws Exception

Overrides:

messageReceived in class org.jboss.netty.channel.SimpleChannelHandler

Throws:

Exception

channelConnected

public void channelConnected(org.jboss.netty.channel.ChannelHandlerContext ctx,
                    org.jboss.netty.channel.ChannelStateEvent e)
                      throws Exception

Overrides:

channelConnected in class org.jboss.netty.channel.SimpleChannelHandler

Throws:

Exception

operationComplete

public void operationComplete(org.jboss.netty.channel.ChannelFuture future)
                       throws Exception

Specified by:

operationComplete in interface org.jboss.netty.channel.ChannelFutureListener

Throws:

Exception

channelDisconnected

public void channelDisconnected(org.jboss.netty.channel.ChannelHandlerContext ctx,
                       org.jboss.netty.channel.ChannelStateEvent e)
                         throws Exception

Overrides:

channelDisconnected in class org.jboss.netty.channel.SimpleChannelHandler

Throws:

Exception

getAgentConnections

public Set<IAgentConnection> getAgentConnections()

shutdown

public void shutdown()

getConnectedClients

public Collection<IAgentConnection> getConnectedClients()

Get a new copy of a collection containing all the actively connected clients.

Returns:

a fresh list, can be modified as you wish

toString

public String toString()

Overrides:

toString in class Object