Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.jgroups.protocols
Class UNICAST  view UNICAST download UNICAST.java

java.lang.Object
  extended byorg.jgroups.stack.Protocol
      extended byorg.jgroups.protocols.UNICAST
All Implemented Interfaces:
org.jgroups.stack.AckSenderWindow.RetransmitCommand

public class UNICAST
extends org.jgroups.stack.Protocol
implements org.jgroups.stack.AckSenderWindow.RetransmitCommand

Reliable unicast layer. Uses acknowledgement scheme similar to TCP to provide lossless transmission of unicast messages (for reliable multicast see NAKACK layer). When a message is sent to a peer for the first time, we add the pair to the hashtable (peer address is the key). All messages sent to that peer will be added to hashtable.peer_addr.sent_msgs. When we receive a message from a peer for the first time, another entry will be created and added to the hashtable (unless already existing). Msgs will then be added to hashtable.peer_addr.received_msgs.

This layer is used to reliably transmit point-to-point messages, that is, either messages sent to a single receiver (vs. messages multicast to a group) or for example replies to a multicast message. The sender uses an AckSenderWindow which retransmits messages for which it hasn't received an ACK, the receiver uses AckReceiverWindow which keeps track of the lowest seqno received so far, and keeps messages in order.

Messages in both AckSenderWindows and AckReceiverWindows will be removed. A message will be removed from AckSenderWindow when an ACK has been received for it and messages will be removed from AckReceiverWindow whenever a message is received: the new message is added and then we try to remove as many messages as possible (until we stop at a gap, or there are no more messages).


Nested Class Summary
private static class UNICAST.Entry
           
static class UNICAST.UnicastHeader
           
 
Field Summary
private  java.util.HashMap connections
           
private static long DEFAULT_FIRST_SEQNO
           
private  org.jgroups.Address local_addr
           
private  java.util.Vector members
           
private static java.lang.String name
           
private  long num_acks_received
           
private  long num_acks_sent
           
private  long num_bytes_received
           
private  long num_bytes_sent
           
private  long num_msgs_received
           
private  long num_msgs_sent
           
private  long num_xmit_requests_received
           
private  org.jgroups.util.BoundedList previous_members
          A list of members who left, used to determine when to prevent sending messages to left mbrs
private  long[] timeout
           
private  org.jgroups.util.TimeScheduler timer
           
private  boolean use_gms
           
 
Fields inherited from class org.jgroups.stack.Protocol
down_handler, down_prot, down_queue, down_thread, down_thread_prio, log, observer, props, stack, stats, trace, up_handler, up_prot, up_queue, up_thread, up_thread_prio, warn
 
