<tt>email</tt>: email-based middleware

email is a publish/subscribe middleware that uses emails to exchange string messages. It also supports request/response communication.

It consists of these main components:

• email initialization/shutdown

  • email::init()

  • email::shutdown()

  • email/init.hpp

• Publisher

  • email::Publisher

  • email/publisher.hpp

• Subscription

  • email::Subscription

  • email/subscription.hpp

• Service Client

  • email::ServiceClient

  • email/service_client.hpp

• Service Server

  • email::ServiceServer

  • email/service_server.hpp

Along with the main components, there are some useful data containers:

• Message Info

  • email::MessageInfo

  • email/message_info.hpp

• Service Request

  • email::ServiceRequest

  • email::ServiceInfo

  • email/service_request.hpp

  • email/service_info.hpp

• GID

  • email::Gid

  • email/gid.hpp

• Timestamp

  • email::Timestamp

  • email/timestamp.hpp

There’s also some waiting- and time-related utilities:

• Guard Condition

  • email::GuardCondition

  • email/guard_condition.hpp

• Wait Set

  • email::WaitSet

  • email/wait_set.hpp

• Wait-related utilities

  • email::wait_for_message()

  • email::wait_for_message_with_info()

  • email::wait_for_request()

  • email::wait_for_request_with_info()

  • email::wait_for_response()

  • email::wait_for_response_with_info()

  • email/wait.hpp

Finally, there is a logging component:

• Logging

  • email::log::create()

  • email::log::get_or_create()

  • email/log.hpp

The remaining headers/components are internal APIs and utilities:

• Context

  • email/context.hpp

• Curl interface

  • email/curl/context.hpp

  • email/curl/executor.hpp

  • email/curl/info.hpp

• Email interface

  • email/email/curl_receiver.hpp

  • email/email/curl_sender.hpp

  • email/email/info.hpp

  • email/email/intra_receiver.hpp

  • email/email/intra_sender.hpp

  • email/email/payload_utils.hpp

  • email/email/receiver.hpp

  • email/email/response_utils.hpp

  • email/email/sender.hpp

• Internal handling of new emails/messages

  • email/email/handler.hpp

  • email/email/polling_manager.hpp

  • email/subscription_handler.hpp

  • email/service_handler.hpp

• Interfaces and base classes

  • email/communication_info.hpp

  • email/gid_object.hpp

  • email/named_object.hpp

  • email/pub_sub.hpp

  • email/service.hpp

• Options

  • email/options.hpp

• Containers

  • email/safe_map.hpp

  • email/safe_queue.hpp

• Utilities

  • email/utils.hpp

• Macros

  • email/macros.hpp

  • email/visibility_control.hpp

Class Hierarchy

• • Namespace email
    • Namespace email::log
      • Class LoggingError
      • Class LoggingNotInitializedError
      • Enum Level
    • Struct ConnectionInfo
    • Struct EmailContent
    • Struct EmailData
    • Struct EmailRecipients
    • Struct ProtocolInfo
    • Struct ServiceRequest
    • Struct ServiceRequestId
    • Struct UserInfo
    • Class CommunicationInfo
    • Class Context
    • Class ContextAlreadyInitializedError
    • Class ContextError
    • Class ContextInitFailedError
    • Class ContextNotInitializedError
    • Class CurlContext
    • Class CurlEmailReceiver
    • Class CurlEmailSender
      • Struct CurlEmailSender::UploadData
    • Class CurlExecutor
    • Class EmailHandler
    • Class EmailReceiver
    • Class EmailSender
    • Class Gid
    • Class GidObject
    • Class GuardCondition
    • Class GuardConditionAlreadyInUseError
    • Class IntraEmailReceiver
    • Class IntraEmailSender
    • Class MessageInfo
    • Class NamedObject
    • Class ObjectNameInvalidError
    • Class Options
    • Class PollingManager
    • Class Publisher
    • Class PubSubObject
    • Template Class SafeMap
    • Template Class SafeQueue
    • Class ServiceClient
    • Class ServiceHandler
    • Class ServiceInfo
    • Class ServiceNameInvalidError
    • Class ServiceObject
    • Class ServiceServer
    • Class Subscription
    • Class SubscriptionHandler
    • Class Timestamp
    • Class TopicNameInvalidError
    • Class WaitSet
  • Namespace fmt
    • Template Struct formatter< email::EmailContent >
    • Template Struct formatter< email::EmailData >
    • Template Struct formatter< email::EmailHeaders >
    • Template Struct formatter< email::EmailRecipients >
    • Template Struct formatter< email::Gid >
    • Template Struct formatter< email::Timestamp >
    • Template Struct formatter< rcpputils::fs::path >
    • Template Struct formatter< YAML::Node >

