com.madara.filters

Class CounterFilter

java.lang.Object

com.madara.MadaraJNI

com.madara.filters.CounterFilter

public class CounterFilter
extends MadaraJNI

A facade for the C++ Counter_Filter aggregate filter

Constructor Summary

Constructors

Constructor and Description
CounterFilter() Default constructor

Method Summary

Modifier and Type	Method and Description
void	addRebroadcastFilterTo(QoSTransportSettings settings) Adds the filter as a receive filter to transport settings
void	addReceiveFilterTo(QoSTransportSettings settings) Adds the filter as a receive filter to transport settings
void	addSendFilterTo(QoSTransportSettings settings) Adds the filter as a receive filter to transport settings
protected void	finalize() Cleans up underlying C resources
void	free() Deletes the C instantiation.
long	getCount() Returns the number of packets filtered
long	getElapsed() Returns the number of packets filtered
double	getThroughput() Converts the value to a double

Methods inherited from class com.madara.MadaraJNI

getCPtr, setCPtr, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CounterFilter

public CounterFilter()

Default constructor

Method Detail

getThroughput

public double getThroughput()

Converts the value to a double

Returns:

current double value

getCount

public long getCount()

Returns the number of packets filtered

Returns:

the number of packets filtered

getElapsed

public long getElapsed()

Returns the number of packets filtered

Returns:

the number of packets filtered

addReceiveFilterTo

public void addReceiveFilterTo(QoSTransportSettings settings)

Adds the filter as a receive filter to transport settings

Parameters:

settings - the QoS Transport settings to add the filter to

addSendFilterTo

public void addSendFilterTo(QoSTransportSettings settings)

Adds the filter as a receive filter to transport settings

Parameters:

settings - the QoS Transport settings to add the filter to

addRebroadcastFilterTo

public void addRebroadcastFilterTo(QoSTransportSettings settings)

Adds the filter as a receive filter to transport settings

Parameters:

settings - the QoS Transport settings to add the filter to

free

public void free()

Deletes the C instantiation. To prevent memory leaks, this must be called before an instance gets garbage collected

finalize

protected void finalize()
                 throws java.lang.Throwable

Cleans up underlying C resources

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - necessary for override but unused