mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-20 23:07:43 +00:00
1e62913610
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@20319 a592a061-630c-0410-9148-cb99ea01b6c8
139 lines
3.1 KiB
C++
139 lines
3.1 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file Server.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Lars Gullik Bjønnes
|
|
* \author Jean-Marc Lasgouttes
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef SERVER_H
|
|
#define SERVER_H
|
|
|
|
#include <boost/signals/trackable.hpp>
|
|
|
|
|
|
namespace lyx {
|
|
|
|
class LyXFunc;
|
|
class Server;
|
|
|
|
|
|
/** This class managed the pipes used for communicating with clients.
|
|
Usage: Initialize with pipe-filename-base, client class to receive
|
|
messages, and callback-function that will be called with the messages.
|
|
When you want to send, use "send()".
|
|
This class encapsulates all the dirty communication and thus provides
|
|
a clean string interface.
|
|
*/
|
|
class LyXComm : public boost::signals::trackable {
|
|
public:
|
|
/** When we receive a message, we send it to a client.
|
|
This is one of the small things that would have been a lot
|
|
cleaner with a Signal/Slot thing.
|
|
*/
|
|
typedef void (*ClientCallbackfct)(Server *, std::string const &);
|
|
|
|
/// Construct with pipe-basename and callback to receive messages
|
|
LyXComm(std::string const & pip, Server * cli, ClientCallbackfct ccb = 0);
|
|
|
|
///
|
|
~LyXComm() { closeConnection(); }
|
|
|
|
/// clean up in emergency
|
|
void emergencyCleanup();
|
|
|
|
/// Send message
|
|
void send(std::string const &);
|
|
|
|
/// asynch ready-to-be-read notification
|
|
void read_ready();
|
|
|
|
private:
|
|
/// the filename of the in pipe
|
|
std::string const inPipeName() const;
|
|
|
|
/// the filename of the out pipe
|
|
std::string const outPipeName() const;
|
|
|
|
/// Open pipes
|
|
void openConnection();
|
|
|
|
/// Close pipes
|
|
void closeConnection();
|
|
|
|
/// start a pipe
|
|
int startPipe(std::string const &, bool);
|
|
|
|
/// finish a pipe
|
|
void endPipe(int &, std::string const &, bool);
|
|
|
|
/// This is -1 if not open
|
|
int infd_;
|
|
|
|
/// This is -1 if not open
|
|
int outfd_;
|
|
|
|
/// Are we up and running?
|
|
bool ready_;
|
|
|
|
/// Base of pipename including path
|
|
std::string pipename_;
|
|
|
|
/// The client
|
|
Server * client_;
|
|
|
|
/// The client callback function
|
|
ClientCallbackfct clientcb_;
|
|
};
|
|
|
|
|
|
///
|
|
class Server {
|
|
public:
|
|
// FIXME IN 0.13
|
|
// Hack! This should be changed in 0.13
|
|
|
|
// The lyx server should not take an argument "LyXFunc" but this is
|
|
// how it will be done for 0.12. In 0.13 we must write a non-gui
|
|
// bufferview.
|
|
// IMO lyxserver is atypical, and for the moment the only one, non-gui
|
|
// bufferview. We just have to find a way to handle situations like if
|
|
// lyxserver is using a buffer that is being edited with a bufferview.
|
|
// With a common buffer list this is not a problem, maybe. (Alejandro)
|
|
///
|
|
Server(LyXFunc * f, std::string const & pip);
|
|
///
|
|
~Server();
|
|
///
|
|
void notifyClient(std::string const &);
|
|
|
|
/// whilst crashing etc.
|
|
void emergencyCleanup() { pipes_.emergencyCleanup(); }
|
|
///
|
|
void callback(std::string const & msg);
|
|
|
|
private:
|
|
/// Names and number of current clients
|
|
enum { MAX_CLIENTS = 10 };
|
|
///
|
|
std::string clients_[MAX_CLIENTS];
|
|
///
|
|
int numclients_;
|
|
///
|
|
LyXFunc * func_;
|
|
///
|
|
LyXComm pipes_;
|
|
};
|
|
|
|
/// Implementation is in LyX.cpp
|
|
extern Server & theServer();
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
#endif // SERVER_H
|