* updated license headers

* updated documentation

1 files changed, 49 insertions, 55 deletions

diff --git a/AudioManagerDaemon/include/CAmTelnetServer.h b/AudioManagerDaemon/include/CAmTelnetServer.h
index f7bf274..32701a2 100644
--- a/AudioManagerDaemon/include/CAmTelnetServer.h
+++ b/AudioManagerDaemon/include/CAmTelnetServer.h
@@ -1,34 +1,33 @@
 /**
- * Copyright (C) 2011, BMW AG
+ * Copyright (C) 2012, GENIVI Alliance, Inc.
+ * Copyright (C) 2012, BMW AG
  *
- * GeniviAudioMananger AudioManagerDaemon
+ * This file is part of GENIVI Project AudioManager.
  *
- * \file CAmTelnetServer.h
+ * Contributions are licensed to the GENIVI Alliance under one or more
+ * Contribution License Agreements.
+ *
+ * \copyright
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed with
+ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
  *
- * \date 20-Oct-2011 3:42:04 PM
- * \author Christian Mueller (christian.ei.mueller@bmw.de)
  *
- * \section License
- * GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
- * Copyright (C) 2011, BMW AG Christian Mueller  Christian.ei.mueller@bmw.de
+ * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Frank Herchet, frank.fh.herchet@bmw.de BMW 2012
  *
- * This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
- * This program 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, version 2.1, for more details.
- * You should have received a copy of the GNU Lesser General Public License, version 2.1, along with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
- * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may also be applicable to programs even in cases in which the program is not a library in the technical sense.
- * Linking AudioManager statically or dynamically with other modules is making a combined work based on AudioManager. You may license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to license your linked modules under the GNU Lesser General Public License, version 2.1, you may use the program under the following exception.
- * As a special exception, the copyright holders of AudioManager give you permission to combine AudioManager with software programs or libraries that are released under any license unless such a combination is not permitted by the license of such a software program or library. You may copy and distribute such a system following the terms of the GNU Lesser General Public License, version 2.1, including this special exception, for AudioManager and the licenses of the other code concerned.
- * Note that people who make modified versions of AudioManager are not obligated to grant this special exception for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, version 2.1, gives permission to release a modified version without this exception; this exception also makes it possible to release a modified version which carries forward this exception.
+ * \file CAmTelnetServer.h
+ * For further information see http://www.genivi.org/.
  *
  */
 
 #ifndef TELNETSERVER_H_
 #define TELNETSERVER_H_
 
-#include "shared/CAmSocketHandler.h"
-#include "CAmTelnetMenuHelper.h"
 #include <queue>
 #include <map>
+#include "shared/CAmSocketHandler.h"
+#include "CAmTelnetMenuHelper.h"
 
 namespace am
 {
@@ -43,21 +42,16 @@ class CAmControlReceiver;
 class CAmRouter;
 class CAmTelnetMenuHelper;
 
+/**
+ * Implements a telnetserver that can be used to connect to the audiomanager, retrieve some information and use it. For debugginp purposes.
+ * For example, launch a telnet session on port 6060:
+ * \code telnet localhost 6060 \endcode
+ *  more details can be found at the README
+ */
 class CAmTelnetServer
 {
 public:
-    CAmTelnetServer(CAmSocketHandler *iSocketHandler,
-                 CAmCommandSender *iCommandSender,
-                 CAmCommandReceiver *iCommandReceiver,
-                 CAmRoutingSender *iRoutingSender,
-                 CAmRoutingReceiver *iRoutingReceiver,
-                 CAmControlSender *iControlSender,
-                 CAmControlReceiver *iControlReceiver,
-                 CAmDatabaseHandler *iDatabasehandler,
-                 CAmRouter *iRouter,
-                 unsigned int servPort,
-                 unsigned int maxConnections);
-
+    CAmTelnetServer(CAmSocketHandler *iSocketHandler, CAmCommandSender *iCommandSender, CAmCommandReceiver *iCommandReceiver, CAmRoutingSender *iRoutingSender, CAmRoutingReceiver *iRoutingReceiver, CAmControlSender *iControlSender, CAmControlReceiver *iControlReceiver, CAmDatabaseHandler *iDatabasehandler, CAmRouter *iRouter, unsigned int servPort, unsigned int maxConnections);
     ~CAmTelnetServer();
     void connectSocket(const pollfd pfd, const sh_pollHandle_t handle, void* userData);
     void disconnectClient(int filedescriptor);
@@ -70,34 +64,34 @@ public:
     TAmShPollCheck<CAmTelnetServer> telnetCheckCB;
 private:
 
-	typedef void (*CommandPrototype)(std::vector<std::string>& msg,int filedescriptor);
-	typedef std::map<std::string,CommandPrototype> mMapCommand_t;
+    typedef void (*CommandPrototype)(std::vector<std::string>& msg, int filedescriptor);
+    typedef std::map<std::string, CommandPrototype> mMapCommand_t;
 
-	void sliceCommand(const std::string& string,std::string& command,std::queue<std::string>& msg);
-	mMapCommand_t createCommandMap();
-	struct connection_s
-	{
-		int filedescriptor;
-		sh_pollHandle_t handle;
-	};
+    void sliceCommand(const std::string& string, std::string& command, std::queue<std::string>& msg);
+    mMapCommand_t createCommandMap();
+    struct connection_s
+    {
+        int filedescriptor;
+        sh_pollHandle_t handle;
+    };
 
-	static CAmTelnetServer* instance;
-	CAmSocketHandler *mSocketHandler;
-	CAmCommandSender *mCommandSender;
-	CAmCommandReceiver *mCommandReceiver;
-	CAmRoutingSender *mRoutingSender;
-	CAmRoutingReceiver *mRoutingReceiver;
-	CAmControlSender *mControlSender;
-	CAmControlReceiver *mControlReceiver;
-	CAmDatabaseHandler *mDatabasehandler;
-	CAmRouter *mRouter;
-	sh_pollHandle_t mConnecthandle;
-	std::queue<std::string> mMsgList;
-	std::vector<connection_s> mListConnections;
-	int mConnectFD;
-	unsigned int mServerPort;
-	unsigned int mMaxConnections;
-	CAmTelnetMenuHelper mTelnetMenuHelper;
+    static CAmTelnetServer* mpInstance;
+    CAmSocketHandler *mpSocketHandler;
+    CAmCommandSender *mpCommandSender;
+    CAmCommandReceiver *mpCommandReceiver;
+    CAmRoutingSender *mpRoutingSender;
+    CAmRoutingReceiver *mpRoutingReceiver;
+    CAmControlSender *mpControlSender;
+    CAmControlReceiver *mpControlReceiver;
+    CAmDatabaseHandler *mpDatabasehandler;
+    CAmRouter *mpRouter;
+    sh_pollHandle_t mConnecthandle;
+    std::queue<std::string> mListMessages;
+    std::vector<connection_s> mListConnections;
+    int mConnectFD;
+    unsigned int mServerPort;
+    unsigned int mMaxConnections;
+    CAmTelnetMenuHelper mTelnetMenuHelper;
 
 };