Gazebo Transport

API Reference

14.1.0
CIface.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2019 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
18#ifndef INCLUDE_GZ_TRANSPORT_CIFACE_H_
19#define INCLUDE_GZ_TRANSPORT_CIFACE_H_
20
21#include <cstddef>
22
23#include "gz/transport/Export.hh"
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28 typedef struct SubscribeOpts
29 {
30 // cppcheck-suppress unusedStructMember
31 unsigned int msgsPerSec;
33
36
44 const char *_partition);
45
48 void GZ_TRANSPORT_VISIBLE
50
56 int GZ_TRANSPORT_VISIBLE
58 const char *_topic,
59 const char *_msgType);
60
61
68 int GZ_TRANSPORT_VISIBLE
70 const char *_topic,
71 const void *_data,
72 const char *_msgType);
73
80 int GZ_TRANSPORT_VISIBLE
82 const char *_topic,
83 void (*_callback)(const char *, size_t, const char *, void *),
84 void *_userData);
85
93 int GZ_TRANSPORT_VISIBLE
95 const char *_topic, SubscribeOpts _opts,
96 void (*_callback)(const char *, size_t, const char *, void *),
97 void *_userData);
98
105 int GZ_TRANSPORT_VISIBLE
107 void (*_callback)(char *, size_t, char *, void *),
108 void *_userData);
109
114 int GZ_TRANSPORT_VISIBLE
115 gzTransportUnsubscribe(GzTransportNode *_node, const char *_topic);
116
120 void GZ_TRANSPORT_VISIBLE gzTransportWaitForShutdown();
121
122 const auto GZ_DEPRECATED(12) ignTransportNodeCreate = gzTransportNodeCreate;
123 const auto GZ_DEPRECATED(12) ignTransportNodeDestroy = gzTransportNodeDestroy;
124 const auto GZ_DEPRECATED(12) ignTransportAdvertise = gzTransportAdvertise;
125 const auto GZ_DEPRECATED(12) ignTransportPublish = gzTransportPublish;
126 const auto GZ_DEPRECATED(12) ignTransportSubscribe = gzTransportSubscribe;
127 const auto GZ_DEPRECATED(12) ignTransportSubscribeOptions = gzTransportSubscribeOptions;
128 const auto GZ_DEPRECATED(12) ignTransportSubscribeNonConst = gzTransportSubscribeNonConst;
129 const auto GZ_DEPRECATED(12) ignTransportUnsubscribe = gzTransportUnsubscribe;
130 const auto GZ_DEPRECATED(12) ignTransportWaitForShutdown = gzTransportWaitForShutdown;
131
132#ifdef __cplusplus
133}
134#endif
135
136// INCLUDE_GZ_TRANSPORT_CIFACE_H_
137#endif