com.sun.multicast.reliable.transport.tram
Class TRAMStats

java.lang.Object
  |
  +--com.sun.multicast.reliable.transport.tram.TRAMStats
All Implemented Interfaces:
java.lang.Cloneable, RMStatistics

public class TRAMStats
extends java.lang.Object
implements RMStatistics, java.lang.Cloneable

TRAMStats defines the TRAM Statistics block. Applications can get a copy of this block via the getRMStatistics method support by RMxxxSocket class.


Constructor Summary
TRAMStats(com.sun.multicast.reliable.transport.tram.TRAMControlBlock tramblk)
          Constructor.
 
Method Summary
 void addBytesRcvd(long count)
          Adds a specified count of bytes to the bytes received counter.
 void addBytesReSent(long count)
          Method to augment the number of bytes resent.
 void addBytesSent(long count)
          Method to augment the number of bytes sent.
protected  void addDuplicateBytes(long count)
          Adds a specified number of bytes to the duplicate bytes received counter.
protected  void addDuplicatePackets()
          Increments the duplicate packets received counter.
protected  void addDuplicatePackets(long count)
          Adds a specified number of packets to the duplicate packets received counter.
protected  void addLostMembers()
          Adds one to the lost member count.
protected  void addLostMembers(int count)
          Adds a specified count of members to the lost member count.
protected  void addPacketsNotDelivered(long count)
          Adds a specified number of packets to the number of packets that were received but not delivered to the application.
protected  void addPacketsNotRecovered(long count)
          Adds a specified number of packets to the number of packets that were not recovered because they were before the most current forgetBefore value
protected  void addPacketsRcvd()
          Adds a packet to the total packets received counter.
protected  void addPacketsRcvd(long count)
          Adds the specified number of packets to the number of received packet counter.
 void addPacketsSent()
          Increments the number of data packets sent counter.
 void addPacketsSent(long count)
          Adds a specified number of packets to the number of packet sent counter.
protected  void addPrunedMembers()
          Adds one to the pruned member count.
protected  void addPrunedMembers(int count)
          Adds a specified count of members to the pruned member count.
 void addReceiver(java.net.InetAddress address)
          Adds a receiver to the Receivers list.
protected  void addRetransBytesRcvd(int count)
          Adds a specified count of bytes to the retransmitted bytes received counter.
 void addSender(java.net.InetAddress address)
          Adds a sender to the Senders list.
protected  java.lang.Object clone()
          Creates a copy of the TRAM Statistics blocks and returns a reference to it.
 long getDataStartTime()
          Gets the time at which the first data packet was received.
 int getDirectMemberCount()
          Return the number of direct members.
 long getDuplicateBytes()
          Gets the number of bytes of redundant data received.
 long getDuplicatePackets()
          Gets the number of duplicate(redundant) packets received.
 int getIndirectMemberCount()
          Return the number of indirect members.
 int getLostMembers()
          Returns the number of members that were disowned as a result of inactiveness.
 long getMcastBeaconRcvd()
          Get the number of multicast beacons received.
 long getMcastBeaconSent()
          Get the number of multicast beacons sent.
 long getMcastControlBytesRcvd()
          Get the number of multicast control bytes received.
 long getMcastControlBytesSent()
          Get the number of multicast control bytes sent.
 long getMcastHARcvd()
          Get the number of multicast HA messages received.
 long getMcastHASent()
          Get the number of multicast HA messages sent.
 long getMcastHelloRcvd()
          Get the number of multicast hellos received.
 long getMcastHelloSent()
          Get the number of multicast hellos sent.
 long getMcastMSRcvd()
          Get the number of multicast MS messages received.
 long getMcastMSSent()
          Get the number of multicast MS messages sent.
 long getPacketsNotDelivered()
          Gets the number of packets that were not delivered to the application because they were before the most current forgetBefore value.
 long getPacketsNotRecovered()
          Gets the number of packets that were not recovered because they were before the current forgerBefore value.
 long getPacketsRcvd()
          Gets the number of data packets received.
 long getPacketsSent()
          Gets the number of packets sent.
 int getPeakMembers()
          Returns the maximum number of members tuned to the multicast session.
 int getPrunedMembers()
          Returns the number of members that were pruned during the session.
 int getReceiverCount()
          Returns the count of receivers participating in the multicast session.
 java.net.InetAddress[] getReceiverList()
          Returns the list of known receivers of the tuned to the multicast session.
 long getRetransBytesRcvd()
          Gets the number of retransmitted data bytes received.
 long getRetransmissionsRcvd()
          Gets the count of retransmission packets received.
 long getRetransmissionsSent()
          Gets the count of retransmission packets sent.
 int getSenderCount()
          Returns the count of senders participating in the multicast session.
 java.net.InetAddress[] getSenderList()
          Returns the list of senders of the multicast session.
 long getTotalDataReceive()
          Returns the bytecount of data received by this node.
 long getTotalDataReSent()
          Returns the bytecount of data retransmitted by this node to perform repairs.
 long getTotalDataSent()
          Returns the bytecount of data contributed to the multicast session.
