4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author João Luis M. Assirati
11 * Full author contact details are available in file CREDITS.
14 #ifndef LYXSERVERSOCKET_H
15 #define LYXSERVERSOCKET_H
17 #include "support/FileName.h"
29 /** Sockets can be in two states: listening and connected.
30 * Connected sockets are used to transfer data, and will therefore
31 * be called Data Sockets. Listening sockets are used to create
32 * Data Sockets when clients connect, and therefore will be called
35 * This class encapsulates local (unix) server socket operations and
36 * manages LyXDataSockets objects that are created when clients connect.
41 ServerSocket(support::FileName const &);
44 /// Address of the local socket
45 std::string const address() const;
46 /// To be called when there is activity in the server socket
47 void serverCallback();
48 /// To be called when there is activity in the data socket
49 void dataCallback(int fd);
52 void writeln(std::string const &);
53 /// File descriptor for the server socket
55 /// Stores the socket filename
56 support::FileName address_;
57 /// Maximum number of simultaneous clients
62 std::map<int, std::shared_ptr<LyXDataSocket>> clients;
66 /** This class encapsulates data socket operations.
67 * It provides read and write IO operations on the socket.
72 LyXDataSocket(int fd);
76 bool connected() const;
77 /// Line buffered input from the socket
78 bool readln(std::string &);
79 /// Write the string + '\n' to the socket
80 void writeln(std::string const &);
82 /// File descriptor for the data socket
84 /// True if the connection is up
86 /// buffer for input data
90 /// Implementation is in LyX.cpp
91 extern ServerSocket & theServerSocket();
96 #endif // LYXSERVERSOCKET_H