Package org.jgroups.protocols

Class TIME

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.TIME

All Implemented Interfaces:

Lifecycle

public class TIME
extends Protocol

Protocol measuring delivery times. Can be used in the up or down direction JIRA: https://issues.redhat.com/browse/JGRP-2101

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	down
protected AverageMinMax	down_delivery
protected boolean	up
protected AverageMinMax	up_delivery

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, local_addr, log, stack, stats, up_prot

Constructor Summary

Constructors

Constructor	Description
TIME()

Method Summary

Modifier and Type	Method	Description
java.lang.Object	down(Message msg)	A message is sent down the stack.
double	getAvgDownDeliveryTime()
double	getAvgUpDeliveryTime()
void	resetStats()
java.lang.Object	up(Message msg)	A single message was received.
void	up(MessageBatch batch)	Sends up a multiple messages in a MessageBatch.

Methods inherited from class org.jgroups.stack.Protocol

accept, addr, addr, afterCreationHook, destroy, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, init, isErgonomics, level, parse, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, start, statsEnabled, stop, up

Methods inherited from class java.lang.Object

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

Field Detail

up_delivery

protected final AverageMinMax up_delivery

down_delivery

protected final AverageMinMax down_delivery

up

protected boolean up

down

protected boolean down

Constructor Detail

TIME

public TIME()

Method Detail

getAvgDownDeliveryTime

public double getAvgDownDeliveryTime()

getAvgUpDeliveryTime

public double getAvgUpDeliveryTime()

resetStats

public void resetStats()

Overrides:

resetStats in class Protocol

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.

Overrides:

down in class Protocol

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.

Overrides:

up in class Protocol

up

public void up(MessageBatch batch)

Description copied from class: Protocol

Sends up a multiple messages in a MessageBatch. 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 (calling Protocol.accept(Message)), and - if true - calls Protocol.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. using MessageBatch#getMatchingMessages(short,boolean)), 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.

Overrides:

up in class Protocol

Parameters:

batch - The message batch