diff options
Diffstat (limited to 'doxygen/man/man3/NetworkManager.3')
| -rw-r--r-- | doxygen/man/man3/NetworkManager.3 | 161 |
1 files changed, 161 insertions, 0 deletions
diff --git a/doxygen/man/man3/NetworkManager.3 b/doxygen/man/man3/NetworkManager.3 new file mode 100644 index 0000000..b1c558e --- /dev/null +++ b/doxygen/man/man3/NetworkManager.3 @@ -0,0 +1,161 @@ +.TH "NetworkManager" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +NetworkManager \- +.PP +Manages the network configurations like setting new default routes. + +.SH SYNOPSIS +.br +.PP +.PP +\fC#include <networkmanager.h>\fP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBNetworkManager\fP ()" +.br +.ti -1c +.RI "virtual \fB~NetworkManager\fP ()" +.br +.ti -1c +.RI "int \fBreplaceDefaultRoute\fP (QString ifname, QString gateway, int metric, int af)" +.br +.ti -1c +.RI "int \fBbringInterfaceUP\fP (QString ifname)" +.br +.ti -1c +.RI "int \fBbringInterfaceDown\fP (QString ifname)" +.br +.ti -1c +.RI "int \fBip4_setManualConfiguration\fP (QString ifname, QString ipAddress, QString netmask, QString broadcast, QString gateway, int metric, int af, QString pathToResolvConf, QList< QString > nameServer)" +.br +.ti -1c +.RI "int \fBip4_configureInterface\fP (QString ifname, QString ipAddress, QString broadcast, QString netmask, int af)" +.br +.ti -1c +.RI "int \fBip6_addRoute\fP (const char *iface, const struct in6_addr *ip6_dest, int ip6_prefix, const struct in6_addr *ip6_gateway, int metric, int mss)" +.br +.ti -1c +.RI "int \fBip6_addAddress\fP (struct ip6_addr *ip6Addr, const char *iface)" +.br +.ti -1c +.RI "int \fBwriteResolvConf\fP (QString path, QString ifname, QList< QString > nameServer)" +.br +.in -1c +.SH "Detailed Description" +.PP +Manages the network configurations like setting new default routes. + +Copyright (c) 2010,2011 - RZ Uni Freiburg Copyright (c) 2010,2011 - OpenSLX Project +.PP +This program/file is free software distributed under the GPL version 2. See http://openslx.org/COPYING +.PP +If you have any feedback please consult http://openslx.org/feedback and send your feedback to feedback@openslx.org +.PP +General information about OpenSLX can be found under http://openslx.org +.PP +Manages the network configurations like setting new default routes. It provides methods for ipv4 and some method for ipv6. +.SH "Constructor & Destructor Documentation" +.PP +.SS "NetworkManager::NetworkManager ()" +.SS "NetworkManager::~NetworkManager ()\fC [virtual]\fP" +.SH "Member Function Documentation" +.PP +.SS "int NetworkManager::bringInterfaceDown (QStringifname)"The method brings an interface down. +.PP +\fBParameters:\fP +.RS 4 +\fIifname\fP the name of the interface +.RE +.PP +\fBReturns:\fP +.RS 4 +0 -> success -1 -> error +.RE +.PP + +.SS "int NetworkManager::bringInterfaceUP (QStringifname)"The method brings an interface up. +.PP +\fBParameters:\fP +.RS 4 +\fIifname\fP the name of the interface +.RE +.PP +\fBReturns:\fP +.RS 4 +0 -> success -1 -> error +.RE +.PP + +.SS "int NetworkManager::ip4_configureInterface (QStringifname, QStringipAddress, QStringbroadcast, QStringnetmask, intaf)" +.SS "int NetworkManager::ip4_setManualConfiguration (QStringifname, QStringipAddress, QStringnetmask, QStringbroadcast, QStringgateway, intmetric, intaf, QStringpathToResolvConf, QList< QString >nameServer)"This method is used when the manual configuration is needed. +.PP +This method is used when the manual configuration is needed. First we bring up the interface. Than we configure the interface with our manual entered configuration dates. After that we replace the old default route with the new and write a resolv.conf. +.PP +\fBParameters:\fP +.RS 4 +\fIifname\fP name of the interface which we are about to configure. +.br +\fIipAddress\fP the new IP-Address. +.br +\fInetmask\fP the netmask of the IP-Address. +.br +\fIbroadcast\fP the broadcast address. +.br +\fIgateway\fP the gateway address. +.br +\fImetric\fP do not exactly know why we need this. in most cases this should be 0. +.br +\fIaf\fP the address type. Either AF_INET for IPv4 or AF_INET6 for IPv6. +.br +\fIpathToResolvConf\fP the path to the resolf.conf file. in most cases '/etc/'. +.br +\fInameServer\fP the name server addresses. +.RE +.PP + +.SS "int NetworkManager::ip6_addAddress (struct ip6_addr *ip6Addr, const char *iface)" +.SS "int NetworkManager::ip6_addRoute (const char *iface, const struct in6_addr *ip6_dest, intip6_prefix, const struct in6_addr *ip6_gateway, intmetric, intmss)" +.SS "int NetworkManager::replaceDefaultRoute (QStringifname, QStringgateway, intmss, intaf)"This method adds /replaces the default route. This method adds /replaces the default route. To keep it modular, it is possible to specify an ip address family. +.PP +\fBParameters:\fP +.RS 4 +\fIifName\fP the interface name +.br +\fIgateway\fP the gateway address (e.g: 192.168.0.254) +.br +\fImss\fP the mss. +.br +\fIaf\fP specify the family type of the ip address. possible values are: AF_INET for an IPv4 address AF_INET6 for an IPv6 address +.RE +.PP +\fBReturns:\fP +.RS 4 +return -1 if an error happened. return 0 if everything was ok. +.RE +.PP + +.SS "int NetworkManager::writeResolvConf (QStringpath, QStringifname, QList< QString >nameServer)"This method writes a resolv.conf file. +.PP +\fBParameters:\fP +.RS 4 +\fIpath\fP path to the resolv.conf file. (in most cases: /etc/) +.br +\fIifname\fP name of the interface +.br +\fIaddresses\fP of the nameserver +.RE +.PP +\fBReturns:\fP +.RS 4 +return 0 if success else -1 +.RE +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. |