Doxygen comments added

This commit is contained in:
johan
2013-08-31 14:36:54 +02:00
parent 1a2dd19a7b
commit 3187fc84a6
8 changed files with 195 additions and 28 deletions

View File

@@ -12,25 +12,48 @@
class JsonClientConnection;
///
/// This class creates a TCP server which accepts connections wich can then send
/// in JSON encoded commands. This interface to Hyperion is used by hyperion-remote
/// to control the leds
///
class JsonServer : public QObject
{
Q_OBJECT
public:
///
/// \brief JsonServer constructor
/// \param hyperion Hyperion instance
/// \param port port number on which to start listening for connections
///
JsonServer(Hyperion * hyperion, uint16_t port = 19444);
~JsonServer();
///
/// \return the port number on which this TCP listens for incoming connections
///
uint16_t getPort() const;
private slots:
///
/// \brief Slot which is called when a client tries to create a new connection
///
void newConnection();
///
/// \brief Slot which is called when a client closes a connection
/// \param The Connection object which is being closed
///
void closedConnection(JsonClientConnection * connection);
private:
/// Hyperion instance
Hyperion * _hyperion;
/// The TCP server object
QTcpServer _server;
/// List with open connections
QSet<JsonClientConnection *> _openConnections;
};