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(!is_base_of<hasMemoryAttachment, raw>::value
40  , "hasMemoryAttachment has to the first base for Message");
41  transport_->queueBytes(
42  topic_, raw::typeTag, &msg, static_cast<size_t>(len));
43  }
44 
45  /**
46  * @brief send a batch of message asynchronizely
47  * @details although batching could implicitly happen
48  * further performance gain could be achieved by sending more msg in
49  * a batch here
50  *
51  * @param m Message
52  * @tparam Message Type
53  */
54  template <typename... Messages>
55  void send(Messages&&... msgs) {
56  transport_->queue(topic_, std::forward<Messages>(msgs)...);
57  }
58 
59  /**
60  * @brief try to send a batch of message asynchronizely
61  * @details this call does not block and it is transactional - all or none is queued
62  *
63  *
64  * @param msgs messages
65  * @tparam Messages message types
66  * @return true if the messages are queued successfully in bufffer
67  */
68  template <typename... Messages>
69  bool trySend(Messages&&... msgs) {
70  return transport_->tryQueue(topic_, std::forward<Messages>(msgs)...);
71  }
72 
73  /**
74  * @brief send a message asynchronizely - avoiding Message copying
75  * by directly constructing the message in the buffer
76  *
77  * @param args Message's ctor args to construct the Message in the buffer
78  * @tparam Message Type
79  * @tparam typename ... Args args type
80  */
81  template <typename Message, typename ... Args>
82  void sendInPlace(Args&&... args) {
83  transport_->template queueInPlace<Message>(topic_, std::forward<Args>(args)...);
84  }
85 
86  /**
87  * @brief send a message asynchronizely by providing message
88  * in tag and bytes
89  * @details for runtime typed usage when the message type can only be decided
90  * at runtime
91  *
92  * @param tag message tag
93  * @param bytes message byte starting address
94  * @param len byte length of the above
95  */
96  void sendBytes(uint16_t tag, void const* bytes, size_t len) {
97  transport_->queueBytes(topic_, tag, bytes, len);
98  }
99 private:
100  SendTransport::ptr transport_;
101  comm::Topic topic_;
102 };
103 }}}
bool trySend(Messages &&...msgs)
try to send a batch of message asynchronizely
Definition: Sender.hpp:69
void send(Messages &&...msgs)
send a batch of message asynchronizely
Definition: Sender.hpp:55
fascade class for sending network messages
Definition: Sender.hpp:11
topic as in the publish / subscribe communication paradigm
Definition: Topic.hpp:14
Definition: TypedString.hpp:74
a singleton that holding tcpcast resources
Definition: NetContext.hpp:44
Definition: Traits.hpp:35
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:96
void send(Message &&msg, T len)
send a message&#39;s first bytes
Definition: Sender.hpp:35
void sendInPlace(Args &&...args)
send a message asynchronizely - avoiding Message copying by directly constructing the message in the ...
Definition: Sender.hpp:82
Definition: Base.hpp:12