mailbox.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 "received_message.h"
#include "uuid.h"

#include "actor_model_generated.h"

#include <experimental/string_view>
#include <string>
#include <unordered_map>

#include "freertos/FreeRTOS.h"
#include "freertos/ringbuf.h"
#include "freertos/semphr.h"

namespace ActorModel {

class ReceivedMessage;

class Mailbox
{
  friend class ReceivedMessage;
public:
  using string = std::string;
  using string_view = std::experimental::string_view;

  using ReceivedMessagePtr = std::unique_ptr<ReceivedMessage>;

  using Address = UUID::UUID;

  using AddressRegistry = std::unordered_map<
    Address,
    Mailbox*,
    UUID::UUIDHashFunc,
    UUID::UUIDEqualFunc
  >;

  explicit Mailbox(
    const size_t _mailbox_size = 2048,
    const size_t _send_timeout_microseconds = 0,
    const size_t _receive_timeout_microseconds = 0,
    const size_t _receive_lock_timeout_microseconds = 0
  );
  ~Mailbox();

  static auto create_message(
    const string_view type,
    const string_view payload,
    const size_t payload_alignment = sizeof(uint64_t),
    const Pid* from_pid = nullptr
  ) -> flatbuffers::DetachedBuffer;

  auto send(const Message& message)
    -> bool;

  auto send(
    const string_view type,
    const string_view payload,
    const size_t payload_alignment = sizeof(uint64_t),
    const Pid* from_pid = nullptr
  ) -> bool;

  auto receive(bool verify = false)
    -> ReceivedMessagePtr;

  const Address address;

private:
  size_t mailbox_size;
  size_t send_timeout_ticks;
  size_t receive_timeout_ticks;
  size_t receive_lock_timeout_ticks;
  RingbufHandle_t impl;
  SemaphoreHandle_t receive_semaphore = nullptr;
  portMUX_TYPE receive_multicore_mutex;

protected:
  auto release(const string_view message)
    -> bool;

private:
  auto receive_raw()
    -> string_view;

//static methods:
  static auto send(const Address& address, const Message& message)
    -> bool;

  static auto send(
    const Address& address,
    const string_view type,
    const string_view payload
  ) -> bool;

  static AddressRegistry address_registry;
};

} // namespace ActorModel