DwmPingDestinationEntry.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmPingDestinationEntry.hh 8401 $
// @(#) $Id: DwmPingDestinationEntry.hh 8401 2016-04-17 06:44:31Z dwm $
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2008, 2016
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------

#ifndef _DWMPINGDESTINATIONENTRY_HH_
#define _DWMPINGDESTINATIONENTRY_HH_

#include <map>

#include "DwmTimeValue.hh"
#include "DwmPingDestination.hh"

namespace Dwm {

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class PingSequencesInFlight
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    PingSequencesInFlight();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Destination(const PingDestination & destination);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool AddSent(uint16_t seq, const TimeValue & sendTime);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool ProcessReceive(uint16_t seq, const TimeValue & recvTime, 
                        TimeValue & rtt);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Outstanding() const;
    
  protected:
    PingDestination                _destination;
    std::map<uint16_t,TimeValue>   _sequences;

    void CleanupOld();
  };
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class PingDestinationEntry
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    PingDestinationEntry();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Destination(const PingDestination & destination);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const PingSequencesInFlight & Sequences() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    PingSequencesInFlight & Sequences();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint64_t PacketsSent() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint64_t PacketsSent(uint64_t packetsSent);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint64_t PacketsReceived() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint64_t PacketsReceived(uint64_t packetsReceived);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Primed() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Primed(bool primed);
    
  protected:
    PingDestination          _destination;
    PingSequencesInFlight    _sequences;
    uint64_t                 _packetsSent;
    uint64_t                 _packetsReceived;
    bool                     _primed;
  };
  
}  // namespace Dwm

#endif  // _DWMPINGDESTINATIONENTRY_HH_