libreoffice-online/loolwsd/LOOLSession.hpp
Tomaž Vajngerl 721cbbcbb3 Add "tilecombine" command to render more tiles in one call
When invalidating we need to rerender more tiles at once.
This change optimizes that with a new command which rerenders a
larger area once and then separates the rendered buffer into more
tiles. This generally decreases the invalidation time by 2-4 times
and in some cases (when invalidating images in document) up to 9
times.
2016-01-14 13:11:57 +01:00

138 lines
4.3 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#ifndef INCLUDED_LOOLSESSION_HPP
#define INCLUDED_LOOLSESSION_HPP
#include <cassert>
#include <condition_variable>
#include <map>
#include <memory>
#include <mutex>
#include <ostream>
#include <set>
#define LOK_USE_UNSTABLE_API
#include <LibreOfficeKit/LibreOfficeKit.h>
#include <Poco/Net/WebSocket.h>
#include <Poco/Buffer.h>
#include <Poco/Path.h>
#include <Poco/Process.h>
#include <Poco/Random.h>
#include <Poco/StringTokenizer.h>
#include <Poco/Types.h>
#include "MessageQueue.hpp"
#include "TileCache.hpp"
// We have three kinds of Websocket sessions
// 1) Between the master loolwsd server to the end-user LOOL client
// 2) Between the master loolwsd server and a jailed loolwsd child process, in the master process
// 3) Ditto, in the jailed loolwsd process
class LOOLSession
{
public:
enum class Kind { ToClient, ToPrisoner, ToMaster };
const std::string& getId() const { return _id; }
const std::string& getName() const { return _name; }
void sendTextFrame(const std::string& text);
virtual bool getStatus(const char *buffer, int length) = 0;
virtual bool getCommandValues(const char *buffer, int length, Poco::StringTokenizer& tokens) = 0;
virtual bool getPartPageRectangles(const char *buffer, int length) = 0;
bool handleInput(const char *buffer, int length);
protected:
LOOLSession(const std::string& id, const Kind kind,
std::shared_ptr<Poco::Net::WebSocket> ws);
virtual ~LOOLSession();
void setId(const std::string& id)
{
_id = id;
_name = _kindString + '-' + id;
}
void sendBinaryFrame(const char *buffer, int length);
/// Parses the options of the "load" command, shared between MasterProcessSession::loadDocument() and ChildProcessSession::loadDocument().
void parseDocOptions(const Poco::StringTokenizer& tokens, int& part, std::string& timestamp);
virtual bool loadDocument(const char *buffer, int length, Poco::StringTokenizer& tokens) = 0;
virtual void sendTile(const char *buffer, int length, Poco::StringTokenizer& tokens) = 0;
virtual void sendCombinedTiles(const char *buffer, int length, Poco::StringTokenizer& tokens) = 0;
virtual void sendFontRendering(const char *buffer, int length, Poco::StringTokenizer& tokens) = 0;
// Fields common to sessions in master and jailed processes:
// Our kind signifies to what we are connected to.
const Kind _kind;
// The kind cached as a string.
const std::string _kindString;
// In the master process, the websocket to the LOOL client or the jailed child process. In a
// jailed process, the websocket to the parent.
std::shared_ptr<Poco::Net::WebSocket> _ws;
// The actual URL, also in the child, even if the child never accesses that.
std::string _docURL;
// The Jailed document path.
std::string _jailedFilePath;
/// Document options: a JSON string, containing options (rendering, also possibly load in the future).
std::string _docOptions;
// Flag to stop dispatch chid messages when websocket is shutting down
bool _bShutdown;
private:
virtual bool _handleInput(const char *buffer, int length) = 0;
private:
// A session ID specific to an end-to-end connection (from user to lokit).
std::string _id;
// A readable name that identifies our peer and ID.
std::string _name;
std::mutex _mutex;
};
template<typename charT, typename traits>
inline std::basic_ostream<charT, traits> & operator <<(std::basic_ostream<charT, traits> & stream, LOOLSession::Kind kind)
{
switch (kind)
{
case LOOLSession::Kind::ToClient:
return stream << "TO_CLIENT";
case LOOLSession::Kind::ToPrisoner:
return stream << "TO_PRISONER";
case LOOLSession::Kind::ToMaster:
return stream << "TO_MASTER";
default:
assert(false);
return stream << "UNK_" + std::to_string(static_cast<int>(kind));
}
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */