IArchNetwork.h

Go to the documentation of this file.

/*
 * Deskflow -- mouse and keyboard sharing utility
 * 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 "common/IInterface.h"
#include <string>
 
#include <vector>
 
class ArchThreadImpl;
using ArchThread = ArchThreadImpl *;

class ArchSocketImpl;

using ArchSocket = ArchSocketImpl *;

class ArchNetAddressImpl;

using ArchNetAddress = ArchNetAddressImpl *;


class IArchNetwork : public IInterface
{
public:
  enum class AddressFamily : uint8_t
  {
    Unknown,
    INet,
    INet6
  };

  enum class SocketType : uint8_t
  {
    DataGram,
    Stream
  };


  struct PollEventMask
  {
    inline static const int In = 1;      
    inline static const int Out = 2;     
    inline static const int Error = 4;   
    inline static const int Invalid = 8; 
  };

  class PollEntry
  {
  public:
    ArchSocket m_socket;


    unsigned short m_events;

    unsigned short m_revents;
  };




  virtual ArchSocket newSocket(AddressFamily, SocketType) = 0;


  virtual ArchSocket copySocket(ArchSocket s) = 0;


  virtual void closeSocket(ArchSocket s) = 0;


  virtual void closeSocketForRead(ArchSocket s) = 0;


  virtual void closeSocketForWrite(ArchSocket s) = 0;


  virtual void bindSocket(ArchSocket s, ArchNetAddress addr) = 0;


  virtual void listenOnSocket(ArchSocket s) = 0;


  virtual ArchSocket acceptSocket(ArchSocket s, ArchNetAddress *addr) = 0;


  virtual bool connectSocket(ArchSocket s, ArchNetAddress addr) = 0;


  virtual int pollSocket(PollEntry[], int num, double timeout) = 0;


  virtual void unblockPollSocket(ArchThread thread) = 0;


  virtual size_t readSocket(ArchSocket s, void *buf, size_t len) = 0;


  virtual size_t writeSocket(ArchSocket s, const void *buf, size_t len) = 0;


  virtual void throwErrorOnSocket(ArchSocket s) = 0;


  virtual bool setNoDelayOnSocket(ArchSocket, bool noDelay) = 0;


  virtual bool setReuseAddrOnSocket(ArchSocket, bool reuse) = 0;

  virtual std::string getHostName() = 0;

  virtual ArchNetAddress newAnyAddr(AddressFamily) = 0;

  virtual ArchNetAddress copyAddr(ArchNetAddress) = 0;

  virtual std::vector<ArchNetAddress> nameToAddr(const std::string &) = 0;

  virtual void closeAddr(ArchNetAddress) = 0;

  virtual std::string addrToName(ArchNetAddress) = 0;

  virtual std::string addrToString(ArchNetAddress) = 0;

  virtual AddressFamily getAddrFamily(ArchNetAddress) = 0;

  virtual void setAddrPort(ArchNetAddress, int port) = 0;

  virtual int getAddrPort(ArchNetAddress) = 0;

  virtual bool isEqualAddr(ArchNetAddress, ArchNetAddress) = 0;


  virtual bool isAnyAddr(ArchNetAddress addr) = 0;

 
  virtual void init() = 0;
 
private:
  [[noreturn]] virtual void throwError(int) const = 0;

  [[noreturn]] virtual void throwNameError(int) const = 0;
};