data_frame.h

Go to the documentation of this file.

#pragma once
 
#include "websockets/common.h"
 
namespace websockets { namespace internals {
  enum ContentType {
    // None as error value
    None = -1,
    // Default value for empty messages
    Continuation = 0x0,
 
    // Data opcdoes
    Text = 0x1,
    Binary = 0x2,
 
    // Control opcodes
    Close = 0x8,
    Ping = 0x9,
    Pong = 0xA
  };
 
  struct WebsocketsFrame {
    uint8_t fin : 1;
    uint8_t opcode : 4;
    uint8_t mask : 1;
    uint8_t mask_buf[4];
    uint64_t payload_length;
    std::string payload;
 
    bool isControlFrame() {
      return fin && (opcode == 0x8 || opcode == 0x9 || opcode == 0xA);
    }
 
    bool isEmpty() {
      return (fin == 0) && (opcode == 0) && (payload_length == 0);
    }
 
    bool isBeginningOfFragmentsStream() const {
      return (fin == 0) && (opcode != 0);
    }
 
    bool isContinuesFragment() const {
      return (fin == 0) && (opcode == 0);
    }
 
    bool isEndOfFragmentsStream() const {
      return (fin == 1) && (opcode == 0);
    }
 
    bool isNormalUnfragmentedMessage() const {
      return (fin == 1) && (opcode != 0);
    }
  };
 
  template <class HeaderTy> HeaderTy MakeHeader(size_t len, uint8_t opcode, bool fin, bool mask) {
    HeaderTy header;
    header.fin = fin;
    header.flags = 0;
    header.opcode = opcode;
    header.mask = mask? 1: 0;
 
    // set payload
    if(len < 126) {
      header.payload = len;
    } else if(len < 65536) {
      header.payload = 126;
    } else {
      header.payload = 127;
    }
 
    return header;
  }
 
  struct Header {
    uint8_t opcode : 4;
    uint8_t flags : 3;
    uint8_t fin : 1;
    uint8_t payload : 7;
    uint8_t mask : 1;
  };
 
  struct HeaderWithExtended16 : Header {
    uint16_t extendedPayload;
  };
 
  struct HeaderWithExtended64 : Header {
    uint64_t extendedPayload;
  };
}} // websockets::internals