LibreOffice/online
1
0
Fork 0
mirror of https://github.com/LibreOffice/online.git synced 2025-08-15 21:13:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

re-factor: Socket / WebSocketHandler.

Browse Source 
Essentially we want to be able to separate low-level socket code
for eg. TCP vs. UDS, from Protocol handling: eg. WebSocketHandler
and client sessions themselves which handle and send messages
which now implement the simple MessageHandlerInterface.

Some helpful renaming too:

s/SocketHandlerInterface/ProtocolHandlerInterface/

Change-Id: I58092b5e0b5792fda47498fb2c875851eada461d
Reviewed-on: https://gerrit.libreoffice.org/c/online/+/90138
Tested-by: Jenkins CollaboraOffice <jenkinscollaboraoffice@gmail.com>
Reviewed-by: Michael Meeks <michael.meeks@collabora.com>
This commit is contained in:
Michael Meeks
2020-03-06 17:43:46 +00:00
parent fb27d9a796
commit e924625cc1
17 changed files with 332 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
common/Session.hpp
View File

@ -64,7 +64,7 @@ public:
};
/// Base class of a WebSocket session.
class Session : public WebSocketHandler
class Session : public MessageHandlerInterface
{
public:
const std::string& getId() const { return _id; }
@ -74,8 +74,32 @@ public:
virtual void setReadOnly() { _isReadOnly = true; }
bool isReadOnly() const { return _isReadOnly; }
/// overridden to prepend client ids on messages by the Kit
virtual bool sendBinaryFrame(const char* buffer, int length);
virtual bool sendTextFrame(const char* buffer, const int length);
/// Get notified that the underlying transports disconnected
void onDisconnect() override { /* ignore */ }
bool hasQueuedMessages() const override
{
// queued in Socket output buffer
return false;
}
// By default rely on the socket buffer.
void writeQueuedMessages() override
{
assert(false);
}
/// Sends a WebSocket Text message.
int sendMessage(const std::string& msg)
{
return sendTextFrame(msg.data(), msg.size());
}
// FIXME: remove synonym - and clean from WebSocketHandler too ... (?)
bool sendTextFrame(const std::string& text)
{
return sendTextFrame(text.data(), text.size());
@ -98,12 +122,10 @@ public:
virtual void disconnect();
/// clean & normal shutdown
void shutdownNormal(const std::string& statusMessage = "")
{ shutdown(WebSocketHandler::StatusCodes::NORMAL_CLOSE, statusMessage); }
void shutdownNormal(const std::string& statusMessage = "") { shutdown(false, statusMessage); }
/// abnormal / hash shutdown end-point going away
void shutdownGoingAway(const std::string& statusMessage = "")
{ shutdown(WebSocketHandler::StatusCodes::ENDPOINT_GOING_AWAY, statusMessage); }
void shutdownGoingAway(const std::string& statusMessage = "") { shutdown(true, statusMessage); }
bool isActive() const { return _isActive; }
void setIsActive(bool active) { _isActive = active; }
@ -165,7 +187,8 @@ public:
}
protected:
Session(const std::string& name, const std::string& id, bool readonly);
Session(const std::shared_ptr<ProtocolHandlerInterface> &handler,
const std::string& name, const std::string& id, bool readonly);
virtual ~Session();
/// Parses the options of the "load" command,
@ -181,8 +204,7 @@ protected:
private:
void shutdown(const WebSocketHandler::StatusCodes statusCode = WebSocketHandler::StatusCodes::NORMAL_CLOSE,
const std::string& statusMessage = "");
void shutdown(bool goingAway = false, const std::string& statusMessage = "");
virtual bool _handleInput(const char* buffer, int length) = 0;