protected  void incPacketsRcvd()
          Increments the number of packets received counter by 1.
protected  void incRetransRcvd()
          Increments retransmission packets received.
protected  void incRetransSent()
          Increments the number of retransmission packets sent.
 void removeReceiver(java.net.InetAddress address)
          Removes a receiver from the Receiver's list.
 void removeSender(java.net.InetAddress address)
          Removes a sender from the Sender's list.
protected  void setDataStartTime(long time)
          Sets the time at which the first data packet was received.
 void setPacketsNotDelivered(long notDelivered)
          Used only by clone()
 void setPacketsNotRecovered(long notRecovered)
          Used only by clone()
 void setRcvdCntlMsgCounters(com.sun.multicast.reliable.transport.tram.TRAMPacket pkt)
          Set the appropriate counters for control messages which are received.
 void setSendCntlMsgCounters(com.sun.multicast.reliable.transport.tram.TRAMPacket pkt)
          Set the appropriate counters for control messages which are sent.
 long ucastACKRcvd()
          Get the number of unicast ACK's received.
 long ucastACKSent()
          Get the number of unicast ACK's sent.
 long ucastAMRcvd()
          Get the number of unicast AM messages received.
 long ucastAMSent()
          Get the number of unicast AM messages sent.
 long ucastCntlBytesRcvd()
          Get the number of unicast control bytes received.
 long ucastCntlBytesSent()
          Get the number of unicast control bytes sent.
 long ucastCongRcvd()
          Get the number of unicast congestion messages received.
 long ucastCongSent()
          Get the number of unicast congestion messages sent.
 long ucastHBRcvd()
          Get the number of unicast HB messages received.
 long ucastHBSent()
          Get the number of unicast HB messages sent.
 long ucastHelloRcvd()
          Get the number of unicast Hello's received.
 long ucastHelloSent()
          Get the number of unicast Hello's sent.
 long ucastRMRcvd()
          Get the number of unicast RM Messages received.
 long ucastRMSent()
          Get the number of unicast RM Messages sent.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TRAMStats

public TRAMStats(com.sun.multicast.reliable.transport.tram.TRAMControlBlock tramblk)
Constructor.
Parameters:
tramblk - the TRAMControlBlock for this session.
Method Detail

getSenderCount

public int getSenderCount()
                   throws UnsupportedException
Returns the count of senders participating in the multicast session.
Specified by:
getSenderCount in interface RMStatistics
Returns:
int count of known senders of the multicast session.
Throws:
UnsupportedException - if Statistics block is not supported.

getSenderList

public java.net.InetAddress[] getSenderList()
                                     throws UnsupportedException
Returns the list of senders of the multicast session.
Specified by:
getSenderList in interface RMStatistics
Returns:
InetAddress[] list of known senders of the multicast session. A return value of null signifies no known senders.
Throws:
UnsupportedException - if Statistics Block is not supported.

getReceiverCount

public int getReceiverCount()
Returns the count of receivers participating in the multicast session.
Specified by:
getReceiverCount in interface RMStatistics
Returns:
count of known receivers of the multicast session. The sender will report the total number of members in the multicast group. a head will report the total number of direct and indirect members below the head in the TRAM tree.

getDirectMemberCount

public int getDirectMemberCount()
Return the number of direct members.
Returns:
count of members affiliated with this head or sender.

getIndirectMemberCount

public int getIndirectMemberCount()
Return the number of indirect members.
Returns:
count of members affiliated with this head or sender.

getReceiverList

public java.net.InetAddress[] getReceiverList()
                                       throws UnsupportedException
Returns the list of known receivers of the tuned to the multicast session.
Specified by:
getReceiverList in interface RMStatistics
Returns:
an array of current list of known receivers of the multicast session. The list of receivers is currently not supported by TRAM.
Throws:
UnsupportedException - is thrown if Statistics block is not supported.

getTotalDataSent

public long getTotalDataSent()
                      throws UnsupportedException
Returns the bytecount of data contributed to the multicast session.
Specified by:
getTotalDataSent in interface RMStatistics
Returns:
bytecount of data contributed to the session by this node.
Throws:
UnsupportedException - if Statistics block is not supported.

getTotalDataReSent

public long getTotalDataReSent()
                        throws UnsupportedException
Returns the bytecount of data retransmitted by this node to perform repairs.
Specified by:
getTotalDataReSent in interface RMStatistics
Returns:
bytecount of data retransmitted to the session by this node.
Throws:
UnsupportedException - if Statistics block is not supported.

getTotalDataReceive

public long getTotalDataReceive()
                         throws UnsupportedException
Returns the bytecount of data received by this node.
Specified by:
getTotalDataReceive in interface RMStatistics
Returns:
bytecount of data received by this node so far.
Throws:
UnsupportedException - if Statistics block is not supported.

clone

protected java.lang.Object clone()
Creates a copy of the TRAM Statistics blocks and returns a reference to it.
Overrides:
clone in class java.lang.Object
Returns:
the clone of the TRAM Statistics block.

addSender

public void addSender(java.net.InetAddress address)
Adds a sender to the Senders list.
Parameters:
address - the Address of the sender that is to be added to the sender's list.

removeSender

public void removeSender(java.net.InetAddress address)
Removes a sender from the Sender's list.
Parameters:
address - The address of the sender which is to be removed from the sender's list.

addReceiver

public void addReceiver(java.net.InetAddress address)
Adds a receiver to the Receivers list.
Parameters:
address - The address of the receiver that is to be added to the receiver list.

removeReceiver

public void removeReceiver(java.net.InetAddress address)
Removes a receiver from the Receiver's list.
Parameters:
address - The address of the receiver that is to be removed from the list.

getPacketsSent

public long getPacketsSent()
Gets the number of packets sent.
Returns:
the number of packets sent

getPacketsRcvd

public long getPacketsRcvd()
Gets the number of data packets received.
Returns:
the number of packets received

getDuplicatePackets

public long getDuplicatePackets()
Gets the number of duplicate(redundant) packets received.
Returns:
the number of duplicate data packets received.

getDuplicateBytes

public long getDuplicateBytes()
Gets the number of bytes of redundant data received.
Returns:
the total number of bytes received in duplicate packets.

getPacketsNotRecovered

public long getPacketsNotRecovered()
Gets the number of packets that were not recovered because they were before the current forgerBefore value.
Returns:
number of packets that were not recovered.

setPacketsNotRecovered

public void setPacketsNotRecovered(long notRecovered)
Used only by clone()

getPacketsNotDelivered

public long getPacketsNotDelivered()
Gets the number of packets that were not delivered to the application because they were before the most current forgetBefore value.
Returns:
number of packets received but not delivered

setPacketsNotDelivered

public void setPacketsNotDelivered(long notDelivered)
Used only by clone()

addBytesSent

public void addBytesSent(long count)
Method to augment the number of bytes sent.
Parameters:
count - bytes to add to the total bytes sent count

addBytesReSent

public void addBytesReSent(long count)
Method to augment the number of bytes resent.
Parameters:
count - bytes to add to the total bytes resent count

addPacketsSent

public void addPacketsSent()
Increments the number of data packets sent counter.

addPacketsSent

public void addPacketsSent(long count)
Adds a specified number of packets to the number of packet sent counter.
Parameters:
count - packets to be added to the total packets sent count

addBytesRcvd

public void addBytesRcvd(long count)
Adds a specified count of bytes to the bytes received counter.
Parameters:
count - bytes to add to the total bytes received count

addPacketsRcvd

protected void addPacketsRcvd()
Adds a packet to the total packets received counter.

incPacketsRcvd

protected void incPacketsRcvd()
Increments the number of packets received counter by 1.

addPacketsRcvd

protected void addPacketsRcvd(long count)
Adds the specified number of packets to the number of received packet counter.
Parameters:
count - packets to add to the total packets received count

addDuplicatePackets

protected void addDuplicatePackets()
Increments the duplicate packets received counter.

addDuplicatePackets

protected void addDuplicatePackets(long count)
Adds a specified number of packets to the duplicate packets received counter.
Parameters:
count - the number of packets to add to the total duplicate packet count

addDuplicateBytes

protected void addDuplicateBytes(long count)
Adds a specified number of bytes to the duplicate bytes received counter.
Parameters:
count - the number of bytes to add to the total duplicate packet byte count

addPacketsNotRecovered

protected void addPacketsNotRecovered(long count)
Adds a specified number of packets to the number of packets that were not recovered because they were before the most current forgetBefore value
Parameters:
count - the number of packets to add to packetsNotRecovered

addPacketsNotDelivered

protected void addPacketsNotDelivered(long count)
Adds a specified number of packets to the number of packets that were received but not delivered to the application.
Parameters:
count - the number of acplets to add to packetsNotDelivered

getPeakMembers

public int getPeakMembers()
Returns the maximum number of members tuned to the multicast session.
Returns:
the peak number of members for this session. The system must be a head member for this value to be nonZero.

getPrunedMembers

