Blinker

1) /* Blinker

2)    Copyright 2011-2014 Stefan Schuermans <stefan@blinkenarea.org>

3)    Copyleft GNU public license - http://www.gnu.org/copyleft/gpl.html
4)    a blinkenarea.org project */
5) 
6) #ifndef BLINKER_OPCONNIF_H
7) #define BLINKER_OPCONNIF_H
8) 
9) #include <string>
10) 
11) namespace Blinker {
12) 
13) class OpConn;
14) 
15) /// operator connection interface
16) class OpConnIf
17) {
18) public:
19)   /// constructor
20)   OpConnIf();
21) 
22)   /// virtual destructor
23)   virtual ~OpConnIf();
24) 
25) public:

26)   /**
27)    * @brief key command received on operator connection
28)    * @param[in] pConn operator connection object
29)    * @param[in] key key that was pressed
30)    */
31)   virtual void opConnRecvKey(OpConn *pConn, char key) = 0;
32) 
33)   /**
34)    * @brief play command received on operator connection
35)    * @param[in] pConn operator connection object
36)    * @param[in] sound name of sound to play
37)    */
38)   virtual void opConnRecvPlay(OpConn *pConn, const std::string &sound) = 0;
39) 

40)   /**
41)    * @brief operator connection is closed
42)    * @param[in] pConn operator connection object

43)    *
44)    * The connection may not be used for sending any more in this callback.