hmbdc
simplify-high-performance-messaging-programming
Sender.hpp
1 #include "hmbdc/Copyright.hpp"
2 #pragma once
3 #include "hmbdc/app/tcpcast/SendTransportEngine.hpp"
4 #include "hmbdc/Traits.hpp"
5 
6 namespace hmbdc { namespace app { namespace tcpcast {
7 
8 /**
9  * @brief fascade class for sending network messages
10  */
11 struct Sender {
12  using ptr = std::shared_ptr<Sender>;
13 private:
14  friend struct NetContext;
15  Sender(SendTransportEngine::ptr transport, comm::Topic const& t)
16  : transport_(transport)
17  , topic_(t) {
18  }
19 
20 
21 public:
22  /**
23  * @brief send a message's first bytes
24  * @details the bytes length could be larger than Message, but needs to
25  * be able to fit in the tansport buffer the sender is associated
26  * with - exception thrown otherwise
27  *
28  * @param msg the message to send
29  * @tparam Message Type
30  * @param len just send the first len bytes of this message
31  * @tparam T integral type
32  */
33  template <typename Message, typename T
34  , typename = std::enable_if<std::is_integral<T>::value>>
35  void send(Message&& msg, T len) {
36  using namespace std;
37  using raw = typename remove_reference<Message>::type;
38  static_assert(std::is_trivially_destructible<raw>::value, "cannot send message with dtor");
39  static_assert(!is_base_of<hasMemoryAttachment, raw>::value
41  , "hasMemoryAttachment has to the first base for Message");
42  transport_->queueBytes(
43  topic_, raw::typeTag, &msg, static_cast<size_t>(len));
44  }
45 
46  /**
47  * @brief send a batch of message asynchronizely
48  * @details although batching could implicitly happen
49  * further performance gain could be achieved by sending more msg in
50  * a batch here
51  *
52  * @param m Message
53  * @tparam Message Type
54  */
55  template <typename... Messages>
56  void send(Messages&&... msgs) {
57  transport_->queue(topic_, std::forward<Messages>(msgs)...);
58  }
59 
60  /**
61  * @brief try to send a batch of message asynchronizely
62  * @details this call does not block and it is transactional - all or none is queued
63  *
64  *
65  * @param msgs messages
66  * @tparam Messages message types
67  * @return true if the messages are queued successfully in bufffer
68  */
69  template <typename... Messages>
70  bool trySend(Messages&&... msgs) {
71  return transport_->tryQueue(topic_, std::forward<Messages>(msgs)...);
72  }
73 
74  /**
75  * @brief send a message asynchronizely - avoiding Message copying
76  * by directly constructing the message in the buffer
77  *
78  * @param args Message's ctor args to construct the Message in the buffer
79  * @tparam Message Type
80  * @tparam typename ... Args args type
81  */
82  template <typename Message, typename ... Args>
83  void sendInPlace(Args&&... args) {
84  transport_->template queueInPlace<Message>(topic_, std::forward<Args>(args)...);
85  }
86 
87  /**
88  * @brief send a message asynchronizely by providing message
89  * in tag and bytes
90  * @details for runtime typed usage when the message type can only be decided
91  * at runtime
92  *
93  * @param tag message tag
94  * @param bytes message byte starting address
95  * @param len byte length of the above
96  */
97  void sendBytes(uint16_t tag, void const* bytes, size_t len) {
98  transport_->queueBytes(topic_, tag, bytes, len);
99  }
100 private:
101  SendTransport::ptr transport_;
102  comm::Topic topic_;
103 };
104 }}}
fascade class for sending network messages
Definition: Sender.hpp:11
void sendInPlace(Args &&... args)
send a message asynchronizely - avoiding Message copying by directly constructing the message in the ...
Definition: Sender.hpp:83
topic as in the publish / subscribe communication paradigm
Definition: Topic.hpp:14
Definition: TypedString.hpp:74
void send(Messages &&... msgs)
send a batch of message asynchronizely
Definition: Sender.hpp:56
Definition: Traits.hpp:35
a singleton that holding tcpcast resources
Definition: NetContext.hpp:44
void sendBytes(uint16_t tag, void const *bytes, size_t len)
send a message asynchronizely by providing message in tag and bytes
Definition: Sender.hpp:97
void send(Message &&msg, T len)
send a message&#39;s first bytes
Definition: Sender.hpp:35
bool trySend(Messages &&... msgs)
try to send a batch of message asynchronizely
Definition: Sender.hpp:70
Definition: Base.hpp:12