Author: skaarj1989

src/WebSocket.hpp

@@ -146,37 +146,10 @@ enum class WebSocketReadyState : uint8_t {
 struct WebSocketHeader_t;
 /** @endcond */
 
-/** @class WebSocket */
-template <class NetClient> class WebSocket {
-  template <class, class, uint8_t> friend class WebSocketServer;
-
-public:
-  /**
-   * @param ws Closing endpoint.
-   * @param code Close event code.
-   * @param reason Contains a message for a close event, c-string, non
-   * NULL-terminated. Might be empty.
-   * @param length The number of characters in the reason c-string.
-   */
-  using onCloseCallback = void (*)(
-      WebSocket &ws, WebSocketCloseCode code, const char *reason,
-      uint16_t length);
-
-  /**
-   * @param ws Source of a message.
-   * @param dataType Type of a message.
-   * @param message Non NULL-terminated.
-   * @param length Number of data bytes.
-   */
-  using onMessageCallback = void (*)(
-      WebSocket &ws, WebSocketDataType dataType, const char *message,
-      uint16_t length);
-
+/** @class IWebSocket */
+class IWebSocket {
 public:
-  WebSocket(const WebSocket &) = delete;
-  virtual ~WebSocket();
-
-  WebSocket &operator=(const WebSocket &) = delete;
+  virtual ~IWebSocket() = default;
 
   /**
    * @brief Sends a close event.
@@ -185,36 +158,48 @@ template <class NetClient> class WebSocket {
    * NULL-terminated. Max length = 123 characters.
    * @param length The number of characters in the reason c-string.
    */
-  void close(
-      WebSocketCloseCode, bool instant, const char *reason = nullptr,
-      uint16_t length = 0);
+  virtual void close(
+      WebSocketCloseCode, bool instant, const char *reason,
+      uint16_t length) = 0;
   /** @brief Immediately closes the connection. */
-  void terminate();
+  virtual void terminate() = 0;
 
   /** @return Endpoint connection status. */
-  WebSocketReadyState getReadyState() const;
+  virtual WebSocketReadyState getReadyState() const = 0;
   /** @brief Verifies endpoint connection. */
-  bool isAlive() const;
+  virtual bool isAlive() const = 0;
 
   /**
    * @return Endpoint IP address.
    * @remark For some microcontrollers it might be empty.
    */
-  IPAddress getRemoteIP() const;
-  const char *getProtocol() const;
+  virtual IPAddress getRemoteIP() const = 0;
+  virtual const char *getProtocol() const = 0;
 
   /**
    * @brief Sends a message frame.
    * @param message Doesn't have to be NULL-terminated.
    */
-  void send(WebSocketDataType, const char *message, uint16_t length);
+  virtual void
+  send(WebSocketDataType, const char *message, uint16_t length) = 0;
   /**
    * @brief Sends a ping message.
    * @param payload An additional message, doesn't have to be NULL-terminated.
    * Max length = 125.
    * @param length The number of characters in payload.
    */
-  void ping(const char *payload = nullptr, uint16_t length = 0);
+  virtual void ping(const char *payload, uint16_t length) = 0;
+
+  /**
+   * @param ws Closing endpoint.
+   * @param code Close event code.
+   * @param reason Contains a message for a close event, c-string, non
+   * NULL-terminated. Might be empty.
+   * @param length The number of characters in the reason c-string.
+   */
+  using onCloseCallback = void (*)(
+      IWebSocket &ws, WebSocketCloseCode code, const char *reason,
+      uint16_t length);
 
   /**
    * @brief Sets the close event handler.
@@ -225,7 +210,18 @@ template <class NetClient> class WebSocket {
    * });
    * @endcode
    */
-  void onClose(const onCloseCallback &);
+  virtual void onClose(const onCloseCallback &) = 0;
+
+  /**
+   * @param ws Source of a message.
+   * @param dataType Type of a message.
+   * @param message Non NULL-terminated.
+   * @param length Number of data bytes.
+   */
+  using onMessageCallback = void (*)(
+      IWebSocket &ws, WebSocketDataType dataType, const char *message,
+      uint16_t length);
+
   /**
    * @brief Sets the message handler function.
    * @code{.cpp}
@@ -235,6 +231,36 @@ template <class NetClient> class WebSocket {
    * });
    * @endcode
    */
+  virtual void onMessage(const onMessageCallback &) = 0;
+};
+
+/** @class WebSocket */
+template <class NetClient> class WebSocket : public IWebSocket {
+  template <class, class, uint8_t> friend class WebSocketServer;
+
+public:
+public:
+  WebSocket(const WebSocket &) = delete;
+  ~WebSocket() override;
+
+  WebSocket &operator=(const WebSocket &) = delete;
+
+  void close(
+      WebSocketCloseCode, bool instant, const char *reason = nullptr,
+      uint16_t length = 0);
+  void terminate();
+
+  WebSocketReadyState getReadyState() const;
+  bool isAlive() const;
+
+  IPAddress getRemoteIP() const;
+  const char *getProtocol() const;
+
+  void send(WebSocketDataType, const char *message, uint16_t length);
+
+  void ping(const char *payload = nullptr, uint16_t length = 0);
+
+  void onClose(const onCloseCallback &);
   void onMessage(const onMessageCallback &);
 
 protected:
@@ -293,9 +319,9 @@ void encodeSecKey(const char *key, char output[]);
 void generateMask(char output[]);
 
 template <typename NetClient>
-inline IPAddress fetchRemoteIp(NetClient &&client) {
+inline IPAddress fetchRemoteIp(const NetClient &client) {
   if constexpr (has_remoteIP<NetClient>::value)
-    return client.remoteIP();
+    return const_cast<NetClient &>(client).remoteIP();
   else
     return {};
 }

src/WebSocketServer.hpp

@@ -6,33 +6,20 @@
 
 namespace net {
 
-/** @class WebSocketServer */
-template <class NetServer, class NetClient, uint8_t _MaxConnections = 4>
-class WebSocketServer {
-  static_assert(_MaxConnections <= 8, "I don't think so ...");
-
+/** @class IWebSocketServer */
+class IWebSocketServer {
 public:
+  virtual ~IWebSocketServer() = default;
+
   /**
    * @param header c-string, NULL-terminated.
    * @param value c-string, NULL-terminated.
    */
   using verifyClientCallback =
       bool (*)(const IPAddress &, const char *header, const char *value);
   /** @param ws Accepted client. */
-  using onConnectionCallback = void (*)(WebSocket<NetClient> &ws);
   using protocolHandlerCallback = const char *(*)(const char *);
 
-public:
-  /**
-   * @brief Initializes server on given port.
-   * @note Don't forget to call begin()
-   */
-  explicit WebSocketServer(uint16_t port = 3000);
-  WebSocketServer(const WebSocketServer &) = delete;
-  ~WebSocketServer();
-
-  WebSocketServer &operator=(const WebSocketServer &) = delete;
-
   /**
    * @brief Startup server.
    * @code{.cpp}
@@ -48,20 +35,24 @@ class WebSocketServer {
    * @param callback Function called for every header during hadshake (except
    * for those required by protocol, like **Connection**, **Upgrade** etc.)
    */
-  void begin(
+  virtual void begin(
       const verifyClientCallback &verifyClient = nullptr,
-      const protocolHandlerCallback &protocolHandler = nullptr);
+      const protocolHandlerCallback &protocolHandler = nullptr) = 0;
+
   /** @brief Disconnects all clients. */
-  void shutdown();
+  virtual void shutdown() = 0;
 
   /** @brief Sends message to all connected clients. */
-  void broadcast(WebSocketDataType, const char *message, uint16_t length);
+  virtual void
+  broadcast(WebSocketDataType, const char *message, uint16_t length) = 0;
 
   /** @note Call this in main loop. */
-  void listen();
+  virtual void listen() = 0;
 
   /** @return Amount of connected clients. */
-  uint8_t countClients() const;
+  virtual uint8_t countClients() const = 0;
+
+  using onConnectionCallback = void (*)(IWebSocket &ws);
 
   /**
    * @brief
@@ -82,7 +73,38 @@ class WebSocketServer {
    * @param callback Function that will be called for every successfully
    * connected client.
    */
-  void onConnection(const onConnectionCallback &callback);
+  virtual void onConnection(const onConnectionCallback &callback) = 0;
+};
+
+/** @class WebSocketServer */
+template <class NetServer, class NetClient, uint8_t _MaxConnections = 4>
+class WebSocketServer : public IWebSocketServer {
+  static_assert(_MaxConnections <= 8, "I don't think so ...");
+
+public:
+  /**
+   * @brief Initializes server on given port.
+   * @note Don't forget to call begin()
+   */
+  explicit WebSocketServer(uint16_t port = 3000);
+  WebSocketServer(const WebSocketServer &) = delete;
+  ~WebSocketServer() override;
+
+  WebSocketServer &operator=(const WebSocketServer &) = delete;
+
+  void begin(
+      const verifyClientCallback &verifyClient = nullptr,
+      const protocolHandlerCallback &protocolHandler = nullptr) override;
+  void shutdown() override;
+
+  void
+  broadcast(WebSocketDataType, const char *message, uint16_t length) override;
+
+  void listen() override;
+
+  uint8_t countClients() const override;
+
+  void onConnection(const onConnectionCallback &callback) override;
 
 private:
   /** @cond */