ros::AsyncSpinner Class Reference

AsyncSpinner is a spinner that does not conform to the abstract Spinner interface. Instead, it spins asynchronously when you call start(), and stops when either you call stop(), ros::shutdown() is called, or its destructor is called. More...

#include <spinner.h>

List of all members.

Public Member Functions

 AsyncSpinner (uint32_t thread_count, CallbackQueue *queue)
 Constructor with custom callback queue.
 AsyncSpinner (uint32_t thread_count)
 Simple constructor. Uses the global callback queue.
void start ()
 Start this spinner spinning asynchronously.
void stop ()
 Stop this spinner from running.

Private Attributes

AsyncSpinnerImplPtr impl_

Detailed Description

AsyncSpinner is a spinner that does not conform to the abstract Spinner interface. Instead, it spins asynchronously when you call start(), and stops when either you call stop(), ros::shutdown() is called, or its destructor is called.

AsyncSpinner is reference counted internally, so if you copy one it will continue spinning until all copies have destructed (or stop() has been called on one of them)

Definition at line 92 of file spinner.h.


Constructor & Destructor Documentation

ros::AsyncSpinner::AsyncSpinner ( uint32_t  thread_count  ) 

Simple constructor. Uses the global callback queue.

Parameters:
thread_count The number of threads to use. A value of 0 means to use the number of processor cores

Definition at line 158 of file spinner.cpp.

ros::AsyncSpinner::AsyncSpinner ( uint32_t  thread_count,
CallbackQueue queue 
)

Constructor with custom callback queue.

Parameters:
thread_count The number of threads to use. A value of 0 means to use the number of processor cores
queue The callback queue to operate on. A null value means to use the global queue

Definition at line 163 of file spinner.cpp.


Member Function Documentation

void ros::AsyncSpinner::start (  ) 

Start this spinner spinning asynchronously.

Definition at line 168 of file spinner.cpp.

void ros::AsyncSpinner::stop (  ) 

Stop this spinner from running.

Definition at line 173 of file spinner.cpp.


Member Data Documentation

Definition at line 120 of file spinner.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


roscpp
Author(s): Morgan Quigley mquigley@cs.stanford.edu, Josh Faust jfaust@willowgarage.com, Brian Gerkey gerkey@willowgarage.com
autogenerated on Fri Jan 11 10:08:40 2013