org.apache.giraph.comm.netty

Class InboundByteCounter

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

org.apache.giraph.comm.netty.InboundByteCounter

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, ByteCounter, ResetSuperstepMetricsObserver

@ChannelHandler.Sharable
public class InboundByteCounter
extends io.netty.channel.ChannelInboundHandlerAdapter
implements ByteCounter, ResetSuperstepMetricsObserver

Keep track of the bytes received and provide some metrics when desired as part of the Netty Channel stack.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
InboundByteCounter() Constructor

Method Summary

Modifier and Type	Method and Description
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)
long	getBytesReceived()
long	getBytesReceivedPerSuperstep() Returns bytes received per superstep.
double	getMbytesPerSecReceived()
String	getMetrics()
String	getMetricsWindow(int minMsecsWindow) Get the metrics if a given window of time has passed.
void	newSuperstep(SuperstepMetricsRegistry superstepMetrics) Starting a new superstep.
void	resetAll() Reset everything this object keeps track of
void	resetBytesReceivedPerSuperstep() Set bytes received per superstep to 0.

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

InboundByteCounter

public InboundByteCounter()

Constructor

Method Detail

getBytesReceived

public long getBytesReceived()

getBytesReceivedPerSuperstep

public long getBytesReceivedPerSuperstep()

Returns bytes received per superstep.

Returns:

Number of bytes.

resetBytesReceivedPerSuperstep

public void resetBytesReceivedPerSuperstep()

Set bytes received per superstep to 0.

getMbytesPerSecReceived

public double getMbytesPerSecReceived()

Returns:

Mbytes received / sec in the current interval

channelRead

public void channelRead(io.netty.channel.ChannelHandlerContext ctx,
                        Object msg)
                 throws Exception

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

newSuperstep

public void newSuperstep(SuperstepMetricsRegistry superstepMetrics)

Description copied from interface: ResetSuperstepMetricsObserver

Starting a new superstep. Re-initialize your metrics.

Specified by:

newSuperstep in interface ResetSuperstepMetricsObserver

Parameters:

superstepMetrics - SuperstepMetricsRegistry being used.

resetAll

public void resetAll()

Description copied from interface: ByteCounter

Reset everything this object keeps track of

Specified by:

resetAll in interface ByteCounter

getMetrics

public String getMetrics()

Specified by:

getMetrics in interface ByteCounter

Returns:

A string containing all the metrics

getMetricsWindow

public String getMetricsWindow(int minMsecsWindow)

Description copied from interface: ByteCounter

Get the metrics if a given window of time has passed. Return null otherwise. If the window is met, reset the metrics.

Specified by:

getMetricsWindow in interface ByteCounter

Parameters:

minMsecsWindow - Msecs of the minimum window

Returns:

Metrics or else null if the window wasn't met