2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2001 The LyX Team.
10 * ====================================================== */
23 /* --- i/o pipes --------------------------------------------------------- */
25 /** This class managed the pipes used for communicating with clients.
26 Usage: Initialize with pipe-filename-base, client class to receive
27 messages, and callback-function that will be called with the messages.
28 When you want to send, use "send()".
29 This class encapsulates all the dirty communication and thus provides
30 a clean string interface.
34 /** When we receive a message, we send it to a client.
35 This is one of the small things that would have been a lot
36 cleaner with a Signal/Slot thing.
38 typedef void (*ClientCallbackfct)(LyXServer *, string const &);
40 /// Construct with pipe-basename and callback to receive messages
41 LyXComm(string const & pip, LyXServer * cli, ClientCallbackfct ccb = 0)
42 : pipename(pip), client(cli), clientcb(ccb) {
52 /// clean up in emergency
53 void emergencyCleanup();
56 void send(string const &);
58 /// We receive messages via XForms through this callback
59 static void callback(int fd, void *v);
62 /// the filename of the in pipe
63 string const inPipeName() {
64 return pipename + ".in";
67 /// the filename of the out pipe
68 string const outPipeName() {
69 return pipename + ".out";
73 void openConnection();
76 void closeConnection();
79 int startPipe(string const &, bool);
82 void endPipe(int &, string const &);
84 /// This is -1 if not open
87 /// This is -1 if not open
90 /// Are we up and running?
93 /// Base of pipename including path
99 /// The client callback function
100 ClientCallbackfct clientcb;
104 /* --- prototypes -------------------------------------------------------- */
109 // Hack! This should be changed in 0.13
111 // The lyx server should not take an argument "LyXFunc" but this is
112 // how it will be done for 0.12. In 0.13 we must write a non-gui
114 // IMO lyxserver is atypical, and for the moment the only one, non-gui
115 // bufferview. We just have to find a way to handle situations like if
116 // lyxserver is using a buffer that is being edited with a bufferview.
117 // With a common buffer list this is not a problem, maybe. (Alejandro)
119 LyXServer(LyXFunc * f, string const & pip)
120 : numclients(0), func(f), pipes(pip, (this), callback) {}
124 void notifyClient(string const &);
126 /// whilst crashing etc.
127 void emergencyCleanup() {
128 pipes.emergencyCleanup();
133 static void callback(LyXServer *, string const & msg);
134 /// Names and number of current clients
140 string clients[MAX_CLIENTS];
149 #endif /* _LYXSERVER_H_ */
151 /* === End of File: lyxserver.h ========================================== */