ProtocolUtil.h

Go to the documentation of this file.

/*
 * Deskflow -- mouse and keyboard sharing utility
 * SPDX-FileCopyrightText: (C) 2026 Deskflow Developers
 * SPDX-FileCopyrightText: (C) 2012 - 2016 Symless Ltd.
 * SPDX-FileCopyrightText: (C) 2002 Chris Schoeneman
 * SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception
 */
 
#pragma once
 
#include "io/IOException.h"
 
#include <cstdint>
#include <stdarg.h>
#include <vector>
 
namespace deskflow {
class IStream;
}


class ProtocolUtil
{
public:

  static void writef(deskflow::IStream *, const char *fmt, ...);


  static bool readf(deskflow::IStream *, const char *fmt, ...);
 
private:
  static void vwritef(deskflow::IStream *, const char *fmt, uint32_t size, va_list);
  static void vreadf(deskflow::IStream *, const char *fmt, va_list);
 
  static uint32_t getLength(const char *fmt, va_list);
  static void writef(std::vector<uint8_t> &, const char *fmt, va_list);
  static uint32_t eatLength(const char **fmt);
  static void read(deskflow::IStream *, void *, uint32_t);

  static uint8_t read1ByteInt(deskflow::IStream *stream);
  static uint16_t read2BytesInt(deskflow::IStream *stream);
  static uint32_t read4BytesInt(deskflow::IStream *stream);

  static void readVector1ByteInt(deskflow::IStream *, std::vector<uint8_t> &);
  static void readVector2BytesInt(deskflow::IStream *, std::vector<uint16_t> &);
  static void readVector4BytesInt(deskflow::IStream *, std::vector<uint32_t> &);
  static uint32_t readVectorSize(deskflow::IStream *stream);

  static void readBytes(deskflow::IStream *, uint32_t, std::string *);
};


class XIOReadMismatch : public IOException
{
public:
  // BaseException overrides
  QString getWhat() const throw() override;
};