mirror of
https://github.com/oxen-io/oxen-mq.git
synced 2023-12-13 21:00:31 +01:00
e17ca30411
lokimq.cpp and lokimq.h were getting monolithic; this splits lokimq.cpp into multiple smaller cpp files by logical purpose for better parallel compilation ability. It also splits up the lokimq.h header slightly by moving the ConnectionID and Message types into their own headers.
55 lines
2.7 KiB
C++
55 lines
2.7 KiB
C++
#pragma once
|
|
#include <vector>
|
|
#include "connections.h"
|
|
|
|
namespace lokimq {
|
|
|
|
class LokiMQ;
|
|
|
|
/// Encapsulates an incoming message from a remote connection with message details plus extra
|
|
/// info need to send a reply back through the proxy thread via the `reply()` method. Note that
|
|
/// this object gets reused: callbacks should use but not store any reference beyond the callback.
|
|
class Message {
|
|
public:
|
|
LokiMQ& lokimq; ///< The owning LokiMQ object
|
|
std::vector<string_view> data; ///< The provided command data parts, if any.
|
|
ConnectionID conn; ///< The connection info for routing a reply; also contains the pubkey/sn status.
|
|
std::string reply_tag; ///< If the invoked command is a request command this is the required reply tag that will be prepended by `send_reply()`.
|
|
|
|
/// Constructor
|
|
Message(LokiMQ& lmq, ConnectionID cid) : lokimq{lmq}, conn{std::move(cid)} {}
|
|
|
|
// Non-copyable
|
|
Message(const Message&) = delete;
|
|
Message& operator=(const Message&) = delete;
|
|
|
|
/// Sends a command back to whomever sent this message. Arguments are forwarded to send() but
|
|
/// with send_option::optional{} added if the originator is not a SN. For SN messages (i.e.
|
|
/// where `sn` is true) this is a "strong" reply by default in that the proxy will attempt to
|
|
/// establish a new connection to the SN if no longer connected. For non-SN messages the reply
|
|
/// will be attempted using the available routing information, but if the connection has already
|
|
/// been closed the reply will be dropped.
|
|
///
|
|
/// If you want to send a non-strong reply even when the remote is a service node then add
|
|
/// an explicit `send_option::optional()` argument.
|
|
template <typename... Args>
|
|
void send_back(string_view, Args&&... args);
|
|
|
|
/// Sends a reply to a request. This takes no command: the command is always the built-in
|
|
/// "REPLY" command, followed by the unique reply tag, then any reply data parts. All other
|
|
/// arguments are as in `send_back()`. You should only send one reply for a command expecting
|
|
/// replies, though this is not enforced: attempting to send multiple replies will simply be
|
|
/// dropped when received by the remote. (Note, however, that it is possible to send multiple
|
|
/// messages -- e.g. you could send a reply and then also call send_back() and/or send_request()
|
|
/// to send more requests back to the sender).
|
|
template <typename... Args>
|
|
void send_reply(Args&&... args);
|
|
|
|
/// Sends a request back to whomever sent this message. This is effectively a wrapper around
|
|
/// lmq.request() that takes care of setting up the recipient arguments.
|
|
template <typename ReplyCallback, typename... Args>
|
|
void send_request(string_view cmd, ReplyCallback&& callback, Args&&... args);
|
|
};
|
|
|
|
}
|