NakReceiverWindow

java.lang.Object
- org.jgroups.stack.NakReceiverWindow

Deprecated.
```
@Deprecated
public class NakReceiverWindow
extends java.lang.Object
```
Keeps track of messages according to their sequence numbers. Allows messages to be added out of order, and with gaps between sequence numbers. Method remove() removes the first message with a sequence number that is 1 higher than next_to_remove (this variable is then incremented), or it returns null if no message is present, or if no message's sequence number is 1 higher.
When there is a gap upon adding a message, its seqno will be added to the Retransmitter, which (using a timer) requests retransmissions of missing messages and keeps on trying until the message has been received, or the member who sent the message is suspected. There are 2 variables which keep track of messages:
- highest_delivered: the highest delivered seqno, updated on remove(). The next message to be removed is highest_delivered + 1
- highest_received: the highest received message, updated on add (if a new message is added, not updated e.g. if a missing msg was received)
Note that the first seqno expected is 1. This design is described in doc/design.NAKACK.txt
Example: 1,2,3,5,6,8: highest_delivered=2 (or 3, depending on whether remove() was called !), highest_received=8
Author:

Bela Ban

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface NakReceiverWindow.Listener
Deprecated.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`NakReceiverWindow.Listener` Deprecated.

Field Summary

Fields
Modifier and Type Field and Description

protected static Log log
Deprecated.

