Blinker

src/noarch/Sender.h   1) /* Blinker

src/noarch/Sender.h   2)    Copyright 2011-2014 Stefan Schuermans <stefan@blinkenarea.org>

src/noarch/Sender.h   3)    Copyleft GNU public license - http://www.gnu.org/copyleft/gpl.html
src/noarch/Sender.h   4)    a blinkenarea.org project */
src/noarch/Sender.h   5) 

src/noarch/Sender.h   6) #ifndef BLINKER_SENDER_H
src/noarch/Sender.h   7) #define BLINKER_SENDER_H

src/noarch/Sender.h   8) 
src/noarch/Sender.h   9) #include <list>

src/noarch/Sender.h  10) #include <map>

src/noarch/Sender.h  11) #include <string>
src/noarch/Sender.h  12) 

src/noarch/Sender.h  13) #include <BlinkenLib/BlinkenProto.h>

src/noarch/Sender.h  14) #include <BlinkenLib/BlinkenFrame.h>
src/noarch/Sender.h  15) 
src/noarch/Sender.h  16) #include "Directory.h"
src/noarch/Sender.h  17) #include "File.h"

src/noarch/Sender.h  18) #include "InStreamFile.h"

src/noarch/Sender.h  19) #include "IoCallee.h"

src/noarch/Sender.h  20) #include "Mgrs.h"

src/noarch/Sender.h  21) #include "Module.h"

src/noarch/Sender.h  22) #include "ListTracker.h"

src/noarch/Sender.h  23) #include "Protocol.h"

src/noarch/Sender.h  24) #include "ProtocolFile.h"

src/noarch/Sender.h  25) #include "SettingFile.h"
src/noarch/Sender.h  26) #include "StreamRecv.h"

src/noarch/Sender.h  27) #include "Time.h"

src/noarch/Sender.h  28) #include "TimeCallee.h"

src/noarch/Sender.h  29) 
src/noarch/Sender.h  30) namespace Blinker {
src/noarch/Sender.h  31) 
src/noarch/Sender.h  32) /// stream sender
src/noarch/Sender.h  33) template<typename ADDR, typename SOCK>

src/noarch/Sender.h  34) class Sender: public IoCallee, public Module, public StreamRecv,
src/noarch/Sender.h  35)               public TimeCallee

src/noarch/Sender.h  36) {
src/noarch/Sender.h  37) protected:

src/noarch/Sender.h  38)   /// type for address setting file
src/noarch/Sender.h  39)   typedef SettingFile<ADDR> AddrFile;
src/noarch/Sender.h  40) 

src/noarch/Sender.h  41)   /// static destination

src/noarch/Sender.h  42)   class Dest;
src/noarch/Sender.h  43) 

src/noarch/Sender.h  44)   /// static destination list tracker
src/noarch/Sender.h  45)   typedef ListTracker<Sender, Dest, Directory> DestListTracker;

src/noarch/Sender.h  46) 

src/noarch/Sender.h  47)   /// dynamic destinations: address -> time of last request
src/noarch/Sender.h  48)   typedef std::map<ADDR, Time> DynDests;
src/noarch/Sender.h  49) 

src/noarch/Sender.h  50) public:
src/noarch/Sender.h  51)   /**
src/noarch/Sender.h  52)    * @brief constructor

src/noarch/Sender.h  53)    * @param[in] name module name

src/noarch/Sender.h  54)    * @param[in] mgrs managers

src/noarch/Sender.h  55)    * @param[in] dirBase base directory
src/noarch/Sender.h  56)    */

src/noarch/Sender.h  57)   Sender(const std::string &name, Mgrs &mgrs, const Directory &dirBase);

src/noarch/Sender.h  58) 
src/noarch/Sender.h  59)   /// virtual destructor
src/noarch/Sender.h  60)   virtual ~Sender();
src/noarch/Sender.h  61) 
src/noarch/Sender.h  62) private:
src/noarch/Sender.h  63)   /// copy constructor disabled
src/noarch/Sender.h  64)   Sender(const Sender &that);
src/noarch/Sender.h  65) 
src/noarch/Sender.h  66)   /// assignment operator disabled
src/noarch/Sender.h  67)   const Sender & operator=(const Sender &that);
src/noarch/Sender.h  68) 
src/noarch/Sender.h  69) public:
src/noarch/Sender.h  70)   /// check for update of configuration
src/noarch/Sender.h  71)   virtual void updateConfig();
src/noarch/Sender.h  72) 
src/noarch/Sender.h  73)   /**
src/noarch/Sender.h  74)    * @brief set current frame

src/noarch/Sender.h  75)    * @param[in] stream stream name

src/noarch/Sender.h  76)    * @param[in] pFrame current frame (NULL for none)

src/noarch/Sender.h  77)    */

