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"
18 #include "support/socktools.h"
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
37 * This class encapsulates local (unix) server socket operations and
38 * manages LyXDataSockets objects that are created when clients connect.
43 ServerSocket(LyXFunc *, support::FileName const &);
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);
54 void writeln(std::string const &);
57 /// File descriptor for the server socket
59 /// Stores the socket filename
60 support::FileName address_;
61 /// Maximum number of simultaneous clients
66 std::map<int, std::tr1::shared_ptr<LyXDataSocket> > clients;
70 /** This class encapsulates data socket operations.
71 * It provides read and write IO operations on the socket.
76 LyXDataSocket(int fd);
80 bool connected() const;
81 /// Line buffered input from the socket
82 bool readln(std::string &);
83 /// Write the string + '\n' to the socket
84 void writeln(std::string const &);
86 /// File descriptor for the data socket
88 /// True if the connection is up
90 /// buffer for input data
94 /// Implementation is in LyX.cpp
95 extern ServerSocket & theServerSocket();
100 #endif // LYXSERVERSOCKET_H