endpoint.h

Go to the documentation of this file.

#pragma once
 
#ifdef ARDUINO
 
#include "websockets/common.h"
#include "websockets/data_frame.h"
#include "websockets/message.h"
#include "websockets/tcp.h"
 
#include <memory>
 
#define __TINY_WS_INTERNAL_DEFAULT_MASK "\00\00\00\00"
 
namespace websockets {
enum FragmentsPolicy { FragmentsPolicy_Aggregate, FragmentsPolicy_Notify };
 
enum CloseReason {
  CloseReason_None = -1,
  CloseReason_NormalClosure = 1000,
  CloseReason_GoingAway = 1001,
  CloseReason_ProtocolError = 1002,
  CloseReason_UnsupportedData = 1003,
  CloseReason_NoStatusRcvd = 1005,
  CloseReason_AbnormalClosure = 1006,
  CloseReason_InvalidPayloadData = 1007,
  CloseReason_PolicyViolation = 1008,
  CloseReason_MessageTooBig = 1009,
  CloseReason_InternalServerError = 1011,
};
 
CloseReason GetCloseReason(uint16_t reasonCode);
 
namespace internals {
 
class WebsocketsEndpoint {
public:
  WebsocketsEndpoint(std::shared_ptr<network::TcpClient> socket,
                     FragmentsPolicy fragmentsPolicy = FragmentsPolicy_Aggregate);
 
  WebsocketsEndpoint(const WebsocketsEndpoint &other);
  WebsocketsEndpoint(const WebsocketsEndpoint &&other);
 
  WebsocketsEndpoint &operator=(const WebsocketsEndpoint &other);
  WebsocketsEndpoint &operator=(const WebsocketsEndpoint &&other);
 
  void setInternalSocket(std::shared_ptr<network::TcpClient> socket);
 
  bool poll();
  WebsocketsMessage recv();
  bool send(const char *data, const size_t len, const uint8_t opcode, const bool fin, const bool mask,
            const char *maskingKey = __TINY_WS_INTERNAL_DEFAULT_MASK);
  bool send(const std::string &data, const uint8_t opcode, const bool fin, const bool mask,
            const char *maskingKey = __TINY_WS_INTERNAL_DEFAULT_MASK);
 
  bool send(const char *data, const size_t len, const uint8_t opcode, const bool fin);
  bool send(const std::string &data, const uint8_t opcode, const bool fin);
 
  bool ping(const std::string &msg);
  bool ping(const std::string &&msg);
 
  bool pong(const std::string &msg);
  bool pong(const std::string &&msg);
 
  void close(const CloseReason reason = CloseReason_NormalClosure);
  CloseReason getCloseReason() const;
 
  void setFragmentsPolicy(const FragmentsPolicy newPolicy);
  FragmentsPolicy getFragmentsPolicy() const;
 
  void setUseMasking(bool useMasking) { _useMasking = useMasking; }
 
  virtual ~WebsocketsEndpoint();
 
private:
  std::shared_ptr<network::TcpClient> _client;
  FragmentsPolicy _fragmentsPolicy;
 
  enum RecvMode { RecvMode_Normal, RecvMode_Streaming } _recvMode;
 
  WebsocketsMessage::StreamBuilder _streamBuilder;
  CloseReason _closeReason;
  bool _useMasking = true;
 
  WebsocketsFrame _recv();
  void handleMessageInternally(WebsocketsMessage &msg);
 
  WebsocketsMessage handleFrameInStreamingMode(WebsocketsFrame &frame);
  WebsocketsMessage handleFrameInStandardMode(WebsocketsFrame &frame);
 
  std::string getHeader(uint64_t len, uint8_t opcode, bool fin, bool mask);
};
} // namespace internals
} // namespace websockets
 
#endif // ARDUINO