src/ServerSocket.h

   1 // -*- C++ -*-
   2 /**
   3  * \file ServerSocket.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author João Luis M. Assirati
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef LYXSERVERSOCKET_H
  15 #define LYXSERVERSOCKET_H
  16
  17 #include "support/FileName.h"
  18 #include "support/socktools.h"
  19
  20 #include "support/shared_ptr.h"
  21
  22 #include <string>
  23 #include <map>
  24
  25
  26 namespace lyx {
  27
  28 class LyXDataSocket;
  29
  30
  31 /** Sockets can be in two states: listening and connected.
  32  *  Connected sockets are used to transfer data, and will therefore
  33  *  be called Data Sockets. Listening sockets are used to create
  34  *  Data Sockets when clients connect, and therefore will be called
  35  * Server Sockets.
  36
  37  * This class encapsulates local (unix) server socket operations and
  38  * manages LyXDataSockets objects that are created when clients connect.
  39  */
  40 class ServerSocket {
  41 public:
  42         ///
  43         ServerSocket(support::FileName const &);
  44         ///
  45         ~ServerSocket();
  46         /// Address of the local socket
  47         std::string const address() const;
  48         /// To be called when there is activity in the server socket
  49         void serverCallback();
  50         /// To be called when there is activity in the data socket
  51         void dataCallback(int fd);
  52 private:
  53         ///
  54         void writeln(std::string const &);
  55         /// File descriptor for the server socket
  56         int fd_;
  57         /// Stores the socket filename
  58         support::FileName address_;
  59         /// Maximum number of simultaneous clients
  60         enum {
  61                 MAX_CLIENTS = 10
  62         };
  63         /// All connections
  64         std::map<int, shared_ptr<LyXDataSocket> > clients;
  65 };
  66
  67
  68 /** This class encapsulates data socket operations.
  69  *  It provides read and write IO operations on the socket.
  70  */
  71 class LyXDataSocket {
  72 public:
  73         ///
  74         LyXDataSocket(int fd);
  75         ///
  76         ~LyXDataSocket();
  77         /// Connection status
  78         bool connected() const;
  79         /// Line buffered input from the socket
  80         bool readln(std::string &);
  81         /// Write the string + '\n' to the socket
  82         void writeln(std::string const &);
  83 private:
  84         /// File descriptor for the data socket
  85         int fd_;
  86         /// True if the connection is up
  87         bool connected_;
  88         /// buffer for input data
  89         std::string buffer_;
  90 };
  91
  92 /// Implementation is in LyX.cpp
  93 extern ServerSocket & theServerSocket();
  94
  95
  96 } // namespace lyx
  97
  98 #endif // LYXSERVERSOCKET_H