Quelle  WebSocketFrame.h   Sprache: C

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_net_WebSocketFrame_h
#define mozilla_net_WebSocketFrame_h

#include <cstdint>
#include "nsISupports.h"
#include "nsIWebSocketEventService.h"
#include "nsString.h"

class PickleIterator;

// Avoid including nsDOMNavigationTiming.h here, where the canonical definition
// of DOMHighResTimeStamp resides.
using DOMHighResTimeStamp = double;

namespace IPC {
class Message;
class MessageReader;
class MessageWriter;
template <class P>
struct ParamTraits;
}  // namespace IPC

namespace mozilla {
namespace net {

class WebSocketFrameData final {
 public:
  WebSocketFrameData();

  explicit WebSocketFrameData(const WebSocketFrameData&) = default;
  WebSocketFrameData(WebSocketFrameData&&) = default;
  WebSocketFrameData& operator=(WebSocketFrameData&&) = default;
  WebSocketFrameData& operator=(const WebSocketFrameData&) = default;

  WebSocketFrameData(DOMHighResTimeStamp aTimeStamp, bool aFinBit,
                     bool aRsvBit1, bool aRsvBit2, bool aRsvBit3,
                     uint8_t aOpCode, bool aMaskBit, uint32_t aMask,
                     const nsCString& aPayload);

  ~WebSocketFrameData() = default;

  // For IPC serialization
  void WriteIPCParams(IPC::MessageWriter* aWriter) const;
  bool ReadIPCParams(IPC::MessageReader* aReader);

  DOMHighResTimeStamp mTimeStamp{0};

  bool mFinBit : 1;
  bool mRsvBit1 : 1;
  bool mRsvBit2 : 1;
  bool mRsvBit3 : 1;
  bool mMaskBit : 1;
  uint8_t mOpCode{0};

  uint32_t mMask{0};

  nsCString mPayload;
};

class WebSocketFrame final : public nsIWebSocketFrame {
 public:
  NS_DECL_THREADSAFE_ISUPPORTS
  NS_DECL_NSIWEBSOCKETFRAME

  explicit WebSocketFrame(const WebSocketFrameData& aData);

  WebSocketFrame(bool aFinBit, bool aRsvBit1, bool aRsvBit2, bool aRsvBit3,
                 uint8_t aOpCode, bool aMaskBit, uint32_t aMask,
                 const nsCString& aPayload);

  const WebSocketFrameData& Data() const { return mData; }

 private:
  ~WebSocketFrame() = default;

  WebSocketFrameData mData;
};

}  // namespace net
}  // namespace mozilla

namespace IPC {
template <>
struct ParamTraits<mozilla::net::WebSocketFrameData> {
  using paramType = mozilla::net::WebSocketFrameData;

  static void Write(MessageWriter* aWriter, const paramType& aParam) {
    aParam.WriteIPCParams(aWriter);
  }

  static bool Read(MessageReader* aReader, paramType* aResult) {
    return aResult->ReadIPCParams(aReader);
  }
};

}  // namespace IPC

#endif  // mozilla_net_WebSocketFrame_h