DwmLocalInterfaces.hh

Go to the documentation of this file.

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

extern "C" {
  #include <sys/types.h>
  #include <sys/socket.h>
  #include <netinet/in.h>
  #include <arpa/inet.h>
}

#include <set>
#include <string>
#include <map>

#include "DwmIpv4Address.hh"

namespace Dwm {

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

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    LocalInterfaceAlias(const Ipv4Address & address, const Ipv4Address & mask);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const Ipv4Address & Addr() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const Ipv4Address & Addr(const Ipv4Address & addr);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const Ipv4Address & Mask() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const Ipv4Address & Mask(const Ipv4Address & mask);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator < (const LocalInterfaceAlias & alias) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator == (const LocalInterfaceAlias & alias) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    friend std::ostream & 
    operator << (std::ostream & os, const LocalInterfaceAlias & alias);
    
  private:
    Ipv4Address  _addr;
    Ipv4Address  _mask;
  };
  
  //------------------------------------------------------------------------
  //------------------------------------------------------------------------
  class LocalInterface
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    LocalInterface();
    
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    const std::string & Name() const;

    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    const std::string & Name(const std::string & name);

    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    const Ipv4Address & Addr() const;

    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    const Ipv4Address & Addr(const Ipv4Address & addr);

    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    const Ipv4Address & Mask() const;

    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    const Ipv4Address & Mask(const Ipv4Address & mask);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Mtu() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Mtu(int mtu);
    
    //--------------------------------------------------------------------
    //--------------------------------------------------------------------
    bool IsUp() const;

    bool IsRunning() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool AddAlias(const Ipv4Address & address, const Ipv4Address & netmask);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool RemoveAlias(const Ipv4Address & address, const Ipv4Address & netmask);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const std::set<LocalInterfaceAlias> & Aliases() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::set<LocalInterfaceAlias> & Aliases();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    friend std::ostream & operator << (std::ostream & os, 
                                       const LocalInterface & li);
    
  private:
    std::string                    _name;
    Ipv4Address                    _addr;
    Ipv4Address                    _mask;
    int                            _mtu;
    std::set<LocalInterfaceAlias>  _aliases;
  };

  //------------------------------------------------------------------------
  //------------------------------------------------------------------------
  bool GetLocalInterfaces(std::map<std::string,LocalInterface> & interfaces);
    
}  // namespace Dwm

#endif  // _DWMLOCALINTERFACES_HH_

//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++/la
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------