Fields
Modifier and Type	Field and Description
`protected static Log`	`log` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`NakReceiverWindow(Address sender, Retransmitter.RetransmitCommand cmd, long highest_delivered_seqno, TimeScheduler sched)` Deprecated. Creates a new instance with the given retransmit command
`NakReceiverWindow(Address sender, Retransmitter.RetransmitCommand cmd, long highest_delivered_seqno, TimeScheduler sched, boolean use_range_based_retransmitter)` Deprecated.
`NakReceiverWindow(Address sender, Retransmitter.RetransmitCommand cmd, long highest_delivered_seqno, TimeScheduler sched, boolean use_range_based_retransmitter, int num_rows, int msgs_per_row, double resize_factor, long max_compaction_time, boolean automatic_purging)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(long seqno, Message msg)` Deprecated. Adds a message according to its seqno (sequence number).
`void`	`compact()` Deprecated.
`void`	`destroy()` Deprecated. Destroys the NakReceiverWindow.
`Message`	`get(long seqno)` Deprecated. Returns the message from xmit_table
`java.util.List<Message>`	`get(long from, long to)` Deprecated. Returns a list of messages in the range [from ..
`long[]`	`getDigest()` Deprecated. Returns the lowest, highest delivered and highest received seqnos
`long`	`getHighestDelivered()` Deprecated. Returns the highest sequence number of a message consumed by the application (by `remove()`).
`long`	`getHighestReceived()` Deprecated. Returns the highest sequence number received so far (which may be higher than the highest seqno delivered so far; e.g., for 1,2,3,5,6 it would be 6.
`int`	`getMissingMessages()` Deprecated.
`int`	`getPendingXmits()` Deprecated.
`java.util.concurrent.atomic.AtomicBoolean`	`getProcessing()` Deprecated.
`int`	`getRetransmitTableCapacity()` Deprecated.
`double`	`getRetransmitTableFillFactor()` Deprecated.
`long`	`getRetransmitTableOffset()` Deprecated.
`int`	`getRetransmitTableSize()` Deprecated.
`java.lang.String`	`printLossRate()` Deprecated.
`protected java.lang.String`	`printMessages()` Deprecated. Prints xmit_table.
`java.lang.String`	`printRetransmitStats()` Deprecated.
`Message`	`remove()` Deprecated.
`Message`	`remove(boolean acquire_lock, boolean remove_msg)` Deprecated.
`java.util.List<Message>`	`removeMany(java.util.concurrent.atomic.AtomicBoolean processing)` Deprecated. Removes as many messages as possible
`java.util.List<Message>`	`removeMany(java.util.concurrent.atomic.AtomicBoolean processing, boolean remove_msgs, int max_results)` Deprecated. Removes as many messages as possible
`long`	`setHighestDelivered(long new_val)` Deprecated.
`void`	`setListener(NakReceiverWindow.Listener l)` Deprecated.
`void`	`setRetransmitTimeouts(Interval timeouts)` Deprecated.
`void`	`setXmitStaggerTimeout(long timeout)` Deprecated.
`int`	`size()` Deprecated.
`long`	`sizeOfAllMessages(boolean include_headers)` Deprecated. Returns the number of bytes taken up by all of the messages in the RetransmitTable
`void`	`stable(long seqno)` Deprecated. Delete all messages <= seqno (they are stable, that is, have been delivered by all members).
`java.lang.String`	`toString()` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - log
```
protected static final Log log
```
    Deprecated.
- Constructor Detail
  - NakReceiverWindow
```
public NakReceiverWindow(Address sender,
                         Retransmitter.RetransmitCommand cmd,
                         long highest_delivered_seqno,
                         TimeScheduler sched)
```
    Deprecated.
    
    Creates a new instance with the given retransmit command
    
    Parameters:
    
    sender - The sender associated with this instance
    
    cmd - The command used to retransmit a missing message, will be invoked by the table. If null, the retransmit thread will not be started
    
    highest_delivered_seqno - The next seqno to remove is highest_delivered_seqno +1
    
    sched - the external scheduler to use for retransmission requests of missing msgs. If it's not provided or is null, an internal
  - NakReceiverWindow
```
public NakReceiverWindow(Address sender,
                         Retransmitter.RetransmitCommand cmd,
                         long highest_delivered_seqno,
                         TimeScheduler sched,
                         boolean use_range_based_retransmitter)
```
    Deprecated.
  - NakReceiverWindow
```
public NakReceiverWindow(Address sender,
                         Retransmitter.RetransmitCommand cmd,
                         long highest_delivered_seqno,
                         TimeScheduler sched,
                         boolean use_range_based_retransmitter,
                         int num_rows,
                         int msgs_per_row,
                         double resize_factor,
                         long max_compaction_time,
                         boolean automatic_purging)
```
    Deprecated.
- Method Detail
  - getProcessing
```
public java.util.concurrent.atomic.AtomicBoolean getProcessing()
```
    Deprecated.
  - setRetransmitTimeouts
```
public void setRetransmitTimeouts(Interval timeouts)
```
    Deprecated.
  - setXmitStaggerTimeout
```
public void setXmitStaggerTimeout(long timeout)
```
    Deprecated.
  - setListener
```
public void setListener(NakReceiverWindow.Listener l)
```
    Deprecated.
  - getPendingXmits
```
public int getPendingXmits()
```
    Deprecated.
  - getRetransmitTableSize
```
public int getRetransmitTableSize()
```
    Deprecated.
  - getRetransmitTableCapacity
```
public int getRetransmitTableCapacity()
```
    Deprecated.
  - getRetransmitTableFillFactor
```
public double getRetransmitTableFillFactor()
```
    Deprecated.
  - getRetransmitTableOffset
```
public long getRetransmitTableOffset()
```
    Deprecated.
  - compact
```
public void compact()
```
    Deprecated.
  - add
```
public boolean add(long seqno,
                   Message msg)
```
    Deprecated.
    Adds a message according to its seqno (sequence number).
    There are 4 cases where messages are added:
    1. seqno is the next to be expected seqno: added to map
    2. seqno is <= highest_delivered: discard as we've already delivered it
    3. seqno is smaller than the next expected seqno: missing message, add it
    4. seqno is greater than the next expected seqno: add it to map and fill the gaps with null messages for retransmission. Add the seqno to the retransmitter too
    Returns:
    
    True if the message was added successfully, false otherwise (e.g. duplicate message)
  - remove
```
public Message remove()
```
    Deprecated.
  - remove
```
public Message remove(boolean acquire_lock,
                      boolean remove_msg)
```
    Deprecated.
  - removeMany
```
public java.util.List<Message> removeMany(java.util.concurrent.atomic.AtomicBoolean processing)
```
    Deprecated.
    
    Removes as many messages as possible
    
    Returns:
    
    List A list of messages, or null if no available messages were found
  - removeMany
```
public java.util.List<Message> removeMany(java.util.concurrent.atomic.AtomicBoolean processing,
                                          boolean remove_msgs,
                                          int max_results)
```
    Deprecated.
    
    Removes as many messages as possible
    
    Parameters:
    
    remove_msgs - Removes messages from xmit_table
    
    max_results - Max number of messages to remove in one batch
    
    Returns:
    
    List A list of messages, or null if no available messages were found
  - stable
```
public void stable(long seqno)
```
    Deprecated.
    
    Delete all messages <= seqno (they are stable, that is, have been delivered by all members). Stop when a number > seqno is encountered (all messages are ordered on seqnos).
  - destroy
```
public void destroy()
```
    Deprecated.
    
    Destroys the NakReceiverWindow. After this method returns, no new messages can be added and a new NakReceiverWindow should be used instead. Note that messages can still be removed though.
  - getDigest
```
public long[] getDigest()
```
    Deprecated.
    
    Returns the lowest, highest delivered and highest received seqnos
  - getHighestDelivered
```
public long getHighestDelivered()
```
    Deprecated.
    
    Returns the highest sequence number of a message consumed by the application (by remove()). Note that this is different from the highest deliverable seqno. E.g. in 23,24,26,27,29, the highest delivered message may be 22, whereas the highest deliverable message may be 24 !
    
    Returns:
    
    the highest sequence number of a message consumed by the application (by remove())
  - setHighestDelivered
```
public long setHighestDelivered(long new_val)
```
    Deprecated.
  - getHighestReceived
```
public long getHighestReceived()
```
    Deprecated.
    
    Returns the highest sequence number received so far (which may be higher than the highest seqno delivered so far; e.g., for 1,2,3,5,6 it would be 6.
    
    See Also:
    
    getHighestDelivered()
  - get
```
public Message get(long seqno)
```
    Deprecated.
    
    Returns the message from xmit_table
    
    Parameters:
    
    seqno -
    
    Returns:
    
    Message from xmit_table
  - get
```
public java.util.List<Message> get(long from,
                                   long to)
```
    Deprecated.
    
    Returns a list of messages in the range [from .. to], including from and to
    
    Parameters:
    
    from -
    
    to -
    
    Returns:
    
    A list of messages, or null if none in range [from .. to] was found
  - size
```
public int size()
```
    Deprecated.
  - sizeOfAllMessages
```
public long sizeOfAllMessages(boolean include_headers)
```
    Deprecated.
    
    Returns the number of bytes taken up by all of the messages in the RetransmitTable
    
    Parameters:
    
    include_headers -
    
    Returns:
  - getMissingMessages
```
public int getMissingMessages()
```
    Deprecated.
  - toString
```
public java.lang.String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class java.lang.Object
  - printMessages
```
protected java.lang.String printMessages()
```
    Deprecated.
    
    Prints xmit_table. Requires read lock to be present
    
    Returns:
    
    String
  - printLossRate
```
public java.lang.String printLossRate()
```
    Deprecated.
  - printRetransmitStats
```
public java.lang.String printRetransmitStats()
```
    Deprecated.

Class NakReceiverWindow

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

Constructor Detail

NakReceiverWindow

NakReceiverWindow

NakReceiverWindow

Method Detail

getProcessing

setRetransmitTimeouts

setXmitStaggerTimeout

setListener

getPendingXmits

getRetransmitTableSize

getRetransmitTableCapacity

getRetransmitTableFillFactor

getRetransmitTableOffset

compact

add

remove

remove

removeMany

removeMany

stable

destroy

getDigest

getHighestDelivered

setHighestDelivered

getHighestReceived

get

get

size

sizeOfAllMessages

getMissingMessages

toString

printMessages

printLossRate

printRetransmitStats