org.rhq.core.communications.command.annotation

Annotation Type DisableSendThrottling

@Documented
@Retention(value=RUNTIME)
@Target(value={METHOD,TYPE})
public @interface DisableSendThrottling

This annotation denotes that a remote method invocation (or all method invocations, if annotating a type) will ignore send throttling (that is, the invocation will occur as soon as possible - it will not have to pass through the send throttle first).

This annotation must be used within an interface, as opposed to a class definition, in order for it to take effect. In other words, when you write your remote POJO, this annotation must be used in the remote POJO's interface - not its implementation class.

If this annotation's value is false, it means the method(s) are to be send-throttled - of course, the communications layer must have its send throttle enabled and the send throttling parameters set appropriately, otherwise, send throttling will be explicitly disabled across all remote POJO invocations regardless of this annotation's value.

Author:

John Mazzitelli

See Also:

org.rhq.enterprise.communications.command.client.ClientCommandSender#enableSendThrottling(long, long), org.rhq.enterprise.communications.command.client.ClientCommandSender#disableSendThrottling()

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	value When true, the method (or methods if annotating an interface) will be not be sent with send throttling enabled, in effect disabling the send throttle.

Element Detail

value

public abstract boolean value

When true, the method (or methods if annotating an interface) will be not be sent with send throttling enabled, in effect disabling the send throttle. If false, the invocations will occur with send throttling enabled.

Returns:

send throttling flag (default is true)

Default:

true