ServerProxy.h

Go to the documentation of this file.

/*
 * Deskflow -- mouse and keyboard sharing utility
 * SPDX-FileCopyrightText: (C) 2025 Deskflow Developers
 * SPDX-FileCopyrightText: (C) 2012 - 2016, 2026 Synergy App Ltd
 * SPDX-FileCopyrightText: (C) 2002 Chris Schoeneman
 * SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception
 */
 
#pragma once
 
#include "common/Enums.h"
#include "deskflow/ClipboardChunk.h"
#include "deskflow/ClipboardTypes.h"
#include "deskflow/KeyTypes.h"
 
class Client;
class ClientInfo;
class EventQueueTimer;
class IClipboard;
namespace deskflow {
class IStream;
}
class IEventQueue;


class ServerProxy
{
public:
  ServerProxy(Client *client, deskflow::IStream *stream, IEventQueue *events);
  ServerProxy(ServerProxy const &) = delete;
  ServerProxy(ServerProxy &&) = delete;
  virtual ~ServerProxy();
 
  ServerProxy &operator=(ServerProxy const &) = delete;
  ServerProxy &operator=(ServerProxy &&) = delete;


 
  void onInfoChanged();
  bool onGrabClipboard(ClipboardID);
  void onClipboardChanged(ClipboardID, const IClipboard *);

 
protected:
  enum class ConnectionResult
  {
    Okay,
    Unknown,
    Disconnect
  };
 
  virtual ConnectionResult parseHandshakeMessage(const uint8_t *code);
  virtual ConnectionResult parseMessage(const uint8_t *code);
  void keyDown(uint16_t id, uint16_t mask, uint16_t button, const std::string &lang);
  void keyRepeat(uint16_t id, uint16_t mask, uint16_t count, uint16_t button, const std::string &lang);
 
  deskflow::IStream *getStream() const
  {
    return m_stream;
  }
 
private:
  // if compressing mouse motion then send the last motion now
  void flushCompressedMouse();
 
  void sendInfo(const ClientInfo &);
 
  void resetKeepAliveAlarm();
  void setKeepAliveRate(double);
 
  // modifier key translation
  KeyID translateKey(KeyID) const;
  KeyModifierMask translateModifierMask(KeyModifierMask) const;
 
  // event handlers
  void handleData();
  ConnectionResult handleMessage(const uint8_t *code);
  void handleKeepAliveAlarm();
  void requestDisconnect(const char *message);
  void requestRefuseConnection(deskflow::core::ConnectionRefusal reason, const char *message);
 
  // message handlers
  void enter();
  void leave();
  void setClipboard();
  void grabClipboard();
  void keyUp();
  void mouseDown();
  void mouseUp();
  void mouseMove();
  void mouseRelativeMove();
  void mouseWheel();
  void screensaver();
  void resetOptions();
  void setOptions();
  void queryInfo();
  void infoAcknowledgment();
 
private:
  using MessageParser = ConnectionResult (ServerProxy::*)(const uint8_t *);
 
  Client *m_client = nullptr;
  deskflow::IStream *m_stream = nullptr;
 
  uint32_t m_seqNum = 0;
 
  bool m_compressMouse = false;
  bool m_compressMouseRelative = false;
  int32_t m_xMouse = 0;
  int32_t m_yMouse = 0;
  int32_t m_dxMouse = 0;
  int32_t m_dyMouse = 0;
 
  bool m_ignoreMouse = false;
 
  KeyModifierID m_modifierTranslationTable[kKeyModifierIDLast];
 
  double m_keepAliveAlarm = 0.0;
  EventQueueTimer *m_keepAliveAlarmTimer = nullptr;
 
  MessageParser m_parser = &ServerProxy::parseHandshakeMessage;
  IEventQueue *m_events = nullptr;
  std::string m_clipboardDataCached;
  ClipboardChunkAssemblyState m_clipboardChunkState;
};