DwmPingDestination.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmPingDestination.hh 8401 $
// @(#) $Id: DwmPingDestination.hh 8401 2016-04-17 06:44:31Z dwm $
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2008
//  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 _DWMPINGDESTINATION_HH_
#define _DWMPINGDESTINATION_HH_

#include <string>

#include "DwmIpv4Address.hh"
#include "DwmSocket.hh"

namespace Dwm {

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class PingDestination
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    PingDestination();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    PingDestination(const std::string & destination);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    PingDestination(const Ipv4Address & addr, uint16_t port = 0);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const Ipv4Address & Address() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const Ipv4Address & Address(const Ipv4Address & address);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t Port() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const std::string & Hostname() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const std::string & Hostname(const std::string & hostname);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool SendTo(Socket & socket, const Ipv4Address & myAddress,
                uint16_t identifier) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator < (const PingDestination & pd) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator == (const PingDestination & pd) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual operator std::string () const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    friend std::ostream & 
    operator << (std::ostream & os, const PingDestination & pd);
    
  protected:
    Ipv4Address       _addr;
    uint16_t          _port;
    std::string       _hostname;
    mutable bool      _primed;
    mutable uint16_t  _sequenceNumber;

    void GetPacket(std::string & packet, const Ipv4Address & myAddress, 
                   uint16_t identifier) const;
    void GetIcmpPacket(std::string & packet, const Ipv4Address & myAddress, 
                       uint16_t identifier) const;
    void GetTcpPacket(std::string & packet, const Ipv4Address & myAddress, 
                      uint16_t identifier) const;
  };
  
}  // namespace Dwm

#endif  // _DWMPINGDESTINATION_HH_