callback_queue_interface.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2009, Willow Garage, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of Willow Garage, Inc. nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef ROSCPP_CALLBACK_QUEUE_INTERFACE_H
36 #define ROSCPP_CALLBACK_QUEUE_INTERFACE_H
37 
38 #include <boost/shared_ptr.hpp>
39 #include "common.h"
40 #include "ros/types.h"
41 
42 namespace ros
43 {
44 
48 class ROSCPP_DECL CallbackInterface
49 {
50 public:
55  {
59  };
60 
61  virtual ~CallbackInterface() {}
62 
67  virtual CallResult call() = 0;
72  virtual bool ready() { return true; }
73 };
75 
83 {
84 public:
86 
91  virtual void addCallback(const CallbackInterfacePtr& callback, uint64_t owner_id = 0) = 0;
92 
96  virtual void removeByID(uint64_t owner_id) = 0;
97 };
98 
99 }
100 
101 #endif
ros::CallbackInterface::Invalid
@ Invalid
Call no longer valid.
Definition: callback_queue_interface.h:58
ros::CallbackInterfacePtr
boost::shared_ptr< CallbackInterface > CallbackInterfacePtr
Definition: callback_queue_interface.h:74
ros::service::call
bool call(const std::string &service_name, MReq &req, MRes &res)
Invoke an RPC service.
Definition: service.h:65
boost::shared_ptr< CallbackInterface >
ros
ros::CallbackInterface::CallResult
CallResult
Possible results for the call() method.
Definition: callback_queue_interface.h:54
ros::CallbackInterface::ready
virtual bool ready()
Provides the opportunity for specifying that a callback is not ready to be called before call() actua...
Definition: callback_queue_interface.h:72
ros::CallbackQueueInterface::removeByID
virtual void removeByID(uint64_t owner_id)=0
Remove all callbacks associated with an owner id.
ros::CallbackInterface
Abstract interface for items which can be added to a CallbackQueueInterface.
Definition: callback_queue_interface.h:48
ros::CallbackInterface::Success
@ Success
Call succeeded.
Definition: callback_queue_interface.h:56
ros::CallbackInterface::~CallbackInterface
virtual ~CallbackInterface()
Definition: callback_queue_interface.h:61
ros::CallbackQueueInterface::addCallback
virtual void addCallback(const CallbackInterfacePtr &callback, uint64_t owner_id=0)=0
Add a callback, with an optional owner id. The owner id can be used to remove a set of callbacks from...
ros::CallbackInterface::TryAgain
@ TryAgain
Call not ready, try again later.
Definition: callback_queue_interface.h:57
ros::CallbackQueueInterface::~CallbackQueueInterface
virtual ~CallbackQueueInterface()
Definition: callback_queue_interface.h:85
types.h
ros::CallbackQueueInterface
Abstract interface for a queue used to handle all callbacks within roscpp.
Definition: callback_queue_interface.h:82


roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim, Dirk Thomas
autogenerated on Sat Oct 17 2020 19:28:47