com.twitter.heron.common.network

Class HeronServer

java.lang.Object

com.twitter.heron.common.network.HeronServer

All Implemented Interfaces:

ISelectHandler

Direct Known Subclasses:

MetricsCacheManagerServer, MetricsManagerServer

public abstract class HeronServer
extends java.lang.Object
implements ISelectHandler

Any Heron Server should implement this abstract class. In particular it should implement a) onConnect method called when a new client connects to us b) onClose method called when a existing client closes c) onRequest method called when we have a new request d) onMessage method called when we have a new message

Constructor Summary

Constructors

Constructor and Description
HeronServer(NIOLooper s, java.lang.String host, int port, HeronSocketOptions options) Constructor

Method Summary

Modifier and Type	Method and Description
protected java.nio.channels.ServerSocketChannel	getAcceptChannel()
protected java.util.Map<java.nio.channels.SocketChannel,SocketChannelHelper>	getActiveConnections()
protected java.util.Map<java.lang.String,com.google.protobuf.Message.Builder>	getMessageMap()
NIOLooper	getNIOLooper()
protected java.util.Map<java.lang.String,com.google.protobuf.Message.Builder>	getRequestMap()
void	handleAccept(java.nio.channels.SelectableChannel channel) Handle a SelectableChannel when it is acceptable
void	handleConnect(java.nio.channels.SelectableChannel channel) Handle a SelectableChannel when it is connectible
void	handleError(java.nio.channels.SelectableChannel channel) Handle a SelectableChannel when it meets some errors
void	handleRead(java.nio.channels.SelectableChannel channel) Handle a SelectableChannel when it is readable
void	handleWrite(java.nio.channels.SelectableChannel channel) Handle a SelectableChannel when it is writable
abstract void	onClose(java.nio.channels.SocketChannel channel)
abstract void	onConnect(java.nio.channels.SocketChannel channel)
abstract void	onMessage(java.nio.channels.SocketChannel channel, com.google.protobuf.Message message)
abstract void	onRequest(REQID rid, java.nio.channels.SocketChannel channel, com.google.protobuf.Message request)
void	registerOnMessage(com.google.protobuf.Message.Builder builder)
void	registerOnRequest(com.google.protobuf.Message.Builder builder)
void	registerTimerEventInNanoSeconds(long timerInNanoSecnods, java.lang.Runnable task)
void	registerTimerEventInSeconds(long timerInSeconds, java.lang.Runnable task)
boolean	sendMessage(java.nio.channels.SocketChannel channel, com.google.protobuf.Message message)
boolean	sendResponse(REQID rid, java.nio.channels.SocketChannel channel, com.google.protobuf.Message response)
boolean	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

HeronServer

public HeronServer(NIOLooper s,
                   java.lang.String host,
                   int port,
                   HeronSocketOptions options)

Constructor

Parameters:

s - the NIOLooper bind with this socket server

host - the host of remote endpoint to communicate with

port - the port of remote endpoint to communicate with

Method Detail

registerOnMessage

public void registerOnMessage(com.google.protobuf.Message.Builder builder)

registerOnRequest

public void registerOnRequest(com.google.protobuf.Message.Builder builder)

start

public boolean start()

stop

public void stop()

handleAccept

public void handleAccept(java.nio.channels.SelectableChannel channel)

Description copied from interface: ISelectHandler

Handle a SelectableChannel when it is acceptable

Specified by:

handleAccept in interface ISelectHandler

Parameters:

channel - the channel ISelectHandler with handle with

handleRead

public void handleRead(java.nio.channels.SelectableChannel channel)

Description copied from interface: ISelectHandler

Handle a SelectableChannel when it is readable

Specified by:

handleRead in interface ISelectHandler

Parameters:

channel - the channel ISelectHandler with handle with

handleWrite

public void handleWrite(java.nio.channels.SelectableChannel channel)

Description copied from interface: ISelectHandler

Handle a SelectableChannel when it is writable

Specified by:

handleWrite in interface ISelectHandler

Parameters:

channel - the channel ISelectHandler with handle with

handleConnect

public void handleConnect(java.nio.channels.SelectableChannel channel)

Description copied from interface: ISelectHandler

Handle a SelectableChannel when it is connectible

Specified by:

handleConnect in interface ISelectHandler

Parameters:

channel - the channel ISelectHandler with handle with

handleError

public void handleError(java.nio.channels.SelectableChannel channel)

Description copied from interface: ISelectHandler

Handle a SelectableChannel when it meets some errors

Specified by:

handleError in interface ISelectHandler

Parameters:

channel - the channel ISelectHandler with handle with

sendResponse

public boolean sendResponse(REQID rid,
                            java.nio.channels.SocketChannel channel,
                            com.google.protobuf.Message response)

sendMessage

public boolean sendMessage(java.nio.channels.SocketChannel channel,
                           com.google.protobuf.Message message)

getNIOLooper

public NIOLooper getNIOLooper()

registerTimerEventInSeconds

public void registerTimerEventInSeconds(long timerInSeconds,
                                        java.lang.Runnable task)

registerTimerEventInNanoSeconds

public void registerTimerEventInNanoSeconds(long timerInNanoSecnods,
                                            java.lang.Runnable task)

onConnect

public abstract void onConnect(java.nio.channels.SocketChannel channel)

onRequest

public abstract void onRequest(REQID rid,
                               java.nio.channels.SocketChannel channel,
                               com.google.protobuf.Message request)

onMessage

public abstract void onMessage(java.nio.channels.SocketChannel channel,
                               com.google.protobuf.Message message)

onClose

public abstract void onClose(java.nio.channels.SocketChannel channel)

getMessageMap

protected java.util.Map<java.lang.String,com.google.protobuf.Message.Builder> getMessageMap()

getRequestMap

protected java.util.Map<java.lang.String,com.google.protobuf.Message.Builder> getRequestMap()

getAcceptChannel

protected java.nio.channels.ServerSocketChannel getAcceptChannel()

getActiveConnections

protected java.util.Map<java.nio.channels.SocketChannel,SocketChannelHelper> getActiveConnections()