File Hierarchy

• • Directory include
    • Directory email
      • Directory curl
        • File context.hpp
        • File executor.hpp
        • File info.hpp
      • Directory email
        • File curl_receiver.hpp
        • File curl_sender.hpp
        • File handler.hpp
        • File info.hpp
        • File intra_receiver.hpp
        • File intra_sender.hpp
        • File payload_utils.hpp
        • File polling_manager.hpp
        • File receiver.hpp
        • File response_utils.hpp
        • File sender.hpp
      • File communication_info.hpp
      • File context.hpp
      • File email.hpp
      • File gid.hpp
      • File gid_object.hpp
      • File guard_condition.hpp
      • File init.hpp
      • File log.hpp
      • File lttng.hpp
      • File macros.hpp
      • File message_info.hpp
      • File named_object.hpp
      • File options.hpp
      • File pub_sub.hpp
      • File publisher.hpp
      • File safe_map.hpp
      • File safe_queue.hpp
      • File service.hpp
      • File service_client.hpp
      • File service_handler.hpp
      • File service_info.hpp
      • File service_request.hpp
      • File service_server.hpp
      • File subscription.hpp
      • File subscription_handler.hpp
      • File timestamp.hpp
      • File utils.hpp
      • File visibility_control.hpp
      • File wait.hpp
      • File wait_set.hpp

Reference

Namespaces

• Namespace email

• Namespace email::log

• Namespace email::utils

• Namespace email::utils::payload

• Namespace email::utils::response

• Namespace fmt

• Namespace std

Classes and Structs

• Struct ConnectionInfo

• Struct CurlEmailSender::UploadData

• Struct EmailContent

• Struct EmailData

• Struct EmailRecipients

• Struct ProtocolInfo

• Struct ServiceRequest

• Struct ServiceRequestId

• Struct UserInfo

• Template Struct formatter< email::EmailContent >

• Template Struct formatter< email::EmailData >

• Template Struct formatter< email::EmailHeaders >

• Template Struct formatter< email::EmailRecipients >

• Template Struct formatter< email::Gid >

• Template Struct formatter< email::Timestamp >

• Template Struct formatter< rcpputils::fs::path >

• Template Struct formatter< YAML::Node >

• Class CommunicationInfo

• Class Context

• Class ContextAlreadyInitializedError

• Class ContextError

• Class ContextInitFailedError

• Class ContextNotInitializedError

• Class CurlContext

• Class CurlEmailReceiver

• Class CurlEmailSender

• Class CurlExecutor

• Class EmailHandler

• Class EmailReceiver

• Class EmailSender

• Class Gid

• Class GidObject

• Class GuardCondition

• Class GuardConditionAlreadyInUseError

• Class IntraEmailReceiver

• Class IntraEmailSender

• Class LoggingError

• Class LoggingNotInitializedError

• Class MessageInfo

• Class NamedObject

• Class ObjectNameInvalidError

• Class Options

• Class PollingManager

• Class Publisher

• Class PubSubObject

• Template Class SafeMap

• Template Class SafeQueue

• Class ServiceClient

• Class ServiceHandler

• Class ServiceInfo

• Class ServiceNameInvalidError

• Class ServiceObject

• Class ServiceServer

• Class Subscription

• Class SubscriptionHandler

• Class Timestamp

• Class TopicNameInvalidError

• Class WaitSet

Enums

• Enum Level

Functions

• Function email::get_global_context

• Function email::init()

• Function email::init(int, char const *const)

• Function email::log::create

• Function email::log::get_or_create

• Function email::log::init

• Function email::log::init_from_env

• Function email::log::remove

• Function email::log::shutdown

• Function email::shutdown

• Function email::utils::full_url

• Function email::utils::get_env_var

• Function email::utils::get_env_var_or_default

• Function email::utils::optional_stoi

