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"
19 #include "support/shared_ptr.h"
30 /** Sockets can be in two states: listening and connected.
31 * Connected sockets are used to transfer data, and will therefore
32 * be called Data Sockets. Listening sockets are used to create
33 * Data Sockets when clients connect, and therefore will be called
36 * This class encapsulates local (unix) server socket operations and
37 * manages LyXDataSockets objects that are created when clients connect.
42 ServerSocket(support::FileName const &);
45 /// Address of the local socket
46 std::string const address() const;
47 /// To be called when there is activity in the server socket
48 void serverCallback();
49 /// To be called when there is activity in the data socket
50 void dataCallback(int fd);
53 void writeln(std::string const &);
54 /// File descriptor for the server socket
56 /// Stores the socket filename
57 support::FileName address_;
58 /// Maximum number of simultaneous clients
63 std::map<int, shared_ptr<LyXDataSocket> > clients;
67 /** This class encapsulates data socket operations.
68 * It provides read and write IO operations on the socket.
73 LyXDataSocket(int fd);
77 bool connected() const;
78 /// Line buffered input from the socket
79 bool readln(std::string &);
80 /// Write the string + '\n' to the socket
81 void writeln(std::string const &);
83 /// File descriptor for the data socket
85 /// True if the connection is up
87 /// buffer for input data
91 /// Implementation is in LyX.cpp
92 extern ServerSocket & theServerSocket();
97 #endif // LYXSERVERSOCKET_H