Constructor Summary
UNICAST()
           
 
Method Summary
 void down(org.jgroups.Event evt)
          An event is to be sent down the stack.
 java.util.Map dumpStats()
           
 java.lang.String getLocalAddress()
           
 java.lang.String getMembers()
           
 java.lang.String getName()
          All protocol names have to be unique !
 long getNumAcksReceived()
           
 long getNumAcksSent()
           
 long getNumberOfRetransmitRequestsReceived()
           
 int getNumberOfUnackedMessages()
          The number of messages in all Entry.sent_msgs tables (haven't received an ACK yet)
 long getNumBytesReceived()
           
 long getNumBytesSent()
           
 long getNumMessagesReceived()
           
 long getNumMessagesSent()
           
private  void handleAckReceived(java.lang.Object sender, long seqno)
          Add the ACK to hashtable.sender.sent_msgs
private  void handleDataReceived(java.lang.Object sender, long seqno, org.jgroups.Message msg)
          Check whether the hashtable contains an entry e for sender (create if not).
 java.lang.String printConnections()
           
private  void removeAllConnections()
           
private  boolean removeConnection(java.lang.Object mbr)
          Removes and resets from connection table (which is already locked).
 void resetStats()
           
 void retransmit(long seqno, org.jgroups.Message msg)
          Called by AckSenderWindow to resend messages for which no ACK has been received yet
private  void sendAck(org.jgroups.Address dst, long seqno)
           
 boolean setProperties(java.util.Properties props)
          Configures the protocol initially.
 void start()
          This method is called on a Channel.connect(String)>Channel.connect(String) 55 .
 void stop()
          This method is called on a Channel.disconnect()>Channel.disconnect() 55 .
 void up(org.jgroups.Event evt)
          An event was received from the layer below.
 
Methods inherited from class org.jgroups.stack.Protocol
destroy, downThreadEnabled, enableStats, getDownProtocol, getDownQueue, getProperties, getUpProtocol, getUpQueue, handleSpecialDownEvent, init, isTrace, isWarn, passDown, passUp, printStats, providedDownServices, providedUpServices, receiveDownEvent, receiveUpEvent, requiredDownServices, requiredUpServices, setDownProtocol, setObserver, setPropertiesInternal, setProtocolStack, setTrace, setUpProtocol, setWarn, startDownHandler, startUpHandler, statsEnabled, stopInternal, upThreadEnabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

members

private final java.util.Vector members

connections

private final java.util.HashMap connections

timeout

private long[] timeout

local_addr

private org.jgroups.Address local_addr

timer

private org.jgroups.util.TimeScheduler timer

use_gms

private boolean use_gms

previous_members

private final org.jgroups.util.BoundedList previous_members
A list of members who left, used to determine when to prevent sending messages to left mbrs


name

private static final java.lang.String name
See Also:
Constant Field Values

DEFAULT_FIRST_SEQNO

private static final long DEFAULT_FIRST_SEQNO
See Also:
Constant Field Values

num_msgs_sent

private long num_msgs_sent

num_msgs_received

private long num_msgs_received

num_bytes_sent

private long num_bytes_sent

num_bytes_received

private long num_bytes_received

num_acks_sent

private long num_acks_sent

num_acks_received

private long num_acks_received

num_xmit_requests_received

private long num_xmit_requests_received
Constructor Detail

UNICAST

public UNICAST()
Method Detail

getName

public java.lang.String getName()
All protocol names have to be unique !


getLocalAddress

public java.lang.String getLocalAddress()

getMembers

public java.lang.String getMembers()

printConnections

public java.lang.String printConnections()

getNumMessagesSent

public long getNumMessagesSent()

getNumMessagesReceived

public long getNumMessagesReceived()

getNumBytesSent

public long getNumBytesSent()

getNumBytesReceived

public long getNumBytesReceived()

getNumAcksSent

public long getNumAcksSent()

getNumAcksReceived

public long getNumAcksReceived()

getNumberOfRetransmitRequestsReceived

public long getNumberOfRetransmitRequestsReceived()

getNumberOfUnackedMessages

public int getNumberOfUnackedMessages()
The number of messages in all Entry.sent_msgs tables (haven't received an ACK yet)


resetStats

public void resetStats()

dumpStats

public java.util.Map dumpStats()

setProperties

public boolean setProperties(java.util.Properties props)
Description copied from class: org.jgroups.stack.Protocol
Configures the protocol initially. A configuration string consists of name=value items, separated by a ';' (semicolon), e.g.:
 "loopback=false;unicast_inport=4444"
 


start

public void start()
           throws java.lang.Exception
Description copied from class: org.jgroups.stack.Protocol
This method is called on a Channel.connect(String)>Channel.connect(String) 55 . Starts work. Protocols are connected and queues are ready to receive events. Will be called from bottom to top. This call will replace the START and START_OK events.


stop

public void stop()
Description copied from class: org.jgroups.stack.Protocol
This method is called on a Channel.disconnect()>Channel.disconnect() 55 . Stops work (e.g. by closing multicast socket). Will be called from top to bottom. This means that at the time of the method invocation the neighbor protocol below is still working. This method will replace the STOP, STOP_OK, CLEANUP and CLEANUP_OK events. The ProtocolStack guarantees that when this method is called all messages in the down queue will have been flushed


up

public void up(org.jgroups.Event evt)
Description copied from class: org.jgroups.stack.Protocol
An event was received from the layer below. Usually the current layer will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using passDown() or c) the event (or another event) is sent up the stack using passUp().


down

public void down(org.jgroups.Event evt)
Description copied from class: org.jgroups.stack.Protocol
An event is to be sent down the stack. The layer may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the layer may need to add a header to it (or do nothing at all) before sending it down the stack using passDown(). In case of a GET_ADDRESS event (which tries to retrieve the stack's address from one of the bottom layers), the layer may need to send a new response event back up the stack using passUp().


removeConnection

private boolean removeConnection(java.lang.Object mbr)
Removes and resets from connection table (which is already locked). Returns true if member was found, otherwise false


removeAllConnections

private void removeAllConnections()

retransmit

public void retransmit(long seqno,
                       org.jgroups.Message msg)
Called by AckSenderWindow to resend messages for which no ACK has been received yet

Specified by:
retransmit in interface org.jgroups.stack.AckSenderWindow.RetransmitCommand

handleDataReceived

private void handleDataReceived(java.lang.Object sender,
                                long seqno,
                                org.jgroups.Message msg)
Check whether the hashtable contains an entry e for sender (create if not). If e.received_msgs is null and first is true: create a new AckReceiverWindow(seqno) and add message. Set e.received_msgs to the new window. Else just add the message.


handleAckReceived

private void handleAckReceived(java.lang.Object sender,
                               long seqno)
Add the ACK to hashtable.sender.sent_msgs


sendAck

private void sendAck(org.jgroups.Address dst,
                     long seqno)