PX4 Firmware
PX4 Autopilot Software http://px4.io
PublicationQueued.hpp
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * Copyright (c) 2019 PX4 Development Team. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * 3. Neither the name PX4 nor the names of its contributors may be
16  * used to endorse or promote products derived from this software
17  * without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
26  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  ****************************************************************************/
33 
34 /**
35  * @file PublicationQueued.hpp
36  *
37  */
38 
39 #pragma once
40 
41 #include <px4_platform_common/defines.h>
42 #include <systemlib/err.h>
43 #include <uORB/uORB.h>
44 
45 namespace uORB
46 {
47 
48 /**
49  * Queued publication with queue length set as a message constant (ORB_QUEUE_LENGTH)
50  */
51 template<typename T>
53 {
54 public:
55 
56  /**
57  * Constructor
58  *
59  * @param meta The uORB metadata (usually from the ORB_ID() macro) for the topic.
60  */
61  PublicationQueued(const orb_metadata *meta) : _meta(meta) {}
63  {
64  //orb_unadvertise(_handle);
65  }
66 
67  /**
68  * Publish the struct
69  * @param data The uORB message struct we are updating.
70  */
71  bool publish(const T &data)
72  {
73  if (_handle != nullptr) {
74  return (orb_publish(_meta, _handle, &data) == PX4_OK);
75 
76  } else {
77  orb_advert_t handle = orb_advertise_queue(_meta, &data, T::ORB_QUEUE_LENGTH);
78 
79  if (handle != nullptr) {
80  _handle = handle;
81  return true;
82  }
83  }
84 
85  return false;
86  }
87 
88 protected:
90 
92 };
93 
94 } // namespace uORB
Queued publication with queue length set as a message constant (ORB_QUEUE_LENGTH) ...
API for the uORB lightweight object broker.
const orb_metadata * _meta
bool publish(const T &data)
Publish the struct.
PublicationQueued(const orb_metadata *meta)
Constructor.
orb_advert_t orb_advertise_queue(const struct orb_metadata *meta, const void *data, unsigned int queue_size)
Definition: uORB.cpp:48
uint8_t * data
Definition: dataman.cpp:149
Simple error/warning functions, heavily inspired by the BSD functions of the same names...
__BEGIN_DECLS typedef void * orb_advert_t
ORB topic advertiser handle.
Definition: uORB.h:134
int orb_publish(const struct orb_metadata *meta, orb_advert_t handle, const void *data)
Definition: uORB.cpp:70
Object metadata.
Definition: uORB.h:50