Ignition Transport

API Reference

8.1.0
TransportTypes.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2014 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 #ifndef IGN_TRANSPORT_TRANSPORTTYPES_HH_
18 #define IGN_TRANSPORT_TRANSPORTTYPES_HH_
19 
20 #ifdef _MSC_VER
21 #pragma warning(push, 0)
22 #endif
23 #include <google/protobuf/message.h>
24 #ifdef _MSC_VER
25 #pragma warning(pop)
26 #endif
27 
28 #include <chrono>
29 #include <functional>
30 #include <map>
31 #include <memory>
32 #include <string>
33 #include <vector>
34 
35 #include "ignition/transport/config.hh"
37 
38 namespace ignition
39 {
40  namespace transport
41  {
42  // Inline bracket to help doxygen filtering.
43  inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
44  //
46  class IRepHandler;
47  class IReqHandler;
48  class ISubscriptionHandler;
49  class RawSubscriptionHandler;
50  class MessageInfo;
51 
57  template<typename T>
59 
63 
67 
70  using ProtoMsg = google::protobuf::Message;
71 
75 
79 
83 
91 
98 
102 
106 
112  using IReqHandler_M =
114 
120  template <typename T>
122 
126  using MsgDiscoveryCallback =
128 
132  using SrvDiscoveryCallback =
134 
139  template <typename T>
140  using MsgCallback =
142 
149  using RawCallback =
150  std::function<void(const char *_msgData, const size_t _size,
151  const MessageInfo &_info)>;
152 
155  using Timestamp = std::chrono::steady_clock::time_point;
156 
171  using DeallocFunc = void(void *_data, void *_hint);
172 
174  const std::string kGenericMessageType = "google.protobuf.Message";
175 
178  const int kDefaultRcvHwm = 1000;
179 
182  const int kDefaultSndHwm = 1000;
183  }
184  }
185 }
186 #endif
const int kDefaultRcvHwm
The high water mark of the recieve message buffer.
Definition: TransportTypes.hh:178
STL class.
STL class.
const std::string kGenericMessageType
The string type used for generic messages.
Definition: TransportTypes.hh:174
A class that provides information about the message received.
Definition: MessageInfo.hh:37
const int kDefaultSndHwm
The high water mark of the send message buffer.
Definition: TransportTypes.hh:182
void(void *_data, void *_hint) DeallocFunc
Definition: TransportTypes.hh:171
google::protobuf::Message ProtoMsg
Definition: TransportTypes.hh:70
std::chrono::steady_clock::time_point Timestamp
Definition: TransportTypes.hh:155
Definition: AdvertiseOptions.hh:28