\brief NetdeviceController public header
*/
-#ifndef HH_NetdeviceController_
-#define HH_NetdeviceController_ 1
+#ifndef HH_SENF_Socket_NetdeviceController_
+#define HH_SENF_Socket_NetdeviceController_ 1
// Custom includes
#include <string>
namespace senf {
- /** \brief NetdeviceController
-
- \todo document me
+ /** \brief Netdevice Controller
+
+ This controller provides an interface which can be used to configure network
+ devices. Note, that some setting members are privileged operations.
+
+ \see manual page netdevice(7) for more informations.
+
\todo Add 'promisc' member to enable/disable promiscuous mode
*/
class NetdeviceController
{
public:
NetdeviceController(std::string const & interface_name);
+ ///< Construct a new controller for the given interface name.
NetdeviceController(int interface_index);
+ ///< Construct a new controller for the given interface index.
virtual ~NetdeviceController();
-
- MACAddress hardwareAddress();
- std::string interfaceName();
- int interfaceIndex(); ///< return the interface index of the interface
- int mtu();
- void mtu(int new_mtu);
-
+
+ int interfaceIndex() const; ///< return the interface index
+ MACAddress hardwareAddress() const;
+ ///< return hardware address
+ void hardwareAddress(const MACAddress &newAddress);
+ ///< set hardware address
+ /**< Changes the hardware address of the interface.
+ Note, that setting the hardware address is a privileged operation. It is only allowed when the interface
+ is not up. If the interface is up, this call will cause an SystemException to be thrown.*/
+ std::string interfaceName() const;
+ ///< return interface name
+ void interfaceName(const std::string &newName);
+ ///< set interface name
+ /**< Changes the name of the interface.
+ Note, that setting the name is a privileged operation. It is only allowed when the interface
+ is not up. If the interface is up, this call will cause an SystemException to be thrown.*/
+
+ int mtu() const; ///< return the Maximum Transmission Unit
+ void mtu(int new_mtu); ///< set the Maximum Transmission Unit
+ /**< Set the MTU (Maximum Transfer Unit) of the device.
+ Note, that this is a privileged operation.
+ Setting the MTU to too small values may cause kernel crashes. */
private:
void openSocket();
- void doIoctl(ifreq& ifr, int request);
- void ifrName(ifreq& ifr);
+ void doIoctl(ifreq& ifr, int request) const;
+ void ifrName(ifreq& ifr) const;
int sockfd_;
int ifindex_;
};
//#include "NetdeviceController.mpp"
#endif
-\f
+
// Local Variables:
// mode: c++
// fill-column: 100