public int getPrunedMembers()
Returns the number of members that were pruned during the session.
Returns:
the number of members pruned during this session. The system must be a head member for this value to be nonZero.

getLostMembers

public int getLostMembers()
Returns the number of members that were disowned as a result of inactiveness.
Returns:
the number of members who disappeared during the session. The system must be a head member for this value to be nonZero.

addPrunedMembers

protected void addPrunedMembers()
Adds one to the pruned member count.

addPrunedMembers

protected void addPrunedMembers(int count)
Adds a specified count of members to the pruned member count.
Parameters:
count - add count members to the pruned member count.

addLostMembers

protected void addLostMembers()
Adds one to the lost member count.

addLostMembers

protected void addLostMembers(int count)
Adds a specified count of members to the lost member count.
Parameters:
count - add count members to the lost member count.

addRetransBytesRcvd

protected void addRetransBytesRcvd(int count)
Adds a specified count of bytes to the retransmitted bytes received counter.
Parameters:
count - bytes to add to the retransmitted bytes received count

incRetransSent

protected void incRetransSent()
Increments the number of retransmission packets sent.

getRetransmissionsSent

public long getRetransmissionsSent()
Gets the count of retransmission packets sent.
Returns:
count of retransmission packets sent.

incRetransRcvd

protected void incRetransRcvd()
Increments retransmission packets received.

getRetransmissionsRcvd

public long getRetransmissionsRcvd()
Gets the count of retransmission packets received.
Returns:
count of retransmission packets received.

getRetransBytesRcvd

public long getRetransBytesRcvd()
Gets the number of retransmitted data bytes received.
Returns:
number of retransmitted data bytes received.

getDataStartTime

public long getDataStartTime()
Gets the time at which the first data packet was received.
Returns:
the time at which the first data packet was received.

setDataStartTime

protected void setDataStartTime(long time)
Sets the time at which the first data packet was received.
Parameters:
time - - the time that is to be set.

setRcvdCntlMsgCounters

public void setRcvdCntlMsgCounters(com.sun.multicast.reliable.transport.tram.TRAMPacket pkt)
Set the appropriate counters for control messages which are received.

setSendCntlMsgCounters

public void setSendCntlMsgCounters(com.sun.multicast.reliable.transport.tram.TRAMPacket pkt)
Set the appropriate counters for control messages which are sent.

getMcastControlBytesSent

public long getMcastControlBytesSent()
Get the number of multicast control bytes sent.

getMcastControlBytesRcvd

public long getMcastControlBytesRcvd()
Get the number of multicast control bytes received.

getMcastBeaconSent

public long getMcastBeaconSent()
Get the number of multicast beacons sent.

getMcastBeaconRcvd

public long getMcastBeaconRcvd()
Get the number of multicast beacons received.

getMcastHelloSent

public long getMcastHelloSent()
Get the number of multicast hellos sent.

getMcastHelloRcvd

public long getMcastHelloRcvd()
Get the number of multicast hellos received.

getMcastHASent

public long getMcastHASent()
Get the number of multicast HA messages sent.

getMcastHARcvd

public long getMcastHARcvd()
Get the number of multicast HA messages received.

getMcastMSSent

public long getMcastMSSent()
Get the number of multicast MS messages sent.

getMcastMSRcvd

public long getMcastMSRcvd()
Get the number of multicast MS messages received.

ucastCntlBytesSent

public long ucastCntlBytesSent()
Get the number of unicast control bytes sent.

ucastCntlBytesRcvd

public long ucastCntlBytesRcvd()
Get the number of unicast control bytes received.

ucastAMSent

public long ucastAMSent()
Get the number of unicast AM messages sent.

ucastAMRcvd

public long ucastAMRcvd()
Get the number of unicast AM messages received.

ucastRMSent

public long ucastRMSent()
Get the number of unicast RM Messages sent.

ucastRMRcvd

public long ucastRMRcvd()
Get the number of unicast RM Messages received.

ucastHelloSent

public long ucastHelloSent()
Get the number of unicast Hello's sent.

ucastHelloRcvd

public long ucastHelloRcvd()
Get the number of unicast Hello's received.

ucastACKSent

public long ucastACKSent()
Get the number of unicast ACK's sent.

ucastACKRcvd

public long ucastACKRcvd()
Get the number of unicast ACK's received.

ucastCongSent

public long ucastCongSent()
Get the number of unicast congestion messages sent.

ucastCongRcvd

public long ucastCongRcvd()
Get the number of unicast congestion messages received.

ucastHBSent

public long ucastHBSent()
Get the number of unicast HB messages sent.

ucastHBRcvd

public long ucastHBRcvd()
Get the number of unicast HB messages received.


JavaTM Reliable MulticastTM Service version 1.1
Copyright (c) 2001, Sun Microsystems Laboratories, All rights reserved.