• Function email::utils::optional_stoll

• Function email::utils::optional_stoul

• Function email::utils::payload::build_payload(const std::vector<std::string>&, const std::vector<std::string>&, const std::vector<std::string>&, const struct EmailContent&, std::optional<EmailHeaders>, std::optional<std::string>)

• Function email::utils::payload::build_payload(EmailRecipients::SharedPtrConst, const struct EmailContent&, std::optional<EmailHeaders>, std::optional<std::string>)

• Function email::utils::payload::cut_string_if_newline

• Function email::utils::payload::join_list

• Function email::utils::read_file

• Function email::utils::response::get_email_content_from_response

• Function email::utils::response::get_email_data_from_response

• Function email::utils::response::get_email_headers_from_response

• Function email::utils::response::get_header_value

• Function email::utils::response::get_nextuid_from_response

• Function email::utils::split_email_list(const std::string&, const bool)

• Function email::utils::split_email_list(const YAML::Node&)

• Template Function email::utils::string_format

• Function email::utils::thread_append_name

• Function email::utils::thread_get_name

• Function email::utils::thread_set_name

• Function email::utils::yaml_to_string

• Function email::wait_for_message(Subscription *, const std::chrono::milliseconds)

• Function email::wait_for_message(std::shared_ptr<Subscription>, const std::chrono::milliseconds)

• Function email::wait_for_message_with_info(Subscription *, const std::chrono::milliseconds)

• Function email::wait_for_message_with_info(std::shared_ptr<Subscription>, const std::chrono::milliseconds)

• Function email::wait_for_request(ServiceServer *, const std::chrono::milliseconds)

• Function email::wait_for_request(std::shared_ptr<ServiceServer>, const std::chrono::milliseconds)

• Function email::wait_for_request_with_info(ServiceServer *, const std::chrono::milliseconds)

• Function email::wait_for_request_with_info(std::shared_ptr<ServiceServer>, const std::chrono::milliseconds)

• Function email::wait_for_response(const SequenceNumber, ServiceClient *, const std::chrono::milliseconds)

• Function email::wait_for_response(const SequenceNumber, std::shared_ptr<ServiceClient>, const std::chrono::milliseconds)

• Function email::wait_for_response_with_info(const SequenceNumber, ServiceClient *, const std::chrono::milliseconds)

• Function email::wait_for_response_with_info(const SequenceNumber, std::shared_ptr<ServiceClient>, const std::chrono::milliseconds)

Defines

• Define EMAIL_DISABLE_COPY

• Define EMAIL_EXPORT

• Define EMAIL_IMPORT

• Define EMAIL_LOCAL

• Define EMAIL_PUBLIC

• Define EMAIL_PUBLIC_TYPE

• Define EMAIL_SHARED_PTR

• Define EMAIL_SHARED_PTR_CONST

• Define EMAIL_TRACEPOINT

• Define EMAIL_WEAK_PTR

Typedefs

• Typedef email::EmailHeader

• Typedef email::EmailHeaders

• Typedef email::GidValue

• Typedef email::Logger

• Typedef email::SequenceNumber

Directories

• Directory include

• Directory email

• Directory curl

• Directory email

Files

• File communication_info.hpp

• File context.hpp

• File context.hpp

• File curl_receiver.hpp

• File curl_sender.hpp

• File email.hpp

• File executor.hpp

• File gid.hpp

• File gid_object.hpp

• File guard_condition.hpp

• File handler.hpp

• File info.hpp

• File info.hpp

• File init.hpp

• File intra_receiver.hpp

• File intra_sender.hpp

• File log.hpp

• File lttng.hpp

• File macros.hpp

• File message_info.hpp

• File named_object.hpp

• File options.hpp

• File payload_utils.hpp

• File polling_manager.hpp

• File pub_sub.hpp

• File publisher.hpp

• File receiver.hpp

• File response_utils.hpp

• File safe_map.hpp

• File safe_queue.hpp

• File sender.hpp

• File service.hpp

• File service_client.hpp

• File service_handler.hpp

• File service_info.hpp

• File service_request.hpp

• File service_server.hpp

• File subscription.hpp

• File subscription_handler.hpp

• File timestamp.hpp

• File utils.hpp

• File visibility_control.hpp

• File wait.hpp

• File wait_set.hpp