org.apache.giraph.comm.netty

Class OutboundByteCounter

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

org.apache.giraph.comm.netty.OutboundByteCounter

All Implemented Interfaces:

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

@ChannelHandler.Sharable
public class OutboundByteCounter
extends io.netty.channel.ChannelOutboundHandlerAdapter
implements ByteCounter, ResetSuperstepMetricsObserver

Keep track of the bytes sent 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
OutboundByteCounter() Constructor

Method Summary

Modifier and Type	Method and Description
long	getBytesSent()
double	getMbytesPerSecSent()
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	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise)

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, 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

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

OutboundByteCounter

public OutboundByteCounter()

Constructor

Method Detail

getBytesSent

public long getBytesSent()

getMbytesPerSecSent

public double getMbytesPerSecSent()

Returns:

Mbytes sent / sec in the current interval

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
                  Object msg,
                  io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Overrides:

write in class io.netty.channel.ChannelOutboundHandlerAdapter

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