From 006a2ce21f277f171c8da9f4455c7299977fd87a Mon Sep 17 00:00:00 2001 From: Christian as GENIVI Maintainer Date: Fri, 30 Sep 2016 08:27:37 -0700 Subject: add actual doxygen documentation Signed-off-by: Christian as GENIVI Maintainer --- CAmTelnetServer_8h_source.html | 223 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 223 insertions(+) create mode 100644 CAmTelnetServer_8h_source.html (limited to 'CAmTelnetServer_8h_source.html') diff --git a/CAmTelnetServer_8h_source.html b/CAmTelnetServer_8h_source.html new file mode 100644 index 0000000..b673fe8 --- /dev/null +++ b/CAmTelnetServer_8h_source.html @@ -0,0 +1,223 @@ + + + + + + +AudioManager: AudioManagerCore/include/CAmTelnetServer.h Source File + + + + + + + + + + + + + +
+
+ + + + + + +
+
AudioManager +  7.5.11 +
+
Native Application Runtime Environment
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+
CAmTelnetServer.h
+
+
+Go to the documentation of this file.
1 
+
25 #ifndef TELNETSERVER_H_
+
26 #define TELNETSERVER_H_
+
27 
+
28 #include <queue>
+
29 #include <map>
+
30 #include "CAmSocketHandler.h"
+
31 #include "CAmTelnetMenuHelper.h"
+
32 
+
33 namespace am
+
34 {
+
35 
+
36 class IAmDatabaseHandler;
+
37 class CAmCommandSender;
+
38 class CAmRoutingSender;
+
39 class CAmControlSender;
+
40 class CAmCommandReceiver;
+
41 class CAmRoutingReceiver;
+
42 class CAmControlReceiver;
+
43 class CAmRouter;
+
44 class CAmTelnetMenuHelper;
+
45 
+
52 class CAmTelnetServer
+
53 {
+
54 public:
+
55  CAmTelnetServer(CAmSocketHandler *iSocketHandler, CAmCommandSender *iCommandSender, CAmCommandReceiver *iCommandReceiver, CAmRoutingSender *iRoutingSender, CAmRoutingReceiver *iRoutingReceiver, CAmControlSender *iControlSender, CAmControlReceiver *iControlReceiver, IAmDatabaseHandler *iDatabasehandler, CAmRouter *iRouter, unsigned int servPort, unsigned int maxConnections);
+
56  ~CAmTelnetServer();
+
57  void connectSocket(const pollfd pfd, const sh_pollHandle_t handle, void* userData);
+
58  void disconnectClient(int filedescriptor);
+
59  void receiveData(const pollfd pfd, const sh_pollHandle_t handle, void* userData);
+
60  bool dispatchData(const sh_pollHandle_t handle, void* userData);
+
61  bool check(const sh_pollHandle_t handle, void* userData);
+
62  TAmShPollFired<CAmTelnetServer> telnetConnectFiredCB;
+
63  TAmShPollFired<CAmTelnetServer> telnetReceiveFiredCB;
+
64  TAmShPollDispatch<CAmTelnetServer> telnetDispatchCB;
+
65  TAmShPollCheck<CAmTelnetServer> telnetCheckCB;
+
66 private:
+
67 
+
68  typedef void (*CommandPrototype)(std::vector<std::string>& msg, int filedescriptor);
+
69  typedef std::map<std::string, CommandPrototype> mMapCommand_t;
+
70 
+
71  void sliceCommand(const std::string& string, std::string& command, std::queue<std::string>& msg);
+
72  mMapCommand_t createCommandMap();
+
73  struct connection_s
+
74  {
+
75  int filedescriptor;
+
76  sh_pollHandle_t handle;
+
77  };
+
78 
+
79  static CAmTelnetServer* mpInstance;
+
80  CAmSocketHandler *mpSocketHandler;
+
81  CAmCommandSender *mpCommandSender;
+
82  CAmCommandReceiver *mpCommandReceiver;
+
83  CAmRoutingSender *mpRoutingSender;
+
84  CAmRoutingReceiver *mpRoutingReceiver;
+
85  CAmControlSender *mpControlSender;
+
86  CAmControlReceiver *mpControlReceiver;
+
87  IAmDatabaseHandler *mpDatabasehandler;
+
88  CAmRouter *mpRouter;
+
89  sh_pollHandle_t mConnecthandle;
+
90  std::queue<std::string> mListMessages;
+
91  std::vector<connection_s> mListConnections;
+
92  int mConnectFD;
+
93  unsigned int mServerPort;
+
94  unsigned int mMaxConnections;
+
95  CAmTelnetMenuHelper mTelnetMenuHelper;
+
96 
+
97 };
+
98 
+
99 } /* namespace am */
+
100 #endif /* TELNETSERVER_H_ */
+
am::CAmRoutingSender
Implements the RoutingSendInterface.
Definition: CAmRoutingSender.h:44
+
am::CAmCommandReceiver
This class realizes the command Interface.
Definition: CAmCommandReceiver.h:40
+
CAmTelnetMenuHelper.h
SPDX license identifier: MPL-2.0.
+ +
am::CAmTelnetServer::check
bool check(const sh_pollHandle_t handle, void *userData)
Definition: CAmTelnetServer.cpp:223
+
am::TAmShPollCheck
template for a callback
Definition: CAmSocketHandler.h:449
+
am::TAmShPollFired
make private, not public template for a callback
Definition: CAmSocketHandler.h:429
+
am::CAmRouter
Implements an autorouting algorithm for connecting sinks and sources via different audio domains...
Definition: CAmRouter.h:152
+
am::CAmControlReceiver
This class is used to receive all commands from the control interface.
Definition: CAmControlReceiver.h:42
+
am::CAmSocketHandler
The am::CAmSocketHandler implements a mainloop for the AudioManager.
Definition: CAmSocketHandler.h:94
+
am::CAmTelnetServer::connectSocket
void connectSocket(const pollfd pfd, const sh_pollHandle_t handle, void *userData)
Definition: CAmTelnetServer.cpp:127
+
am::sh_pollHandle_t
uint16_t sh_pollHandle_t
this is a handle for a filedescriptor to be used with the SocketHandler
Definition: CAmSocketHandler.h:37
+
am::CAmRoutingReceiver
Implements the Receiving side of the RoutingPlugins.
Definition: CAmRoutingReceiver.h:41
+
am::CAmTelnetMenuHelper
helper class for CAmTelnetServer
Definition: CAmTelnetMenuHelper.h:57
+
am::CAmTelnetServer::disconnectClient
void disconnectClient(int filedescriptor)
Definition: CAmTelnetServer.cpp:152
+
am::TAmShPollDispatch
template for a callback
Definition: CAmSocketHandler.h:469
+
am::CAmControlSender
sends data to the commandInterface, takes the file of the library that needs to be loaded ...
Definition: CAmControlSender.h:41
+
am::IAmDatabaseHandler
This class handles and abstracts the database.
Definition: IAmDatabaseHandler.h:59
+
am::CAmTelnetServer
Implements a telnetserver that can be used to connect to the audiomanager, retrieve some information ...
Definition: CAmTelnetServer.h:52
+
am::CAmTelnetServer::CAmTelnetServer
CAmTelnetServer(CAmSocketHandler *iSocketHandler, CAmCommandSender *iCommandSender, CAmCommandReceiver *iCommandReceiver, CAmRoutingSender *iRoutingSender, CAmRoutingReceiver *iRoutingReceiver, CAmControlSender *iControlSender, CAmControlReceiver *iControlReceiver, IAmDatabaseHandler *iDatabasehandler, CAmRouter *iRouter, unsigned int servPort, unsigned int maxConnections)
Definition: CAmTelnetServer.cpp:52
+
am::CAmTelnetServer::telnetCheckCB
TAmShPollCheck< CAmTelnetServer > telnetCheckCB
Definition: CAmTelnetServer.h:65
+
am::CAmTelnetServer::dispatchData
bool dispatchData(const sh_pollHandle_t handle, void *userData)
Definition: CAmTelnetServer.cpp:191
+
CAmSocketHandler.h
SPDX license identifier: MPL-2.0.
+
am::CAmTelnetServer::telnetDispatchCB
TAmShPollDispatch< CAmTelnetServer > telnetDispatchCB
Definition: CAmTelnetServer.h:64
+
am::CAmTelnetServer::telnetReceiveFiredCB
TAmShPollFired< CAmTelnetServer > telnetReceiveFiredCB
Definition: CAmTelnetServer.h:63
+
am::CAmCommandSender
This class is used to send data to the CommandInterface.
Definition: CAmCommandSender.h:43
+
am::CAmTelnetServer::receiveData
void receiveData(const pollfd pfd, const sh_pollHandle_t handle, void *userData)
Definition: CAmTelnetServer.cpp:175
+
maxConnections
TCLAP::ValueArg< unsigned int > maxConnections("m","maxConnections","Maximal number of connections for telnet", false, MAX_TELNETCONNECTIONS,"int")
+
am::CAmTelnetServer::telnetConnectFiredCB
TAmShPollFired< CAmTelnetServer > telnetConnectFiredCB
Definition: CAmTelnetServer.h:62
+
+
+ + + + -- cgit v1.2.1