Package org.jgroups.protocols
Class RATE
- java.lang.Object
-
- org.jgroups.stack.Protocol
-
- org.jgroups.protocols.RATE
-
-
Field Summary
Fields Modifier and Type Field Description protected long
current_receive_rate
protected long
current_send_rate
protected java.util.concurrent.Future<?>
f
protected long
highest_receive_rate
protected long
highest_send_rate
protected int
history_size
protected java.util.concurrent.atomic.LongAdder
in
protected long
interval
protected boolean
measure_serialized_size
protected java.util.concurrent.atomic.LongAdder
out
protected BoundedList<java.lang.Long>
recv_history
protected BoundedList<java.lang.Long>
send_history
protected java.lang.Runnable
task
protected TimeScheduler
timer
-
Fields inherited from class org.jgroups.stack.Protocol
after_creation_hook, down_prot, ergonomics, id, local_addr, log, policies, stack, stats, up_prot
-
-
Constructor Summary
Constructors Constructor Description RATE()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
currentReceiveRate()
java.lang.String
currentSendRate()
java.lang.Object
down(Message msg)
A message is sent down the stack.java.lang.String
highestReceiveRate()
java.lang.String
highestSendRate()
void
init()
Called after a protocol has been created and before the protocol is started.long
interval()
RATE
interval(long i)
boolean
measureSerializedSize()
RATE
measureSerializedSize(boolean b)
java.lang.String
printReceiveHistory()
java.lang.String
printSendHistory()
void
resetStats()
protected long
size(Message msg)
protected long
size(MessageBatch batch)
void
start()
This method is called on aJChannel.connect(String)
; starts work.void
stop()
Called on aJChannel.disconnect()
; stops work (e.g.java.lang.Object
up(Message msg)
A single message was received.void
up(MessageBatch batch)
Sends up a multiple messages in aMessageBatch
.-
Methods inherited from class org.jgroups.stack.Protocol
accept, addPolicy, addr, addr, afterCreationHook, destroy, down, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, policies, providedDownServices, providedUpServices, removePolicy, requiredDownServices, requiredUpServices, resetStatistics, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, statsEnabled, toString, up
-
-
-
-
Field Detail
-
measure_serialized_size
protected boolean measure_serialized_size
-
interval
protected long interval
-
history_size
protected int history_size
-
current_send_rate
protected volatile long current_send_rate
-
highest_send_rate
protected volatile long highest_send_rate
-
current_receive_rate
protected volatile long current_receive_rate
-
highest_receive_rate
protected volatile long highest_receive_rate
-
out
protected final java.util.concurrent.atomic.LongAdder out
-
in
protected final java.util.concurrent.atomic.LongAdder in
-
send_history
protected BoundedList<java.lang.Long> send_history
-
recv_history
protected BoundedList<java.lang.Long> recv_history
-
timer
protected TimeScheduler timer
-
f
protected java.util.concurrent.Future<?> f
-
task
protected final java.lang.Runnable task
-
-
Method Detail
-
measureSerializedSize
public boolean measureSerializedSize()
-
measureSerializedSize
public RATE measureSerializedSize(boolean b)
-
interval
public long interval()
-
interval
public RATE interval(long i)
-
currentSendRate
public java.lang.String currentSendRate()
-
highestSendRate
public java.lang.String highestSendRate()
-
currentReceiveRate
public java.lang.String currentReceiveRate()
-
highestReceiveRate
public java.lang.String highestReceiveRate()
-
init
public void init() throws java.lang.Exception
Description copied from class:Protocol
Called after a protocol has been created and before the protocol is started. Attributes are already set. Other protocols are not yet connected and events cannot yet be sent.
-
start
public void start() throws java.lang.Exception
Description copied from class:Protocol
This method is called on aJChannel.connect(String)
; starts work. Protocols are connected ready to receive events. Will be called from bottom to top.- Specified by:
start
in interfaceLifecycle
- Overrides:
start
in classProtocol
- Throws:
java.lang.Exception
- Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, soJChannel.connect(String)
will throw an exception
-
stop
public void stop()
Description copied from class:Protocol
Called on aJChannel.disconnect()
; stops work (e.g. by closing multicast socket). Will be called from top to bottom.
-
down
public java.lang.Object down(Message msg)
Description copied from class:Protocol
A message is sent down the stack. Protocols may examine the message and do something (e.g. add a header) with it, before passing it down.
-
up
public java.lang.Object up(Message msg)
Description copied from class:Protocol
A single message was received. Protocols may examine the message and do something (e.g. add a header) with it before passing it up.
-
up
public void up(MessageBatch batch)
Description copied from class:Protocol
Sends up a multiple messages in aMessageBatch
. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages. The default processing below sends messages up the stack individually, based on a matching criteria (callingProtocol.accept(Message)
), and - if true - callsProtocol.up(org.jgroups.Event)
for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped. Subclasses should check if there are any messages destined for them (e.g. usingMessageBatch.iterator(Predicate)
), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.
-
resetStats
public void resetStats()
- Overrides:
resetStats
in classProtocol
-
printSendHistory
public java.lang.String printSendHistory()
-
printReceiveHistory
public java.lang.String printReceiveHistory()
-
size
protected long size(Message msg)
-
size
protected long size(MessageBatch batch)
-
-