DwmHostPinger.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmHostPinger.hh 8499 $
// @(#) $Id: DwmHostPinger.hh 8499 2016-05-09 00:59:08Z dwm $
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2007, 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 _DWMHOSTPINGER_HH_
#define _DWMHOSTPINGER_HH_

#include <condition_variable>
#include <iostream>
#include <map>
#include <mutex>
#include <thread>

#include "DwmIpv4Address.hh"
#include "DwmPcap.hh"
#include "DwmSocket.hh"
#include "DwmTimeValue.hh"

#include "DwmPingDestinationEntry.hh"

namespace Dwm {

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class HostPinger
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    class Receiver
    {
    public:
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      virtual void operator () (const PingDestination & destination,
                                const TimeValue & recvTime,
                                const TimeValue & rtt) = 0;
    };
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    HostPinger(uint16_t identifier, const std::string & device = "lo0");

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static Receiver *GetReceiver();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static Receiver *SetReceiver(Receiver *receiver);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool AddDestination(const PingDestination & destination);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t PacketRate() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t PacketRate(uint16_t pps);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t PacketsSent(const PingDestination & destination) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t PacketsReceived(const PingDestination & destination) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    float PacketLoss(const PingDestination & destination) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Start(int count = 0);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Stop();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Outstanding() const;
    
  protected:
    typedef std::map<PingDestination,PingDestinationEntry>  DestinationMap;

    std::string                   _device;
    Ipv4Address                   _myAddress;
    std::thread                   _watcherThread;
    std::thread                   _senderThread;
    std::mutex                    _watcherReadyMutex;
    std::unique_lock<std::mutex>  _watcherReadyLock;
    std::condition_variable       _watcherReady;
    bool                          _runSender;
    bool                          _runWatcher;
    uint16_t                      _identifier;
    Socket                        _socket;
    uint16_t                      _packetRate;
    Pcap                          _pcap;
    int                           _count;
    bool                          _forever;
    DestinationMap                _destinations;
    static Receiver              *_receiver;
    
    bool StopWatcher();
    bool StopSender();
    void GetTcpPacket(const PingDestination & destination,
                      uint16_t seq, std::string & s);
    
    static void PcapCallback(uint8_t *user, const struct pcap_pkthdr *pchdr, 
                             const uint8_t *pkt);
    void RunWatcher();
    void RunSender();
  };
  
}  // namespace Dwm

#endif  // _DWMHOSTPINGER_HH_