diff options
Diffstat (limited to 'doxygen/man/man3')
31 files changed, 2054 insertions, 0 deletions
diff --git a/doxygen/man/man3/DownloadManager.3 b/doxygen/man/man3/DownloadManager.3 new file mode 100644 index 0000000..00388cb --- /dev/null +++ b/doxygen/man/man3/DownloadManager.3 @@ -0,0 +1,72 @@ +.TH "DownloadManager" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +DownloadManager \- +.SH SYNOPSIS +.br +.PP +.PP +\fC#include <downloadmanager.h>\fP +.SS "Public Slots" + +.in +1c +.ti -1c +.RI "void \fBdownloadFile\fP (const QUrl &fileUrl)" +.br +.ti -1c +.RI "void \fBdownloadFile\fP (const QString &fileUrl)" +.br +.in -1c +.SS "Signals" + +.in +1c +.ti -1c +.RI "void \fBnotify\fP (const QString &msg)" +.br +.ti -1c +.RI "void \fBdownloadInfo\fP (const QString &filename, const double &filesize)" +.br +.ti -1c +.RI "void \fBupdateProgress\fP (const int &percent, const double &speed, const QString &unit)" +.br +.ti -1c +.RI "void \fBdownloadQueueEmpty\fP ()" +.br +.in -1c +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBDownloadManager\fP ()" +.br +.ti -1c +.RI "\fB~DownloadManager\fP ()" +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "QTime \fBtime\fP" +.br +.in -1c +.SH "Constructor & Destructor Documentation" +.PP +.SS "DownloadManager::DownloadManager ()" +.SS "DownloadManager::~DownloadManager ()" +.SH "Member Function Documentation" +.PP +.SS "void DownloadManager::downloadFile (const QUrl &fileUrl)\fC [slot]\fP" +.SS "void DownloadManager::downloadFile (const QString &fileUrl)\fC [slot]\fP" +.SS "void DownloadManager::downloadInfo (const QString &filename, const double &filesize)\fC [signal]\fP" +.SS "void DownloadManager::downloadQueueEmpty ()\fC [signal]\fP" +.SS "void DownloadManager::notify (const QString &msg)\fC [signal]\fP" +.SS "void DownloadManager::updateProgress (const int &percent, const double &speed, const QString &unit)\fC [signal]\fP" +.SH "Member Data Documentation" +.PP +.SS "QTime \fBDownloadManager::time\fP" + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/JavascriptInterface.3 b/doxygen/man/man3/JavascriptInterface.3 new file mode 100644 index 0000000..2f487b7 --- /dev/null +++ b/doxygen/man/man3/JavascriptInterface.3 @@ -0,0 +1,195 @@ +.TH "JavascriptInterface" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +JavascriptInterface \- +.SH SYNOPSIS +.br +.PP +.PP +\fC#include <javascriptinterface.h>\fP +.SS "Public Slots" + +.in +1c +.ti -1c +.RI "void \fBattachToDOM\fP ()" +.br +.ti -1c +.RI "void \fBstartDownload\fP (const QString &filename)" +.br +.ti -1c +.RI "void \fBsetCallbackOnFinished\fP (const QString &function)" +.br +.ti -1c +.RI "const QString \fBgetSysInfo\fP (const QString &info)" +.br +.ti -1c +.RI "void \fBquit\fP ()" +.br +.ti -1c +.RI "void \fBshutDown\fP ()" +.br +.ti -1c +.RI "void \fBreboot\fP ()" +.br +.ti -1c +.RI "void \fBcallbackOnFinished\fP ()" +.br +.ti -1c +.RI "void \fBupdateProgressBar\fP (const int &percent, const double &speed, const QString &unit)" +.br +.ti -1c +.RI "void \fBdownloadInfo\fP (const QString &filename, const double &filesize)" +.br +.ti -1c +.RI "void \fBnotify\fP (const QString &msg)" +.br +.ti -1c +.RI "void \fBtrigger\fP ()" +.br +.in -1c +.SS "Signals" + +.in +1c +.ti -1c +.RI "void \fBrequestFile\fP (const QString &filename)" +.br +.ti -1c +.RI "void \fBquitFbgui\fP ()" +.br +.ti -1c +.RI "void \fBshutDownClient\fP ()" +.br +.ti -1c +.RI "void \fBrebootClient\fP ()" +.br +.in -1c +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBJavascriptInterface\fP (QWebFrame *parent)" +.br +.ti -1c +.RI "\fB~JavascriptInterface\fP ()" +.br +.in -1c +.SH "Constructor & Destructor Documentation" +.PP +.SS "JavascriptInterface::JavascriptInterface (QWebFrame *parent)"A constructor. +.PP +\fBParameters:\fP +.RS 4 +\fIparent\fP Is of type QWebFrame. +.RE +.PP + +.SS "JavascriptInterface::~JavascriptInterface ()"An empty destructor. +.SH "Member Function Documentation" +.PP +.SS "void JavascriptInterface::attachToDOM ()\fC [slot]\fP"Attaches an instance of this class to the DOM of the HTML page. +.PP +Attaches an instance of this class to the DOM of the HTML page. This enables the possibility to call slots/methods of this class in JavaScript functions of HTML page. It also calls the JavascriptInterface::loadJQuery() method. +.PP +\fBSee also:\fP +.RS 4 +JavascriptInterface::loadJQuery() +.RE +.PP + +.SS "void JavascriptInterface::callbackOnFinished ()\fC [slot]\fP"Sets a callback function for when downloads are finished (will be called when the queue is empty). +.SS "void JavascriptInterface::downloadInfo (const QString &filename, const double &filesize)\fC [slot]\fP"This method delivers some informations about the downloading file. +.PP +This method delivers some informations about the downloading file. +.PP +\fBTodo\fP +.RS 4 +add some more informations +.RE +.PP + +.SS "const QString JavascriptInterface::getSysInfo (const QString &info)\fC [slot]\fP"This method delivers system informations. +.PP +This method delivers system informations. Type of informations, are defined by the parameter. The output of this method depends on the parameter. Can be called from inside a JavaScript function of the HTML page. +.PP +\fBParameters:\fP +.RS 4 +\fIinfoName\fP Is of type QString. Defines which method will be called. Possible values are: +.IP "\(bu" 2 +mac +.IP "\(bu" 2 +ip +.IP "\(bu" 2 +mbserial +.IP "\(bu" 2 +usb +.PP +.RE +.PP +\fBReturns:\fP +.RS 4 +QString the output of the called method or 'info_error' if an error occurred (e. g. invalid parameter). +.RE +.PP +\fBSee also:\fP +.RS 4 +\fBSysInfo::getInfo(const QString& infoName)\fP +.RE +.PP + +.SS "void JavascriptInterface::notify (const QString &msg)\fC [slot]\fP"This method sends out messages to Javascript. A corresponding function must be implemented on the webpage to receive these. +.SS "void JavascriptInterface::quit ()\fC [slot]\fP"This method quits the whole program. +.PP +This method quits the whole program. Can be called from inside a JavaScript function of the HTML page. Emits \fBJavascriptInterface::quitFbgui()\fP signal +.SS "void JavascriptInterface::quitFbgui ()\fC [signal]\fP" +.SS "void JavascriptInterface::reboot ()\fC [slot]\fP"This method performs a reboot of the client. +.PP +This method performs a reboot of the client. Emits the \fBJavascriptInterface::rebootClient()\fP signal. It is connected with the fbgui::performReboot() method. +.PP +\fBSee also:\fP +.RS 4 +fbgui::performReboot() +.RE +.PP + +.SS "void JavascriptInterface::rebootClient ()\fC [signal]\fP" +.SS "void JavascriptInterface::requestFile (const QString &filename)\fC [signal]\fP" +.SS "void JavascriptInterface::setCallbackOnFinished (const QString &function)\fC [slot]\fP"This method start a download. +.PP +This method start a download. Can be called from inside a JavaScript function of the HTML page. +.PP +\fBTodo\fP +.RS 4 +add some more informations +.RE +.PP + +.SS "void JavascriptInterface::shutDown ()\fC [slot]\fP"This method performs a shutdown of the client. +.PP +This method performs a shutdown of the client. Emits the \fBJavascriptInterface::shutDownClient()\fP signal.It is connected with the fbgui::performShutDown() method. +.PP +\fBSee also:\fP +.RS 4 +fbgui::performShutDown() +.RE +.PP + +.SS "void JavascriptInterface::shutDownClient ()\fC [signal]\fP" +.SS "void JavascriptInterface::startDownload (const QString &filename)\fC [slot]\fP"This method start a download. +.PP +This method start a download. Can be called from inside a JavaScript function of the HTML page. Emits the JavascriptInterface::requestFile(const QString) signal. +.SS "void JavascriptInterface::trigger ()\fC [slot]\fP"This method triggers the URL load *FOR DEBUGGING/TESTING PURPOSES* +.SS "void JavascriptInterface::updateProgressBar (const int &percent, const double &speed, const QString &unit)\fC [slot]\fP"This method updates the progress bar. +.PP +This method calls a Javascript function to update the progress bar of the download. Javascript must have a function called 'updateProgress' to receive this information. +.PP +\fBTodo\fP +.RS 4 +add some more informations +.RE +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/LoggerEngine_fb.3 b/doxygen/man/man3/LoggerEngine_fb.3 new file mode 100644 index 0000000..25e80a8 --- /dev/null +++ b/doxygen/man/man3/LoggerEngine_fb.3 @@ -0,0 +1,64 @@ +.TH "LoggerEngine_fb" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +LoggerEngine_fb \- +.SH SYNOPSIS +.br +.PP +.PP +\fC#include <loggerengine.h>\fP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBLoggerEngine_fb\fP (QTextEdit *parent)" +.br +.ti -1c +.RI "\fB~LoggerEngine_fb\fP ()" +.br +.ti -1c +.RI "void \fBinitLoggerEngine\fP ()" +.br +.ti -1c +.RI "void \fBkillLoggerEngine\fP ()" +.br +.ti -1c +.RI "void \fBwriteFormatted\fP (QxtLogger::LogLevel level, const QList< QVariant > &messages)" +.br +.ti -1c +.RI "void \fBsetLogLevelEnabled\fP (QxtLogger::LogLevels level, bool enable=true)" +.br +.ti -1c +.RI "bool \fBisInitialized\fP () const " +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "QTextEdit * \fB_debugConsole\fP" +.br +.ti -1c +.RI "bool \fB_initialized\fP" +.br +.in -1c +.SH "Constructor & Destructor Documentation" +.PP +.SS "LoggerEngine_fb::LoggerEngine_fb (QTextEdit *parent)" +.SS "LoggerEngine_fb::~LoggerEngine_fb ()" +.SH "Member Function Documentation" +.PP +.SS "void LoggerEngine_fb::initLoggerEngine ()" +.SS "bool LoggerEngine_fb::isInitialized () const" +.SS "void LoggerEngine_fb::killLoggerEngine ()" +.SS "void LoggerEngine_fb::setLogLevelEnabled (QxtLogger::LogLevelslevel, boolenable = \fCtrue\fP)" +.SS "void LoggerEngine_fb::writeFormatted (QxtLogger::LogLevellevel, const QList< QVariant > &messages)" +.SH "Member Data Documentation" +.PP +.SS "QTextEdit* \fBLoggerEngine_fb::_debugConsole\fP" +.SS "bool \fBLoggerEngine_fb::_initialized\fP" + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/LoggerEngine_file.3 b/doxygen/man/man3/LoggerEngine_file.3 new file mode 100644 index 0000000..32a9f76 --- /dev/null +++ b/doxygen/man/man3/LoggerEngine_file.3 @@ -0,0 +1,38 @@ +.TH "LoggerEngine_file" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +LoggerEngine_file \- +.SH SYNOPSIS +.br +.PP +.PP +\fC#include <loggerengine.h>\fP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBLoggerEngine_file\fP (const QString &logFileName)" +.br +.ti -1c +.RI "\fB~LoggerEngine_file\fP ()" +.br +.ti -1c +.RI "void \fBinitLoggerEngine\fP ()" +.br +.ti -1c +.RI "void \fBwriteToFile\fP (const QString &level, const QList< QVariant > &msgs)" +.br +.in -1c +.SH "Constructor & Destructor Documentation" +.PP +.SS "LoggerEngine_file::LoggerEngine_file (const QString &logFileName)" +.SS "LoggerEngine_file::~LoggerEngine_file ()" +.SH "Member Function Documentation" +.PP +.SS "void LoggerEngine_file::initLoggerEngine ()" +.SS "void LoggerEngine_file::writeToFile (const QString &level, const QList< QVariant > &msgs)" + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/LoggerEngine_std.3 b/doxygen/man/man3/LoggerEngine_std.3 new file mode 100644 index 0000000..61378be --- /dev/null +++ b/doxygen/man/man3/LoggerEngine_std.3 @@ -0,0 +1,38 @@ +.TH "LoggerEngine_std" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +LoggerEngine_std \- +.SH SYNOPSIS +.br +.PP +.PP +\fC#include <loggerengine.h>\fP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBLoggerEngine_std\fP ()" +.br +.ti -1c +.RI "\fB~LoggerEngine_std\fP ()" +.br +.ti -1c +.RI "void \fBwriteToStdOut\fP (const QString &level, const QList< QVariant > &msgs)" +.br +.ti -1c +.RI "void \fBwriteToStdErr\fP (const QString &str_level, const QList< QVariant > &msgs)" +.br +.in -1c +.SH "Constructor & Destructor Documentation" +.PP +.SS "LoggerEngine_std::LoggerEngine_std ()" +.SS "LoggerEngine_std::~LoggerEngine_std ()" +.SH "Member Function Documentation" +.PP +.SS "void LoggerEngine_std::writeToStdErr (const QString &str_level, const QList< QVariant > &msgs)" +.SS "void LoggerEngine_std::writeToStdOut (const QString &level, const QList< QVariant > &msgs)" + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/NetworkDiscovery.3 b/doxygen/man/man3/NetworkDiscovery.3 new file mode 100644 index 0000000..98c1044 --- /dev/null +++ b/doxygen/man/man3/NetworkDiscovery.3 @@ -0,0 +1,282 @@ +.TH "NetworkDiscovery" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +NetworkDiscovery \- +.PP +the logic behind the \fBNetworkDiscovery\fP. + +.SH SYNOPSIS +.br +.PP +.PP +\fC#include <networkdiscovery.h>\fP +.SS "Public Slots" + +.in +1c +.ti -1c +.RI "void \fBhandleNewConnection\fP ()" +.br +.ti -1c +.RI "void \fBhandleNewInput\fP ()" +.br +.ti -1c +.RI "void \fBhandleNewInputLine\fP (QLocalSocket *client, QString data)" +.br +.ti -1c +.RI "void \fBhandleProcessFinished\fP (int exitCode, QProcess::ExitStatus exitStatus)" +.br +.ti -1c +.RI "void \fBhandleProcessStarted\fP ()" +.br +.ti -1c +.RI "void \fBhandleClientDisconnect\fP ()" +.br +.ti -1c +.RI "void \fBslotReadyForRun\fP ()" +.br +.ti -1c +.RI "void \fBcheckForIsRunning\fP ()" +.br +.in -1c +.SS "Signals" + +.in +1c +.ti -1c +.RI "void \fBaddInterface\fP (const QString &ifName)" +.br +.ti -1c +.RI "void \fBchangeProgressBarValue\fP (const QString &ifName, const int $newValue)" +.br +.ti -1c +.RI "void \fBconnectionEstablished\fP (QString ifName)" +.br +.ti -1c +.RI "void \fBabortBoot\fP (QString msg)" +.br +.ti -1c +.RI "void \fBupdateIfStatus\fP (QString ifName, QString status)" +.br +.ti -1c +.RI "void \fBupdateStatus\fP (QString status)" +.br +.ti -1c +.RI "void \fBallProcessesFinished\fP ()" +.br +.ti -1c +.RI "void \fBcontinueBoot\fP (QString ifName)" +.br +.ti -1c +.RI "void \fBcontinueBootWithoutCheck\fP (QString ifName)" +.br +.ti -1c +.RI "void \fBsetManualConfInterfaces\fP (QString jsonArr)" +.br +.ti -1c +.RI "void \fBreadyForRun\fP ()" +.br +.in -1c +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBNetworkDiscovery\fP (QObject *parent=0)" +.br +.ti -1c +.RI "\fB~NetworkDiscovery\fP ()" +.br +.ti -1c +.RI "void \fBinitAndRun\fP (QString serverIp, bool userChoice, bool autoUp, QString pathToLogFile, QString serverPath=DEFAULT_QTSOCKETADDRESS, QString pathToExe=DEFAULT_PATHTODHCPCDEXE, QStringList *args=NULL)" +.br +.ti -1c +.RI "int \fBip4_replaceDefaultRoute\fP (QString ifName, QString gateway, int mss)" +.br +.ti -1c +.RI "QString \fBgetGatewayForInterface\fP (QString ifName)" +.br +.ti -1c +.RI "int \fBip4_setManualConfiguration\fP (QVariantMap result)" +.br +.ti -1c +.RI "QString \fBreadLogFile\fP ()" +.br +.ti -1c +.RI "void \fBtryAgain\fP ()" +.br +.ti -1c +.RI "void \fBprepareTryAgain\fP ()" +.br +.ti -1c +.RI "bool \fBcheckConnectivity\fP (QString ifName)" +.br +.ti -1c +.RI "bool \fBcheckConnectivityViaTcp\fP ()" +.br +.ti -1c +.RI "QVariantMap \fBgetInterfaceConfig\fP (QString ifName)" +.br +.ti -1c +.RI "QString \fBGetErrorStr\fP ()" +.br +.in -1c +.SH "Detailed Description" +.PP +the logic behind the \fBNetworkDiscovery\fP. + +This class holds all the logic of the \fBNetworkDiscovery\fP. It's main task is to search for usable interfaces, check if they are wired (in Running state) and start a cdhcpcd process for each interface. It also sends signals to the ndgui class for presenting notifications to the user. +.SH "Constructor & Destructor Documentation" +.PP +.SS "NetworkDiscovery::NetworkDiscovery (QObject *parent = \fC0\fP)"constructor +.SS "NetworkDiscovery::~NetworkDiscovery ()"destructor +.SH "Member Function Documentation" +.PP +.SS "void NetworkDiscovery::abortBoot (QStringmsg)\fC [signal]\fP" +.SS "void NetworkDiscovery::addInterface (const QString &ifName)\fC [signal]\fP" +.SS "void NetworkDiscovery::allProcessesFinished ()\fC [signal]\fP" +.SS "void NetworkDiscovery::changeProgressBarValue (const QString &ifName, const int $newValue)\fC [signal]\fP" +.SS "bool NetworkDiscovery::checkConnectivity (QStringifName)"checks the connectivity. tries to open a TCP connection to the server (see _serverIp). For this it adjusts the routing table. (sets the gateway of the interface as default gateway) Gateway is written into the dhcpcd config file of this interface. (see DEFAULT_INTERFACE_CONF_LOCATION '/var/tmp/conf_') +.PP +\fBParameters:\fP +.RS 4 +\fIifName\fP name of a interface. +.RE +.PP +\fBReturns:\fP +.RS 4 +true: connection is possible false: connection not possible +.RE +.PP + +.SS "bool NetworkDiscovery::checkConnectivityViaTcp ()" +.SS "void NetworkDiscovery::checkForIsRunning ()\fC [slot]\fP"only called if autoUp == true. check the IsRunning flag of each interface in the _ifDownList. connected to the timeout signal of the timer. +.SS "void NetworkDiscovery::connectionEstablished (QStringifName)\fC [signal]\fP" +.SS "void NetworkDiscovery::continueBoot (QStringifName)\fC [signal]\fP" +.SS "void NetworkDiscovery::continueBootWithoutCheck (QStringifName)\fC [signal]\fP" +.SS "QString NetworkDiscovery::GetErrorStr ()" +.SS "QString NetworkDiscovery::getGatewayForInterface (QStringifName)"returns the gateway address, written into the dhcp config file. +.PP +\fBParameters:\fP +.RS 4 +\fIifName\fP name of the interface. +.RE +.PP +\fBReturns:\fP +.RS 4 +gateway address as string. or empty string if no interface config was found. +.RE +.PP + +.SS "QVariantMap NetworkDiscovery::getInterfaceConfig (QStringifName)" +.SS "void NetworkDiscovery::handleClientDisconnect ()\fC [slot]\fP"called when a client disconnects. +.SS "void NetworkDiscovery::handleNewConnection ()\fC [slot]\fP"connected to the new client arrived signal. connects the client readyRead signal with the handleNewInput slot. +.SS "void NetworkDiscovery::handleNewInput ()\fC [slot]\fP"This method is connected to the readyRead Signal of the QLocalSocket client. send an ACK to the client with every received message. +.SS "void NetworkDiscovery::handleNewInputLine (QLocalSocket *client, QStringdata)\fC [slot]\fP"This Method processes the send messages. +.PP +This Method processes the send messages. It splits the line into several components. Those components are: interface: interface name ==> indicates the process who send the message s_state: is the number representation of syslog.h LOG levels s_subState: is the number representation of the dhcp.c DHCP states (1 - 8) plus the status. h states (9 - ..) msg: is a message which can contain additional informations +.PP +According to the s_state and s_subState we emit the \fBchangeProgressBarValue()\fP signal with different values. +.PP +\fBParameters:\fP +.RS 4 +\fIclient\fP the client who send the message +.br +\fIdata\fP the message. (format <interfaceName>;<state>;<subState>;<msg> ) +.RE +.PP + +.SS "void NetworkDiscovery::handleProcessFinished (intexitCode, QProcess::ExitStatusexitStatus)\fC [slot]\fP"This Method is called when a process is finished. +.PP +This Method is called when a process is finished. This slot is connected with the signal finished() of the QProcess class. If the process finishes, it will be checked if the process exited normal or if an unexpected error occurred. For this, we determine the sender (which is a QProcess), get the corresponding interface (which is stored in a map), and check the exitCode. Further actions are taken according to the exitCode check. Normal exit: emit changeProgressBar() to 100% emit \fBupdateIfStatus()\fP to check connection \fBcheckConnectivity()\fP +.PP +\fBSee also:\fP +.RS 4 +\fBNetworkDiscovery::checkConnectivity()\fP Unexpected exit: emit \fBupdateIfStatus()\fP to process exited unexpected +.RE +.PP +\fBParameters:\fP +.RS 4 +\fIexitCode\fP +.br +\fIexitStatus\fP +.RE +.PP +\fBReturns:\fP +.RS 4 +bool returns true: if the interface name i starts with a letter in the blacklist. +.RE +.PP +returns false: else +.PP +\fBSee also:\fP +.RS 4 +NetworkDiscovery::getListOfNetworkInterfaces() +.RE +.PP + +.SS "void NetworkDiscovery::handleProcessStarted ()\fC [slot]\fP"This Method is called when a process is started. +.PP +This Method is called when a process is started. It prints the message: 'process started for interface: <interfaceName>'. +.SS "void NetworkDiscovery::initAndRun (QStringserverIp, booluserChoice, boolautoUp, QStringpathToLogFile, QStringserverPath = \fCDEFAULT_QTSOCKETADDRESS\fP, QStringpathToExe = \fCDEFAULT_PATHTODHCPCDEXE\fP, QStringList *args = \fCNULL\fP)"initialize all important class members and start the main work. +.PP +\fBParameters:\fP +.RS 4 +\fIserverIp\fP the ip of the server with which we are testing the connectivity. +.br +\fIuserChoice\fP true if the user wishes to have a user choice. true: the chooseInterfaceDialog will be showed. +.br +\fIautoUp\fP true if we want to 'auto Up' all down interfaces. +.br +\fIpathToLogFile\fP the path to the log file. +.br +\fIserverPath\fP the path to the server socket (default value: DEFAULT_QTSOCKETADDRESS '/var/tmp/qt_c_socket_default') +.br +\fIpathToExe\fP the path to the customdhcpcd exe. (default value: #define DEFAULT_QTSOCKETADDRESS '/var/tmp/qt_c_socket_default') +.br +\fIargs\fP additional arguments for the customdhcpcd client. (default value: NULL) +.RE +.PP + +.SS "int NetworkDiscovery::ip4_replaceDefaultRoute (QStringifName, QStringgateway, intmss)"replace the default route. sets af automatically to AF_INET +.PP +\fBParameters:\fP +.RS 4 +\fIifName\fP interface name +.br +\fIgateway\fP gateway address +.br +\fImss\fP mss value (i think this is the metric. in most cases this value is 0) +.RE +.PP + +.SS "int NetworkDiscovery::ip4_setManualConfiguration (QVariantMapresult)"replace the dhcp configuration with the manual config, entered by the user. if we can not establish a connection with the entered values, reset to the old dhcp values. +.PP +\fBParameters:\fP +.RS 4 +\fIresult\fP a json object formated string. +.RE +.PP +\fBReturns:\fP +.RS 4 +0 if everything ok +.RE +.PP + +.SS "void NetworkDiscovery::prepareTryAgain ()" +.SS "QString NetworkDiscovery::readLogFile ()"reads the log file. +.PP +\fBReturns:\fP +.RS 4 +the log file as one string. +.RE +.PP + +.SS "void NetworkDiscovery::readyForRun ()\fC [signal]\fP" +.SS "void NetworkDiscovery::setManualConfInterfaces (QStringjsonArr)\fC [signal]\fP" +.SS "void NetworkDiscovery::slotReadyForRun ()\fC [slot]\fP"emits the addInterface signal for each interface name in _ifUpList and calls the runDHCPCD method. if the _ifUpList is empty, this method emits an abortBoot signal. connected to the readyForRun signal. +.SS "void NetworkDiscovery::tryAgain ()" +.SS "void NetworkDiscovery::updateIfStatus (QStringifName, QStringstatus)\fC [signal]\fP" +.SS "void NetworkDiscovery::updateStatus (QStringstatus)\fC [signal]\fP" + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. 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. diff --git a/doxygen/man/man3/SysInfo.3 b/doxygen/man/man3/SysInfo.3 new file mode 100644 index 0000000..690bc64 --- /dev/null +++ b/doxygen/man/man3/SysInfo.3 @@ -0,0 +1,58 @@ +.TH "SysInfo" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SysInfo \- +.SH SYNOPSIS +.br +.PP +.PP +\fC#include <sysinfo.h>\fP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBSysInfo\fP ()" +.br +.ti -1c +.RI "\fB~SysInfo\fP ()" +.br +.ti -1c +.RI "const QString \fBgetInfo\fP (const QString &infoName)" +.br +.in -1c +.SH "Constructor & Destructor Documentation" +.PP +.SS "SysInfo::SysInfo ()"A empty constructor. +.SS "SysInfo::~SysInfo ()"A empty destructor. +.SH "Member Function Documentation" +.PP +.SS "const QString SysInfo::getInfo (const QString &infoName)"This method returns system informations. +.PP +This method returns system informations according to the parameter. This method can be called from the \fBJavascriptInterface\fP class with the method \fBJavascriptInterface::getSysInfo(const QString& info)\fP. +.PP +\fBParameters:\fP +.RS 4 +\fIinfoName\fP Is of type QString. Defines which method will be called. Possible values are: +.IP "\(bu" 2 +mbserial +.IP "\(bu" 2 +usb +.PP +.RE +.PP +\fBReturns:\fP +.RS 4 +QString the output of the called method or 'info_error' if an error occurred (e. g. invalid parameter). +.RE +.PP +\fBSee also:\fP +.RS 4 +\fBJavascriptInterface::getSysInfo(const QString& info)\fP +.RE +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/downloadmanager.cpp.3 b/doxygen/man/man3/downloadmanager.cpp.3 new file mode 100644 index 0000000..7288975 --- /dev/null +++ b/doxygen/man/man3/downloadmanager.cpp.3 @@ -0,0 +1,14 @@ +.TH "/home/niklas/workspace/fbgui/src/downloadmanager.cpp" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/downloadmanager.cpp \- +.SH SYNOPSIS +.br +.PP +\fC#include 'downloadmanager.h'\fP +.br + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/downloadmanager.h.3 b/doxygen/man/man3/downloadmanager.h.3 new file mode 100644 index 0000000..213f4c5 --- /dev/null +++ b/doxygen/man/man3/downloadmanager.h.3 @@ -0,0 +1,47 @@ +.TH "/home/niklas/workspace/fbgui/src/downloadmanager.h" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/downloadmanager.h \- +.SH SYNOPSIS +.br +.PP +\fC#include 'fbgui.h'\fP +.br + +.SS "Classes" + +.in +1c +.ti -1c +.RI "class \fBDownloadManager\fP" +.br +.in -1c +.SS "Variables" + +.in +1c +.ti -1c +.RI "bool \fBdebug\fP" +.br +.ti -1c +.RI "QUrl \fBbaseURL\fP" +.br +.ti -1c +.RI "QString \fBbinPath\fP" +.br +.ti -1c +.RI "QString \fBdownloadPath\fP" +.br +.ti -1c +.RI "int \fBupdateInterval\fP" +.br +.in -1c +.SH "Variable Documentation" +.PP +.SS "QUrl baseURL" +.SS "QString binPath" +.SS "bool \fBdebug\fP" +.SS "QString downloadPath" +.SS "int \fBupdateInterval\fP" +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/fbgui.3 b/doxygen/man/man3/fbgui.3 new file mode 100644 index 0000000..9a3fb9a --- /dev/null +++ b/doxygen/man/man3/fbgui.3 @@ -0,0 +1,49 @@ +.TH "fbgui" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +fbgui \- +.SH SYNOPSIS +.br +.PP +.PP +\fC#include <fbgui.h>\fP +.SS "Public Slots" + +.in +1c +.ti -1c +.RI "void \fBinit\fP ()" +.br +.in -1c +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBfbgui\fP ()" +.br +.ti -1c +.RI "\fB~fbgui\fP ()" +.br +.in -1c +.SH "Constructor & Destructor Documentation" +.PP +.SS "fbgui::fbgui ()"A constructor. +.PP +The constructor of the fbgui class. It initializes the main objects which are needed while the program is running. The appearance of the webView is here also defined. +.PP +\fBSee also:\fP +.RS 4 +\fBJavascriptInterface\fP +.PP +\fBDownloadManager\fP +.RE +.PP + +.SS "fbgui::~fbgui ()" +.SH "Member Function Documentation" +.PP +.SS "void fbgui::init ()\fC [slot]\fP"init function. + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/fbgui.cpp.3 b/doxygen/man/man3/fbgui.cpp.3 new file mode 100644 index 0000000..144386e --- /dev/null +++ b/doxygen/man/man3/fbgui.cpp.3 @@ -0,0 +1,86 @@ +.TH "/home/niklas/workspace/fbgui/src/fbgui.cpp" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/fbgui.cpp \- +.SH SYNOPSIS +.br +.PP +\fC#include 'fbgui.h'\fP +.br +\fC#include 'sysinfo.h'\fP +.br +\fC#include 'loggerengine.h'\fP +.br +\fC#include 'downloadmanager.h'\fP +.br +\fC#include 'javascriptinterface.h'\fP +.br +\fC#include <iostream>\fP +.br +\fC#include <QThread>\fP +.br +\fC#include <QtWebKit>\fP +.br +\fC#include <QxtCore>\fP +.br + +.SS "Functions" + +.in +1c +.ti -1c +.RI "QString \fBlogFilePath\fP ('')" +.br +.ti -1c +.RI "QString \fBipConfigFilePath\fP ('')" +.br +.ti -1c +.RI "QString \fBbinPath\fP ('')" +.br +.ti -1c +.RI "QUrl \fBbaseURL\fP ('')" +.br +.ti -1c +.RI "QString \fBdownloadPath\fP ('')" +.br +.ti -1c +.RI "QString \fBfileToTriggerURL\fP ('')" +.br +.ti -1c +.RI "QString \fBserialLocation\fP ('')" +.br +.ti -1c +.RI "QString \fBsessionID\fP ('')" +.br +.in -1c +.SS "Variables" + +.in +1c +.ti -1c +.RI "QThread \fBdmThread\fP" +.br +.ti -1c +.RI "int \fBupdateInterval\fP = -1" +.br +.ti -1c +.RI "int \fBdebugMode\fP = -1" +.br +.in -1c +.SH "Function Documentation" +.PP +.SS "QUrl baseURL ('')" +.SS "QString binPath ('')" +.SS "QString downloadPath ('')" +.SS "QString fileToTriggerURL ('')" +.SS "QString ipConfigFilePath ('')" +.SS "QString logFilePath ('')" +.SS "QString serialLocation ('')" +.SS "QString sessionID ('')" +.SH "Variable Documentation" +.PP +.SS "int \fBdebugMode\fP = -1" +.SS "QThread \fBdmThread\fP" +.SS "int \fBupdateInterval\fP = -1" +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/fbgui.h.3 b/doxygen/man/man3/fbgui.h.3 new file mode 100644 index 0000000..c53a27b --- /dev/null +++ b/doxygen/man/man3/fbgui.h.3 @@ -0,0 +1,111 @@ +.TH "/home/niklas/workspace/fbgui/src/fbgui.h" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/fbgui.h \- +.SH SYNOPSIS +.br +.PP +\fC#include <QWSServer>\fP +.br +\fC#include <QtGui>\fP +.br +\fC#include <QtWebKit>\fP +.br +\fC#include <QxtCore>\fP +.br + +.SS "Classes" + +.in +1c +.ti -1c +.RI "class \fBfbgui\fP" +.br +.in -1c +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBDEFAULT_URL\fP 'http://www.google.com'" +.br +.ti -1c +.RI "#define \fBDEFAULT_DOWNLOAD_DIR\fP '/tmp/\fBfbgui\fP'" +.br +.ti -1c +.RI "#define \fBDEFAULT_CONFIG_PATH\fP '/etc/fbgui.conf'" +.br +.ti -1c +.RI "#define \fBDEFAULT_LOG_FILE_PATH\fP '/tmp/fbgui.log'" +.br +.ti -1c +.RI "#define \fBDEFAULT_UPDATE_INTERVAL\fP 1;" +.br +.ti -1c +.RI "#define \fBDEFAULT_QRC_HTML_DIR\fP ':/html'" +.br +.ti -1c +.RI "#define \fBDEFAULT_FILE_TRIGGER\fP '/tmp/\fBfbgui\fP/trigger'" +.br +.in -1c +.SS "Variables" + +.in +1c +.ti -1c +.RI "QString \fBlogFilePath\fP" +.br +.ti -1c +.RI "QString \fBipConfigFilePath\fP" +.br +.ti -1c +.RI "QThread \fBdmThread\fP" +.br +.ti -1c +.RI "QString \fBserialLocation\fP" +.br +.ti -1c +.RI "QString \fBfileToTriggerURL\fP" +.br +.ti -1c +.RI "QString \fBsessionID\fP" +.br +.ti -1c +.RI "QString \fBbinPath\fP" +.br +.ti -1c +.RI "QString \fBdownloadPath\fP" +.br +.ti -1c +.RI "QUrl \fBbaseURL\fP" +.br +.ti -1c +.RI "int \fBdebugMode\fP" +.br +.ti -1c +.RI "int \fBupdateInterval\fP" +.br +.in -1c +.SH "Define Documentation" +.PP +.SS "#define DEFAULT_CONFIG_PATH '/etc/fbgui.conf'" +.SS "#define DEFAULT_DOWNLOAD_DIR '/tmp/\fBfbgui\fP'" +.SS "#define DEFAULT_FILE_TRIGGER '/tmp/\fBfbgui\fP/trigger'" +.SS "#define DEFAULT_LOG_FILE_PATH '/tmp/fbgui.log'" +.SS "#define DEFAULT_QRC_HTML_DIR ':/html'" +.SS "#define DEFAULT_UPDATE_INTERVAL 1;" +.SS "#define DEFAULT_URL 'http://www.google.com'" +.SH "Variable Documentation" +.PP +.SS "QUrl baseURL" +.SS "QString binPath" +.SS "int \fBdebugMode\fP" +.SS "QThread \fBdmThread\fP" +.SS "QString downloadPath" +.SS "QString fileToTriggerURL" +.SS "QString ipConfigFilePath" +.SS "QString logFilePath" +.SS "QString serialLocation" +.SS "QString sessionID" +.SS "int \fBupdateInterval\fP" +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/interfaceconfiguration.3 b/doxygen/man/man3/interfaceconfiguration.3 new file mode 100644 index 0000000..d13b7a6 --- /dev/null +++ b/doxygen/man/man3/interfaceconfiguration.3 @@ -0,0 +1,123 @@ +.TH "interfaceconfiguration" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +interfaceconfiguration \- +.PP +reads and stores a interface configuration. + +.SH SYNOPSIS +.br +.PP +.PP +\fC#include <interfaceconfiguration.h>\fP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBinterfaceconfiguration\fP ()" +.br +.ti -1c +.RI "\fBinterfaceconfiguration\fP (const \fBinterfaceconfiguration\fP &other)" +.br +.ti -1c +.RI "\fBinterfaceconfiguration\fP & \fBoperator=\fP (const \fBinterfaceconfiguration\fP &other)" +.br +.ti -1c +.RI "virtual \fB~interfaceconfiguration\fP ()" +.br +.ti -1c +.RI "bool \fBreadConfigOutOfFile\fP (QString pathToConfig)" +.br +.ti -1c +.RI "QString \fBgetBroadcast\fP ()" +.br +.ti -1c +.RI "QString \fBgetClientid\fP ()" +.br +.ti -1c +.RI "QString \fBgetDhcpchaddr\fP ()" +.br +.ti -1c +.RI "QString \fBgetDhcpsid\fP ()" +.br +.ti -1c +.RI "QString \fBgetDnssearch\fP ()" +.br +.ti -1c +.RI "QString \fBgetDnsservers\fP ()" +.br +.ti -1c +.RI "QString \fBgetGateways\fP ()" +.br +.ti -1c +.RI "QString \fBgetGateway\fP ()" +.br +.ti -1c +.RI "QString \fBgetHostname\fP ()" +.br +.ti -1c +.RI "QString \fBgetInterface\fP ()" +.br +.ti -1c +.RI "QString \fBgetIpAddress\fP ()" +.br +.ti -1c +.RI "QString \fBgetNetmask\fP ()" +.br +.ti -1c +.RI "QString \fBgetNetwork\fP ()" +.br +.ti -1c +.RI "QString \fBgetRoutes\fP ()" +.br +.in -1c +.SH "Detailed Description" +.PP +reads and stores a interface configuration. + +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 +reads and stores a interface configuration. the config file has already to exist. It is created by the cdhcpcd client process. +.SH "Constructor & Destructor Documentation" +.PP +.SS "interfaceconfiguration::interfaceconfiguration ()" +.SS "interfaceconfiguration::interfaceconfiguration (const \fBinterfaceconfiguration\fP &other)" +.SS "interfaceconfiguration::~interfaceconfiguration ()\fC [virtual]\fP" +.SH "Member Function Documentation" +.PP +.SS "QString interfaceconfiguration::getBroadcast ()" +.SS "QString interfaceconfiguration::getClientid ()" +.SS "QString interfaceconfiguration::getDhcpchaddr ()" +.SS "QString interfaceconfiguration::getDhcpsid ()" +.SS "QString interfaceconfiguration::getDnssearch ()" +.SS "QString interfaceconfiguration::getDnsservers ()" +.SS "QString interfaceconfiguration::getGateway ()" +.SS "QString interfaceconfiguration::getGateways ()" +.SS "QString interfaceconfiguration::getHostname ()" +.SS "QString interfaceconfiguration::getInterface ()" +.SS "QString interfaceconfiguration::getIpAddress ()" +.SS "QString interfaceconfiguration::getNetmask ()" +.SS "QString interfaceconfiguration::getNetwork ()" +.SS "QString interfaceconfiguration::getRoutes ()" +.SS "\fBinterfaceconfiguration\fP& interfaceconfiguration::operator= (const \fBinterfaceconfiguration\fP &other)" +.SS "bool interfaceconfiguration::readConfigOutOfFile (QStringpathToConfig)"This method reads the configuration values out of a file. +.PP +This method reads the configuration values out of a file. The file has to be created before by the customdhcpcd QProcess. (Overwrites the old values if they are already present.) +.PP +\fBParameters:\fP +.RS 4 +\fIpathToConfig\fP contains the path to the configuration file. +.RE +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/interfaceconfiguration.cpp.3 b/doxygen/man/man3/interfaceconfiguration.cpp.3 new file mode 100644 index 0000000..a78f7ad --- /dev/null +++ b/doxygen/man/man3/interfaceconfiguration.cpp.3 @@ -0,0 +1,14 @@ +.TH "/home/niklas/workspace/fbgui/src/interfaceconfiguration.cpp" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/interfaceconfiguration.cpp \- +.SH SYNOPSIS +.br +.PP +\fC#include 'interfaceconfiguration.h'\fP +.br + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/interfaceconfiguration.h.3 b/doxygen/man/man3/interfaceconfiguration.h.3 new file mode 100644 index 0000000..a2646e5 --- /dev/null +++ b/doxygen/man/man3/interfaceconfiguration.h.3 @@ -0,0 +1,22 @@ +.TH "/home/niklas/workspace/fbgui/src/interfaceconfiguration.h" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/interfaceconfiguration.h \- +.SH SYNOPSIS +.br +.PP +\fC#include <QtCore>\fP +.br + +.SS "Classes" + +.in +1c +.ti -1c +.RI "class \fBinterfaceconfiguration\fP" +.br +.RI "\fIreads and stores a interface configuration. \fP" +.in -1c +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/javascriptinterface.cpp.3 b/doxygen/man/man3/javascriptinterface.cpp.3 new file mode 100644 index 0000000..3a1ef39 --- /dev/null +++ b/doxygen/man/man3/javascriptinterface.cpp.3 @@ -0,0 +1,18 @@ +.TH "/home/niklas/workspace/fbgui/src/javascriptinterface.cpp" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/javascriptinterface.cpp \- +.SH SYNOPSIS +.br +.PP +\fC#include 'fbgui.h'\fP +.br +\fC#include 'javascriptinterface.h'\fP +.br +\fC#include 'sysinfo.h'\fP +.br + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/javascriptinterface.h.3 b/doxygen/man/man3/javascriptinterface.h.3 new file mode 100644 index 0000000..2a85d3c --- /dev/null +++ b/doxygen/man/man3/javascriptinterface.h.3 @@ -0,0 +1,21 @@ +.TH "/home/niklas/workspace/fbgui/src/javascriptinterface.h" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/javascriptinterface.h \- +.SH SYNOPSIS +.br +.PP +\fC#include 'fbgui.h'\fP +.br + +.SS "Classes" + +.in +1c +.ti -1c +.RI "class \fBJavascriptInterface\fP" +.br +.in -1c +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/loggerengine.cpp.3 b/doxygen/man/man3/loggerengine.cpp.3 new file mode 100644 index 0000000..4765651 --- /dev/null +++ b/doxygen/man/man3/loggerengine.cpp.3 @@ -0,0 +1,14 @@ +.TH "/home/niklas/workspace/fbgui/src/loggerengine.cpp" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/loggerengine.cpp \- +.SH SYNOPSIS +.br +.PP +\fC#include 'loggerengine.h'\fP +.br + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/loggerengine.h.3 b/doxygen/man/man3/loggerengine.h.3 new file mode 100644 index 0000000..ee3b01f --- /dev/null +++ b/doxygen/man/man3/loggerengine.h.3 @@ -0,0 +1,31 @@ +.TH "/home/niklas/workspace/fbgui/src/loggerengine.h" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/loggerengine.h \- +.SH SYNOPSIS +.br +.PP +\fC#include <QxtCore>\fP +.br +\fC#include <QTime>\fP +.br +\fC#include <QTextEdit>\fP +.br + +.SS "Classes" + +.in +1c +.ti -1c +.RI "class \fBLoggerEngine_fb\fP" +.br +.ti -1c +.RI "class \fBLoggerEngine_std\fP" +.br +.ti -1c +.RI "class \fBLoggerEngine_file\fP" +.br +.in -1c +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/main.cpp.3 b/doxygen/man/man3/main.cpp.3 new file mode 100644 index 0000000..6d2ad30 --- /dev/null +++ b/doxygen/man/man3/main.cpp.3 @@ -0,0 +1,46 @@ +.TH "/home/niklas/workspace/fbgui/src/main.cpp" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/main.cpp \- +.SH SYNOPSIS +.br +.PP +\fC#include <QApplication>\fP +.br +\fC#include <QSettings>\fP +.br +\fC#include <QtCore>\fP +.br +\fC#include <getopt.h>\fP +.br +\fC#include <cstdlib>\fP +.br +\fC#include <iostream>\fP +.br +\fC#include 'loggerengine.h'\fP +.br +\fC#include 'fbgui.h'\fP +.br +\fC#include 'ndgui.h'\fP +.br +\fC#include '../common/fbgui.h'\fP +.br + +.SS "Functions" + +.in +1c +.ti -1c +.RI "void \fBprintHelp\fP ()" +.br +.ti -1c +.RI "int \fBmain\fP (int argc, char *argv[])" +.br +.in -1c +.SH "Function Documentation" +.PP +.SS "int main (intargc, char *argv[])" +.SS "void printHelp ()" +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/ndgui.3 b/doxygen/man/man3/ndgui.3 new file mode 100644 index 0000000..1290adb --- /dev/null +++ b/doxygen/man/man3/ndgui.3 @@ -0,0 +1,248 @@ +.TH "ndgui" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ndgui \- +.PP +the GUI. + +.SH SYNOPSIS +.br +.PP +.PP +\fC#include <ndgui.h>\fP +.SS "Public Slots" + +.in +1c +.ti -1c +.RI "void \fBhandleConnectionEstablished\fP (QString ifName)" +.br +.RI "\fIhandle if a interface is able to connect \fP" +.ti -1c +.RI "void \fBabortBoot\fP (QString msg)" +.br +.RI "\fIshow abortBoot dialog \fP" +.ti -1c +.RI "void \fBchooseInterfaceDialog\fP (QString msg)" +.br +.RI "\fIopens ths chooseInterfaceDialog \fP" +.ti -1c +.RI "void \fBhandleAllProcessesFinished\fP ()" +.br +.RI "\fIdetermines if we continue the boot sequence or if we show the chooseInterface or abortBoot dialog \fP" +.ti -1c +.RI "void \fBrestartSystem\fP ()" +.br +.RI "\fIrestart the system \fP" +.ti -1c +.RI "void \fBshutDownSystem\fP ()" +.br +.RI "\fIshut down the system \fP" +.ti -1c +.RI "void \fBcontinueBoot\fP (QString ifName)" +.br +.RI "\fIcontinue the boot sequence \fP" +.ti -1c +.RI "void \fBcontinueBootWithoutCheck\fP (QString ifName)" +.br +.RI "\fIcontinue the boot sequence without further checking if the connection is still possible. \fP" +.ti -1c +.RI "void \fBtryAgain\fP ()" +.br +.RI "\fIstarts the whole application again. \fP" +.ti -1c +.RI "void \fBstartSingleShot\fP ()" +.br +.RI "\fIstarts a singleshot event. \fP" +.ti -1c +.RI "void \fBstartNetworkDiscovery\fP ()" +.br +.RI "\fIstart the network discovery \fP" +.ti -1c +.RI "void \fBattachToDOM\fP ()" +.br +.RI "\fIstellt ein ndgui/fbgui Objekt zur verwendung durch die html bereit. \fP" +.ti -1c +.RI "void \fBloadJQuery\fP ()" +.br +.RI "\fIload jQuery and js scripts into the page so that all javascript functions will work. \fP" +.ti -1c +.RI "void \fBaddInterface\fP (const QString &ifName)" +.br +.RI "\fIadds an interface to the DOM tree. Creates its progress bar and it's status label. \fP" +.ti -1c +.RI "void \fBupdateIfStatus\fP (const QString &ifName, const QString &status)" +.br +.RI "\fIupdate the status for each interface \fP" +.ti -1c +.RI "void \fBupdateStatus\fP (const QString &status)" +.br +.RI "\fIupdates the over all status \fP" +.ti -1c +.RI "void \fBupdateIfProgressBar\fP (const QString &ifName, const int &percent)" +.br +.RI "\fIupdates the progress bar for each interface. \fP" +.ti -1c +.RI "void \fBnotifyCall\fP (QString msg)" +.br +.RI "\fIjust for debugging. \fP" +.in -1c +.SS "Signals" + +.in +1c +.ti -1c +.RI "void \fBinitFbgui\fP ()" +.br +.in -1c +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBndgui\fP (QMainWindow *parent=0)" +.br +.ti -1c +.RI "\fB~ndgui\fP ()" +.br +.ti -1c +.RI "Q_INVOKABLE QVariantList \fBgetManualConfInterfaces\fP ()" +.br +.RI "\fIfills the drop down box of the manual interface configuration dialog. \fP" +.ti -1c +.RI "Q_INVOKABLE int \fBip4_setManualConfiguration\fP (QVariantMap result)" +.br +.RI "\fItakes the entered manual configuration dates and delivers it to the networkDiscovery for further actions. \fP" +.ti -1c +.RI "Q_INVOKABLE QString \fBreadLogFile\fP ()" +.br +.RI "\fIread the log file. Log File will be presented inside of a dialog. \fP" +.ti -1c +.RI "Q_INVOKABLE QVariantMap \fBgetInterfaceConf\fP (QString ifName)" +.br +.RI "\fIreturn a json formated interface configuration \fP" +.in -1c +.SH "Detailed Description" +.PP +the GUI. + +This class is responsible for creating and displaying the user interface. It also connects the webView via QWebBridge to javascript functions inside the html files. +.SH "Constructor & Destructor Documentation" +.PP +.SS "ndgui::ndgui (QMainWindow *parent = \fC0\fP)"constructor +.SS "ndgui::~ndgui ()"destructor +.SH "Member Function Documentation" +.PP +.SS "void ndgui::abortBoot (QStringmsg)\fC [slot]\fP" +.PP +show abortBoot dialog \fBParameters:\fP +.RS 4 +\fImsg\fP the message, displayed in the dialog. +.RE +.PP + +.SS "void ndgui::addInterface (const QString &ifName)\fC [slot]\fP" +.PP +adds an interface to the DOM tree. Creates its progress bar and it's status label. \fBParameters:\fP +.RS 4 +\fIifName\fP name of the new interface. +.RE +.PP + +.SS "void ndgui::attachToDOM ()\fC [slot]\fP" +.PP +stellt ein ndgui/fbgui Objekt zur verwendung durch die html bereit. +.SS "void ndgui::chooseInterfaceDialog (QStringmsg)\fC [slot]\fP" +.PP +opens ths chooseInterfaceDialog \fBParameters:\fP +.RS 4 +\fImsg\fP the interfaces as json formated string. will be displayed in a select box. +.RE +.PP + +.SS "void ndgui::continueBoot (QStringifName)\fC [slot]\fP" +.PP +continue the boot sequence represents the end of the \fBNetworkDiscovery\fP life time. will start the fbgui screen. All networkDiscovery signals will be ignored after this point. +.SS "void ndgui::continueBootWithoutCheck (QStringifName)\fC [slot]\fP" +.PP +continue the boot sequence without further checking if the connection is still possible. +.SS "QVariantMap ndgui::getInterfaceConf (QStringifName)" +.PP +return a json formated interface configuration \fBParameters:\fP +.RS 4 +\fIifName\fP the name of the interface +.RE +.PP + +.SS "QVariantList ndgui::getManualConfInterfaces ()" +.PP +fills the drop down box of the manual interface configuration dialog. +.SS "void ndgui::handleAllProcessesFinished ()\fC [slot]\fP" +.PP +determines if we continue the boot sequence or if we show the chooseInterface or abortBoot dialog if we have a user choice (_userChoice = true) than networkDiscovery will emit a allProcessesFinished signal if all processes are done. This method determines if user will see an abort boot dialog (no interface names in the ifNameList list) or an choose interface dialog (one or more interface names in the list (add with handleConnectionEstablished)). +.SS "void ndgui::handleConnectionEstablished (QStringifName)\fC [slot]\fP" +.PP +handle if a interface is able to connect if we have a user choice (_userChoice = true) than networkDiscovery will emit connectionEstablished signals. Add the interface name to a _ifNameList. This list holds all interfaces the user can choose out of. +.SS "void ndgui::initFbgui ()\fC [signal]\fP" +.SS "int ndgui::ip4_setManualConfiguration (QVariantMapjsonArr)" +.PP +takes the entered manual configuration dates and delivers it to the networkDiscovery for further actions. \fBParameters:\fP +.RS 4 +\fIjsonArr\fP a jsonArr which contains the manual entered interface configuration +.RE +.PP + +.SS "void ndgui::loadJQuery ()\fC [slot]\fP" +.PP +load jQuery and js scripts into the page so that all javascript functions will work. +.SS "void ndgui::notifyCall (QStringmsg)\fC [slot]\fP" +.PP +just for debugging. +.SS "QString ndgui::readLogFile ()" +.PP +read the log file. Log File will be presented inside of a dialog. +.SS "void ndgui::restartSystem ()\fC [slot]\fP" +.PP +restart the system this method will restart the system. triggered through a button click in the gui. +.SS "void ndgui::shutDownSystem ()\fC [slot]\fP" +.PP +shut down the system this method will restart the system. triggered through a button click in the gui. +.SS "void ndgui::startNetworkDiscovery ()\fC [slot]\fP" +.PP +start the network discovery main starting point of the whole procedure. disconnect the loadFinished signal with the startNetworkDiscovery and starts the networkDiscovery. +.SS "void ndgui::startSingleShot ()\fC [slot]\fP" +.PP +starts a singleshot event. is connected to the singleShot event. Triggering this method means that we go on with the main \fBNetworkDiscovery\fP screen. connects the loadFinished signal of the _webView with the startNetworkDiscovery slot and removes the action. +.SS "void ndgui::tryAgain ()\fC [slot]\fP" +.PP +starts the whole application again. +.SS "void ndgui::updateIfProgressBar (const QString &ifName, const int &percent)\fC [slot]\fP" +.PP +updates the progress bar for each interface. \fBParameters:\fP +.RS 4 +\fIifname\fP the name ot the interface to update +.br +\fIpercent\fP the progress in percent +.RE +.PP + +.SS "void ndgui::updateIfStatus (const QString &ifName, const QString &status)\fC [slot]\fP" +.PP +update the status for each interface \fBParameters:\fP +.RS 4 +\fIifName\fP the name ot the interface to update +.br +\fIstatus\fP the new status of the interface. +.RE +.PP + +.SS "void ndgui::updateStatus (const QString &status)\fC [slot]\fP" +.PP +updates the over all status \fBParameters:\fP +.RS 4 +\fIstatus\fP the new status message +.RE +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/ndgui.cpp.3 b/doxygen/man/man3/ndgui.cpp.3 new file mode 100644 index 0000000..a3968a7 --- /dev/null +++ b/doxygen/man/man3/ndgui.cpp.3 @@ -0,0 +1,42 @@ +.TH "/home/niklas/workspace/fbgui/src/ndgui.cpp" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/ndgui.cpp \- +.SH SYNOPSIS +.br +.PP +\fC#include 'ndgui.h'\fP +.br + +.SS "Functions" + +.in +1c +.ti -1c +.RI "QString \fBgServerIp\fP ('')" +.br +.ti -1c +.RI "QString \fBgSocketServerPath\fP ('')" +.br +.ti -1c +.RI "QString \fBgPathToDhcpExe\fP ('')" +.br +.in -1c +.SS "Variables" + +.in +1c +.ti -1c +.RI "bool \fBgAutoUp\fP = true" +.br +.in -1c +.SH "Function Documentation" +.PP +.SS "QString gPathToDhcpExe ('')" +.SS "QString gServerIp ('')" +.SS "QString gSocketServerPath ('')" +.SH "Variable Documentation" +.PP +.SS "bool \fBgAutoUp\fP = true" +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/ndgui.h.3 b/doxygen/man/man3/ndgui.h.3 new file mode 100644 index 0000000..493dfa0 --- /dev/null +++ b/doxygen/man/man3/ndgui.h.3 @@ -0,0 +1,60 @@ +.TH "/home/niklas/workspace/fbgui/src/ndgui.h" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/ndgui.h \- +.SH SYNOPSIS +.br +.PP +\fC#include <QtGui>\fP +.br +\fC#include <QtWebKit>\fP +.br +\fC#include <QVariant>\fP +.br +\fC#include 'fbgui.h'\fP +.br +\fC#include 'loggerengine.h'\fP +.br +\fC#include 'networkdiscovery.h'\fP +.br + +.SS "Classes" + +.in +1c +.ti -1c +.RI "class \fBndgui\fP" +.br +.RI "\fIthe GUI. \fP" +.in -1c +.SS "Variables" + +.in +1c +.ti -1c +.RI "QString \fBgServerIp\fP" +.br +.ti -1c +.RI "bool \fBgAutoUp\fP" +.br +.ti -1c +.RI "QString \fBgSocketServerPath\fP" +.br +.ti -1c +.RI "QString \fBgPathToDhcpExe\fP" +.br +.in -1c +.SH "Variable Documentation" +.PP +.SS "bool \fBgAutoUp\fP" +.SS "QString gPathToDhcpExe" +.SS "QString gServerIp"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 +.SS "QString gSocketServerPath" +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/networkdiscovery.cpp.3 b/doxygen/man/man3/networkdiscovery.cpp.3 new file mode 100644 index 0000000..8db066e --- /dev/null +++ b/doxygen/man/man3/networkdiscovery.cpp.3 @@ -0,0 +1,18 @@ +.TH "/home/niklas/workspace/fbgui/src/networkdiscovery.cpp" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/networkdiscovery.cpp \- +.SH SYNOPSIS +.br +.PP +\fC#include <sys/types.h>\fP +.br +\fC#include <signal.h>\fP +.br +\fC#include 'networkdiscovery.h'\fP +.br + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/networkdiscovery.h.3 b/doxygen/man/man3/networkdiscovery.h.3 new file mode 100644 index 0000000..6de4ade --- /dev/null +++ b/doxygen/man/man3/networkdiscovery.h.3 @@ -0,0 +1,64 @@ +.TH "/home/niklas/workspace/fbgui/src/networkdiscovery.h" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/networkdiscovery.h \- +.SH SYNOPSIS +.br +.PP +\fC#include <QtNetwork>\fP +.br +\fC#include <QtCore>\fP +.br +\fC#include <arpa/inet.h>\fP +.br +\fC#include <stdio.h>\fP +.br +\fC#include <unistd.h>\fP +.br +\fC#include <string.h>\fP +.br +\fC#include <stdlib.h>\fP +.br +\fC#include <syslog.h>\fP +.br +\fC#include <sysfs/libsysfs.h>\fP +.br +\fC#include 'loggerengine.h'\fP +.br +\fC#include 'interfaceconfiguration.h'\fP +.br +\fC#include 'networkmanager.h'\fP +.br +\fC#include 'dhcp.h'\fP +.br +\fC#include '../common/fbgui.h'\fP +.br + +.SS "Classes" + +.in +1c +.ti -1c +.RI "class \fBNetworkDiscovery\fP" +.br +.RI "\fIthe logic behind the \fBNetworkDiscovery\fP. \fP" +.in -1c +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBDEFAULT_PATHTODHCPCDEXE\fP '/bin/cdhcpcd'" +.br +.in -1c +.SH "Define Documentation" +.PP +.SS "#define DEFAULT_PATHTODHCPCDEXE '/bin/cdhcpcd'"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 +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/networkmanager.cpp.3 b/doxygen/man/man3/networkmanager.cpp.3 new file mode 100644 index 0000000..9aee66e --- /dev/null +++ b/doxygen/man/man3/networkmanager.cpp.3 @@ -0,0 +1,14 @@ +.TH "/home/niklas/workspace/fbgui/src/networkmanager.cpp" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/networkmanager.cpp \- +.SH SYNOPSIS +.br +.PP +\fC#include 'networkmanager.h'\fP +.br + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/networkmanager.h.3 b/doxygen/man/man3/networkmanager.h.3 new file mode 100644 index 0000000..5c75b31 --- /dev/null +++ b/doxygen/man/man3/networkmanager.h.3 @@ -0,0 +1,42 @@ +.TH "/home/niklas/workspace/fbgui/src/networkmanager.h" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/networkmanager.h \- +.SH SYNOPSIS +.br +.PP +\fC#include <arpa/inet.h>\fP +.br +\fC#include <net/if.h>\fP +.br +\fC#include <netlink/netlink.h>\fP +.br +\fC#include <netlink/netlink-kernel.h>\fP +.br +\fC#include <netlink/route/addr.h>\fP +.br +\fC#include <netlink/route/rtnl.h>\fP +.br +\fC#include <netlink/route/route.h>\fP +.br +\fC#include <netlink/route/link.h>\fP +.br +\fC#include <errno.h>\fP +.br +\fC#include <QtCore>\fP +.br +\fC#include <QNetworkAddressEntry>\fP +.br + +.SS "Classes" + +.in +1c +.ti -1c +.RI "class \fBNetworkManager\fP" +.br +.RI "\fIManages the network configurations like setting new default routes. \fP" +.in -1c +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/sysinfo.cpp.3 b/doxygen/man/man3/sysinfo.cpp.3 new file mode 100644 index 0000000..d243bc9 --- /dev/null +++ b/doxygen/man/man3/sysinfo.cpp.3 @@ -0,0 +1,14 @@ +.TH "/home/niklas/workspace/fbgui/src/sysinfo.cpp" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/sysinfo.cpp \- +.SH SYNOPSIS +.br +.PP +\fC#include 'sysinfo.h'\fP +.br + +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/sysinfo.h.3 b/doxygen/man/man3/sysinfo.h.3 new file mode 100644 index 0000000..0688e57 --- /dev/null +++ b/doxygen/man/man3/sysinfo.h.3 @@ -0,0 +1,25 @@ +.TH "/home/niklas/workspace/fbgui/src/sysinfo.h" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +/home/niklas/workspace/fbgui/src/sysinfo.h \- +.SH SYNOPSIS +.br +.PP +\fC#include 'sysfs/libsysfs.h'\fP +.br +\fC#include <libusb-1.0/libusb.h>\fP +.br +\fC#include 'fbgui.h'\fP +.br + +.SS "Classes" + +.in +1c +.ti -1c +.RI "class \fBSysInfo\fP" +.br +.in -1c +.SH "Author" +.PP +Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code. diff --git a/doxygen/man/man3/todo.3 b/doxygen/man/man3/todo.3 new file mode 100644 index 0000000..899f1b0 --- /dev/null +++ b/doxygen/man/man3/todo.3 @@ -0,0 +1,23 @@ +.TH "todo" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +todo \- .TH "todo" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*- +.ad l +.nh +.SH NAME +todo \- +.IP "\fBMember \fBJavascriptInterface::downloadInfo\fP(const QString &filename, const double &filesize) \fP" 1c +add some more informations +.PP +.PP + +.IP "\fBMember \fBJavascriptInterface::setCallbackOnFinished\fP(const QString &function) \fP" 1c +add some more informations +.PP +.PP + +.IP "\fBMember \fBJavascriptInterface::updateProgressBar\fP(const int &percent, const double &speed, const QString &unit) \fP" 1c +add some more informations +.PP + |