Interface.h

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Interface.h
 * Represents a network interface.
 * Copyright (C) 2010 Simon Newton
 */

#ifndef INCLUDE_OLA_NETWORK_INTERFACE_H_
#define INCLUDE_OLA_NETWORK_INTERFACE_H_

#include <ola/network/IPV4Address.h>
#include <string>

namespace ola {
namespace network {

enum { MAC_LENGTH = 6 };

using std::string;

/*
 * Represents an interface.
 */
class Interface {
  public:
    Interface();
    Interface(const string &name,
              const IPV4Address &ip_address,
              const IPV4Address &broadcast_address,
              const IPV4Address &subnet_mask,
              const uint8_t *hw_address,
              bool loopback);
    Interface(const Interface &other);
    Interface& operator=(const Interface &other);
    bool operator==(const Interface &other);

    std::string name;
    IPV4Address ip_address;
    IPV4Address bcast_address;
    IPV4Address subnet_mask;
    uint8_t hw_address[MAC_LENGTH];
    bool loopback;
};


class InterfaceBuilder {
  public:
    InterfaceBuilder();
    ~InterfaceBuilder() {}

    void SetName(const string &name) { m_name = name; }

    bool SetAddress(const string &ip_address);
    void SetAddress(const IPV4Address &ip_address) {
      m_ip_address = ip_address;
    }

    bool SetBroadcast(const string &broadcast_address);
    void SetBroadcast(const IPV4Address &broadcast_address) {
      m_broadcast_address = broadcast_address;
    }

    bool SetSubnetMask(const string &mask);
    void SetSubnetMask(const IPV4Address &mask) {
      m_subnet_mask = mask;
    }

    bool SetHardwareAddress(const string &mac_address);

    void SetLoopback(bool loopback);

    void Reset();
    Interface Construct();

  private:
    std::string m_name;
    IPV4Address m_ip_address;
    IPV4Address m_broadcast_address;
    IPV4Address m_subnet_mask;
    uint8_t m_hw_address[MAC_LENGTH];
    bool m_loopback;

    bool SetAddress(const string &str, IPV4Address *target);
};
}  // namespace network
}  // namespace ola
#endif  // INCLUDE_OLA_NETWORK_INTERFACE_H_