org.openjdk.jmc.flightrecorder.rules.jdk.io

Class SocketReadRule

java.lang.Object

org.openjdk.jmc.flightrecorder.rules.jdk.io.SocketReadRule

All Implemented Interfaces:

IRule

public class SocketReadRule
extends Object
implements IRule

Field Summary

Fields

Modifier and Type	Field and Description
static TypedPreference<IQuantity>	READ_INFO_LIMIT
static TypedPreference<IQuantity>	READ_WARNING_LIMIT

Constructor Summary

Constructors

Constructor and Description
SocketReadRule()

Method Summary

Modifier and Type	Method and Description
RunnableFuture<Result>	evaluate(IItemCollection items, IPreferenceValueProvider vp) Gets a future representing the result of the evaluation of this rule.
Collection<TypedPreference<?>>	getConfigurationAttributes() Gets information about which attributes may be configured during rule evaluation.
String	getId()
String	getName()
String	getTopic()
protected static String	sanitizeAddress(String address)

Methods inherited from class java.lang.Object

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

Field Detail

READ_INFO_LIMIT

public static final TypedPreference<IQuantity> READ_INFO_LIMIT

READ_WARNING_LIMIT

public static final TypedPreference<IQuantity> READ_WARNING_LIMIT

Constructor Detail

SocketReadRule

public SocketReadRule()

Method Detail

evaluate

public RunnableFuture<Result> evaluate(IItemCollection items,
                                       IPreferenceValueProvider vp)

Description copied from interface: IRule

Gets a future representing the result of the evaluation of this rule. Running the RunnableFuture is the responsibility of the caller of this method, not the implementation.

Specified by:

evaluate in interface IRule

Parameters:

items - items to evaluate

vp - Provider of configuration values used for evaluation. The attributes that will be asked for from the provider should be provided by IRule.getConfigurationAttributes().

Returns:

a RunnableFuture that when run will return the evaluation result

getConfigurationAttributes

public Collection<TypedPreference<?>> getConfigurationAttributes()

Description copied from interface: IRule

Gets information about which attributes may be configured during rule evaluation.

Specified by:

getConfigurationAttributes in interface IRule

Returns:

a list of configuration attributes

getId

public String getId()

Specified by:

getId in interface IRule

Returns:

a unique id for this rule implementation

getName

public String getName()

Specified by:

getName in interface IRule

Returns:

a human readable name for this rule

sanitizeAddress

protected static String sanitizeAddress(String address)

getTopic

public String getTopic()

Specified by:

getTopic in interface IRule

Returns:

the topic for this rule, may be null