NetworkInterface.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_NetworkInterface_hxx
#define __ccxx_NetworkInterface_hxx

#include <commonc++/Common.h++>
#include <commonc++/InetAddress.h++>
#include <commonc++/MACAddress.h++>
#include <commonc++/String.h++>

namespace ccxx {

class COMMONCPP_API NetworkInterface
{
  friend class Network;

  public:

  static const uint32_t FLAG_UP;

  static const uint32_t FLAG_BROADCAST;

  static const uint32_t FLAG_DEBUG;

  static const uint32_t FLAG_LOOPBACK;

  static const uint32_t FLAG_PPP;

  static const uint32_t FLAG_NOTRAILERS;

  static const uint32_t FLAG_RUNNING;

  static const uint32_t FLAG_NOARP;

  static const uint32_t FLAG_PROMISCUOUS;

  static const uint32_t FLAG_MULTICAST;

  static const uint32_t FLAG_MASK;

  ~NetworkInterface() throw();

  inline String getName() const
  { return(_name); }

  inline InetAddress getAddress() const
  { return(_addr); }

  inline MACAddress getHardwareAddress() const
  { return(_hwAddr); }

  inline InetAddress getBroadcastAddress() const throw()
  { return(_broadcastAddr); }

  inline InetAddress getDestAddress() const throw()
  { return(_destAddr); }

  inline InetAddress getNetMask() const throw()
  { return(_netmask); }

  inline uint_t getPrefixLength() const throw()
  { return(_prefixLength); }

  inline uint32_t getFlags() const throw()
  { return(_flags); }

  inline bool isUp() const throw()
  { return((_flags & FLAG_UP) != 0); }

  inline bool isBroadcastSupported() const throw()
  { return((_flags & FLAG_BROADCAST) != 0); }

  inline bool isMulticastSupported() const throw()
  { return((_flags & FLAG_MULTICAST) != 0); }

  inline bool isDebuggingEnabled() const throw()
  { return((_flags & FLAG_DEBUG) != 0); }

  inline bool isLoopback() const throw()
  { return((_flags & FLAG_LOOPBACK) != 0); }

  inline bool isPPP() const throw()
  { return((_flags & FLAG_PPP) != 0); }

  inline bool isNoTrailers() const throw()
  { return((_flags & FLAG_NOTRAILERS) != 0); }

  inline bool isRunning() const throw()
  { return((_flags & FLAG_RUNNING) != 0); }

  inline bool isNoARP() const throw()
  { return((_flags & FLAG_NOARP) != 0); }

  inline bool isPromiscuous() const throw()
  { return((_flags & FLAG_PROMISCUOUS) != 0); }

  inline int getMTU() const throw()
  { return(_mtu); }

  inline int getMetric() const throw()
  { return(_metric); }

  private:

  NetworkInterface() throw();

  inline void setName(String name)
  { _name = name; }

  inline void setAddress(const InetAddress &addr)
  { _addr = addr; }

  inline void setHardwareAddress(const MACAddress &addr)
  { _hwAddr = addr; }

  inline void setBroadcastAddress(const InetAddress &addr)
  { _broadcastAddr = addr; }

  inline void setDestAddress(const InetAddress &addr)
  { _destAddr = addr; }

  void setNetmask(const InetAddress &addr);

  inline void setUp(bool flag) throw()
  { flag ? _flags |= FLAG_UP : _flags &= ~FLAG_UP; }

  inline void setBroadcastSupported(bool flag) throw()
  { flag ? _flags |= FLAG_BROADCAST : _flags &= ~FLAG_BROADCAST; }

  inline void setDebuggingEnabled(bool flag) throw()
  { flag ? _flags |= FLAG_DEBUG : _flags &= ~FLAG_DEBUG; }

  inline void setLoopback(bool flag) throw()
  { flag ? _flags |= FLAG_LOOPBACK : _flags &= ~FLAG_LOOPBACK; }

  inline void setPPP(bool flag) throw()
  { flag ? _flags |= FLAG_PPP : _flags &= ~FLAG_PPP; }

  inline void setNoTrailers(bool flag) throw()
  { flag ? _flags |= FLAG_NOTRAILERS : _flags &= ~FLAG_NOTRAILERS; }

  inline void setRunning(bool flag) throw()
  { flag ? _flags |= FLAG_RUNNING : _flags &= ~FLAG_RUNNING; }

  inline void setNoARP(bool flag) throw()
  { flag ? _flags |= FLAG_NOARP : _flags &= ~FLAG_NOARP; }

  inline void setPromiscuous(bool flag) throw()
  { flag ? _flags |= FLAG_PROMISCUOUS : _flags &= ~FLAG_PROMISCUOUS; }

  inline void setMulticastSupported(bool flag) throw()
  { flag ? _flags |= FLAG_MULTICAST : _flags &= ~FLAG_MULTICAST; }

  inline void setFlags(int flags) throw()
  { _flags = flags & FLAG_MASK; }

  inline void setMTU(int mtu) throw()
  { _mtu = mtu; }

  inline void setMetric(int metric) throw()
  { _metric = metric; }

  String _name;
  MACAddress _hwAddr;
  InetAddress _addr;
  InetAddress _broadcastAddr;
  InetAddress _destAddr;
  InetAddress _netmask;
  int _mtu;
  int _metric;
  uint_t _prefixLength;
  uint32_t _flags;
};

}; // namespace ccxx

#endif // __ccxx_NetworkInterface_hxx

/* end of header file */