Classes | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
ros::ServiceServer Class Reference

Manages an service advertisement. More...

#include <service_server.h>

Classes

class  Impl
 

Public Member Functions

std::string getService () const
 
 operator void * () const
 
bool operator!= (const ServiceServer &rhs) const
 
bool operator< (const ServiceServer &rhs) const
 
bool operator== (const ServiceServer &rhs) const
 
 ServiceServer ()
 
 ServiceServer (const ServiceServer &rhs)
 
void shutdown ()
 Unadvertise the service associated with this ServiceServer. More...
 
 ~ServiceServer ()
 

Private Types

typedef boost::shared_ptr< ImplImplPtr
 
typedef boost::weak_ptr< ImplImplWPtr
 

Private Member Functions

 ServiceServer (const std::string &service, const NodeHandle &node_handle)
 

Private Attributes

ImplPtr impl_
 

Friends

class NodeHandle
 
class NodeHandleBackingCollection
 

Detailed Description

Manages an service advertisement.

A ServiceServer should always be created through a call to NodeHandle::advertiseService(), or copied from one that was. Once all copies of a specific ServiceServer go out of scope, the service associated with it will be unadvertised and the service callback will stop being called.

Definition at line 45 of file service_server.h.

Member Typedef Documentation

Definition at line 98 of file service_server.h.

typedef boost::weak_ptr<Impl> ros::ServiceServer::ImplWPtr
private

Definition at line 99 of file service_server.h.

Constructor & Destructor Documentation

ros::ServiceServer::ServiceServer ( )
inline

Definition at line 48 of file service_server.h.

ros::ServiceServer::ServiceServer ( const ServiceServer rhs)

Definition at line 65 of file service_server.cpp.

ros::ServiceServer::~ServiceServer ( )

Definition at line 70 of file service_server.cpp.

ros::ServiceServer::ServiceServer ( const std::string &  service,
const NodeHandle node_handle 
)
private

Definition at line 58 of file service_server.cpp.

Member Function Documentation

std::string ros::ServiceServer::getService ( ) const

Definition at line 82 of file service_server.cpp.

ros::ServiceServer::operator void * ( ) const
inline

Definition at line 65 of file service_server.h.

bool ros::ServiceServer::operator!= ( const ServiceServer rhs) const
inline

Definition at line 77 of file service_server.h.

bool ros::ServiceServer::operator< ( const ServiceServer rhs) const
inline

Definition at line 67 of file service_server.h.

bool ros::ServiceServer::operator== ( const ServiceServer rhs) const
inline

Definition at line 72 of file service_server.h.

void ros::ServiceServer::shutdown ( )

Unadvertise the service associated with this ServiceServer.

This method usually does not need to be explicitly called, as automatic shutdown happens when all copies of this ServiceServer go out of scope

This method overrides the automatic reference counted unadvertise, and immediately unadvertises the service associated with this ServiceServer

Definition at line 74 of file service_server.cpp.

Friends And Related Function Documentation

friend class NodeHandle
friend

Definition at line 103 of file service_server.h.

friend class NodeHandleBackingCollection
friend

Definition at line 104 of file service_server.h.

Member Data Documentation

ImplPtr ros::ServiceServer::impl_
private

Definition at line 101 of file service_server.h.


The documentation for this class was generated from the following files:


roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim
autogenerated on Fri Jun 8 2018 02:54:34