requests.h

Go to the documentation of this file.

/*
 * Copyright Paul Reimer, 2018
 *
 * This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 Unported License.
 * To view a copy of this license, visit
 * https://creativecommons.org/licenses/by-nc-sa/4.0/
 * or send a letter to
 * Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
 */

#pragma once

#include "pid.h"

#include "actor_model_generated.h"

#include "requests_generated.h"

#include <experimental/string_view>
#include <utility>
#include <vector>

namespace Requests {

using RequestPayloadFlatbuffer = flatbuffers::DetachedBuffer;
using ResponsePayloadFlatbuffer = flatbuffers::DetachedBuffer;
using RequestIntentFlatbuffer = flatbuffers::DetachedBuffer;
using RequestIntentFlatbufferRef = flatbuffers::BufferRef<RequestIntent>;
using MutableRequestIntentFlatbuffer = std::vector<uint8_t>;

auto make_request_payload(
  const std::vector<uint8_t>& payload
) -> RequestIntentFlatbuffer;

auto make_request_payload(
  const flatbuffers::DetachedBuffer& payload
) -> RequestIntentFlatbuffer;

auto make_request_payload(
  const std::experimental::string_view payload
) -> RequestIntentFlatbuffer;

auto make_response_payload(
  const UUID::UUID& request_id,
  const std::vector<uint8_t>& payload
) -> RequestIntentFlatbuffer;

auto make_response_payload(
  const UUID::UUID& request_id,
  const flatbuffers::DetachedBuffer& payload
) -> RequestIntentFlatbuffer;

auto make_response_payload(
  const UUID::UUID& request_id,
  const std::experimental::string_view payload
) -> RequestIntentFlatbuffer;

auto make_request_intent(
  const std::experimental::string_view method,
  const std::experimental::string_view uri,
  const std::vector<
    std::pair<std::experimental::string_view, std::experimental::string_view>
  >& query = {},
  const std::vector<
    std::pair<std::experimental::string_view, std::experimental::string_view>
  >& headers = {},
  const std::experimental::string_view body = "",
  const UUID::UUID& to_pid = UUID::NullUUID,
  const ResponseFilter desired_format = ResponseFilter::FullResponseBody,
  const std::experimental::string_view object_path = "",
  const std::experimental::string_view root_type = "",
  const std::experimental::string_view schema_text = "",
  const bool include_headers = false,
  const bool streaming = false
) -> RequestIntentFlatbuffer;

// Update method:
auto set_request_method(
  MutableRequestIntentFlatbuffer& request_intent_mutable_buf,
  const std::experimental::string_view method
) -> bool;

// Update URI:
auto set_request_uri(
  MutableRequestIntentFlatbuffer& request_intent_mutable_buf,
  const std::experimental::string_view uri
) -> bool;

// Update/add header:
auto set_request_header(
  MutableRequestIntentFlatbuffer& request_intent_mutable_buf,
  const std::experimental::string_view k,
  const std::experimental::string_view v
) -> bool;

// Update/add query string arg:
auto set_request_query_arg(
  MutableRequestIntentFlatbuffer& request_intent_mutable_buf,
  const std::experimental::string_view k,
  const std::experimental::string_view v
) -> bool;

// Update/add body:
auto set_request_body(
  MutableRequestIntentFlatbuffer& request_intent_mutable_buf,
  const std::experimental::string_view body
) -> bool;

// Verify Message matches type name, returns a Response*,
// and that Response matches the provided request id.
auto matches(
  const ActorModel::Message& message,
  const std::experimental::string_view type,
  const Response*& response,
  const UUID::UUID& request_intent_id
) -> bool;

// Generate random request intent id, (optionally) set to_pid
auto update_request_intent_ids(
  MutableRequestIntentFlatbuffer& request_intent_mutable_buf,
  const ActorModel::Pid& to_pid = ActorModel::Pid()
) -> bool;

// Return a vector of parsed bytes
auto parse_request_intent(
  const std::experimental::string_view req_fb,
  const ActorModel::Pid& to_pid = ActorModel::Pid()
) -> MutableRequestIntentFlatbuffer;

// Extract the request intent ID from the bytes of a RequestIntent flatbuffer
auto get_request_intent_id(
  const MutableRequestIntentFlatbuffer& request_intent_mutable_buf
) -> const UUID::UUID;

auto get_request_intent_id(
  const RequestIntentFlatbuffer& request_intent_buf
) -> const UUID::UUID;

} // namespace Requests