some comments to the LogReceiver methods

1 files changed, 34 insertions, 0 deletions

diff --git a/LogReceiver/logreceiver.cpp b/LogReceiver/logreceiver.cpp
index f618e90..1e3f388 100644
--- a/LogReceiver/logreceiver.cpp
+++ b/LogReceiver/logreceiver.cpp
@@ -316,6 +316,9 @@ void LogReceiver::checkInternetConnectionViaTCP(QString ifName) {
 	session->close();
 }
 
+/**
+ *
+ */
 void LogReceiver::handleNewConnection() {
 	qDebug() << "New Connection arrived";
 
@@ -327,6 +330,9 @@ void LogReceiver::handleNewConnection() {
 	connect(client, SIGNAL(readyRead()), this, SLOT(handleNewInput()));
 }
 
+/**
+ *
+ */
 void LogReceiver::handleClientDisconnect() {
 	QLocalSocket* socket = qobject_cast<QLocalSocket *> (QObject::sender());
 
@@ -337,6 +343,9 @@ void LogReceiver::handleClientDisconnect() {
 	client->deleteLater();
 }
 
+/**
+ *
+ */
 void LogReceiver::handleNewInput(QLocalSocket * client) {
 	qDebug() << "last read before exit";
 	while (client->canReadLine()) {
@@ -352,6 +361,9 @@ void LogReceiver::handleNewInput(QLocalSocket * client) {
 	}
 }
 
+/**
+ *
+ */
 void LogReceiver::handleNewInput() {
 	QLocalSocket* socket = qobject_cast<QLocalSocket *> (QObject::sender());
 
@@ -381,6 +393,28 @@ void LogReceiver::handleNewInput() {
 	*/
 }
 
+/**
+ * This Method processes the send messages.
+ *
+ * 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
+ *
+ * According to the s_state and s_subState we emit the changeProgressBarValue() signal
+ * with different values.
+ *
+ * @param client
+ *  the client who send the message
+ *
+ * @param data
+ *  the message. (format <interfaceName>;<state>;<subState>;<msg> )
+ *
+ *
+ */
 void LogReceiver::handleNewInputLine(QLocalSocket * client, QString data) {
 
 	QString logMsg(data);