http2_types.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the Apache 2.0 License.
#pragma once
 
#include "ccf/ds/nonstd.h"
#include "ccf/http_configuration.h"
#include "ccf/http_header_map.h"
#include "ccf/http_status.h"
#include "ccf/rest_verb.h"
#include "http_builder.h"
 
#include <list>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
namespace http2
{
  using StreamId = int32_t;
  constexpr static StreamId DEFAULT_STREAM_ID = 0;
 
  using StreamCloseCB = std::function<void(void)>;
 
  // Used to keep track of response state between nghttp2 callbacks and to
  // differentiate unary from streaming responses
  enum class StreamResponseState : uint8_t
  {
    Uninitialised = 0, // No response to send yet
    Closing, // Unary or last frame in stream
    Streaming // Sending data frames to client
  };
 
  struct DataSource
  {
    // Utility class to consume data from underlying data vector in chunks from
    // nghttp2_data_source_read_callback
    std::vector<uint8_t> data;
    size_t consumed = 0;
 
    DataSource() = default;
 
    DataSource(std::vector<uint8_t>&& data_) : data(std::move(data_)) {}
  };
 
  struct StreamData
  {
    struct Incoming
    {
      ccf::http::HeaderMap headers;
      std::vector<uint8_t> body;
    };
    Incoming incoming;
 
    struct Outgoing
    {
      StreamResponseState state = StreamResponseState::Uninitialised;
      bool has_trailers = false;
      DataSource body;
    };
    Outgoing outgoing;
 
    StreamCloseCB close_callback = nullptr;
  };
 
  class AbstractParser
  {
  public:
    virtual ~AbstractParser() = default;
    virtual void handle_completed(
      StreamId stream_id, StreamData* stream_data) = 0;
    virtual std::shared_ptr<StreamData> create_stream(StreamId stream_id) = 0;
    virtual std::shared_ptr<StreamData> get_stream(StreamId stream_id) = 0;
    virtual void destroy_stream(StreamId stream_id) = 0;
    [[nodiscard]] virtual StreamId get_last_stream_id() const = 0;
    [[nodiscard]] virtual ccf::http::ParserConfiguration get_configuration()
      const = 0;
  };
}