src/noarch/Sender.h  78)   virtual void setFrame(const std::string &stream, stBlinkenFrame *pFrame);

src/noarch/Sender.h  79) 

src/noarch/Sender.h  80)   /// callback when requested time reached

src/noarch/Sender.h  81)   virtual void timeCall();
src/noarch/Sender.h  82) 

src/noarch/Sender.h  83)   /**
src/noarch/Sender.h  84)    * @brief callback when I/O object is readable
src/noarch/Sender.h  85)    * @param[in] io I/O object that is readable
src/noarch/Sender.h  86)    */
src/noarch/Sender.h  87)   virtual void ioReadCall(Io *io);
src/noarch/Sender.h  88) 
src/noarch/Sender.h  89)   /**
src/noarch/Sender.h  90)    * @brief callback when I/O object is writable
src/noarch/Sender.h  91)    * @param[in] io I/O object that is writable
src/noarch/Sender.h  92)    */
src/noarch/Sender.h  93)   virtual void ioWriteCall(Io *io);
src/noarch/Sender.h  94) 

src/noarch/Sender.h  95) protected:

src/noarch/Sender.h  96)   /// (re-)read protocol
src/noarch/Sender.h  97)   void readProto();

src/noarch/Sender.h  98) 

src/noarch/Sender.h  99)   /// create socket and bind it
src/noarch/Sender.h 100)   void createSock();
src/noarch/Sender.h 101) 
src/noarch/Sender.h 102)   /// destroy socket
src/noarch/Sender.h 103)   void destroySock();
src/noarch/Sender.h 104) 

src/noarch/Sender.h 105)   /// remove timed-out dynamic destinations
src/noarch/Sender.h 106)   void removeTimedOutDynDests();
src/noarch/Sender.h 107) 

src/noarch/Sender.h 108)   /// send current protocol data to all destinations
src/noarch/Sender.h 109)   void sendAllProto();

src/noarch/Sender.h 110) 
src/noarch/Sender.h 111)   /// send "no frame" to all destinations
src/noarch/Sender.h 112)   void sendAllNoFrame();
src/noarch/Sender.h 113) 
src/noarch/Sender.h 114)   /**
src/noarch/Sender.h 115)    * @brief send data to static/dynamic destinations

src/noarch/Sender.h 116)    * @param[in] data *pData protocol data to send

src/noarch/Sender.h 117)    */

src/noarch/Sender.h 118)   void sendDests(const std::string *pData);

src/noarch/Sender.h 119) 

src/noarch/Sender.h 120)   /**

src/noarch/Sender.h 121)    * @brief send protocol data to address

src/noarch/Sender.h 122)    * @param[in] data protocol data of frame (empty if unknown)

src/noarch/Sender.h 123)    * @param[in] addr address to send to
src/noarch/Sender.h 124)    */

src/noarch/Sender.h 125)   void sendProto(const std::string &data, const ADDR &addr) const;

src/noarch/Sender.h 126) 
src/noarch/Sender.h 127)   /**

src/noarch/Sender.h 128)    * @brief convert frame to protocol data

src/noarch/Sender.h 129)    * @param[in] pFrame frame (NULL for none)

src/noarch/Sender.h 130)    * @param[out] data protocol data

src/noarch/Sender.h 131)    */

src/noarch/Sender.h 132)   void frame2data(stBlinkenFrame *pFrame, std::string &data) const;

src/noarch/Sender.h 133) 

src/noarch/Sender.h 134)   /// receive data from socket
src/noarch/Sender.h 135)   void receiveFromSock();

src/noarch/Sender.h 136) 
src/noarch/Sender.h 137) protected:

src/noarch/Sender.h 138)   InStreamFile    m_fileInStream;    ///< input stream name file
src/noarch/Sender.h 139)   AddrFile        m_fileBind;        ///< bind address file
src/noarch/Sender.h 140)   ProtocolFile    m_fileProtocol;    ///< protocol file
src/noarch/Sender.h 141)   SOCK            *m_pSock;          ///< socket to use for sending streams
src/noarch/Sender.h 142)   DestListTracker m_destListTracker; ///< static destinations tracker
src/noarch/Sender.h 143)   DynDests        m_dynDests;        ///< dynamic destinations

src/noarch/Sender.h 144)   std::string     m_noFrameData;     /**< "no frame" protocol data
src/noarch/Sender.h 145)                                           (empty if unknown) */
src/noarch/Sender.h 146)   std::string     m_data;            /**< current protocol data
src/noarch/Sender.h 147)                                           (empty if unknown) */

src/noarch/Sender.h 148) }; // class Sender
src/noarch/Sender.h 149) 
src/noarch/Sender.h 150) } // namespace Blinker
src/noarch/Sender.h 151) 

src/noarch/Sender.h 152) #endif // #ifndef BLINKER_SENDER_H