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>


class  Impl

Public Member Functions

std::string getService () const
 operator void * () const
bool operator!= (const ServiceServer &rhs) const
bool operator< (const ServiceServer &rhs) const
ServiceServeroperator= (const ServiceServer &other)=default
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_


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

◆ ImplPtr

Definition at line 99 of file service_server.h.

◆ ImplWPtr

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

Definition at line 100 of file service_server.h.

Constructor & Destructor Documentation

◆ ServiceServer() [1/3]

ros::ServiceServer::ServiceServer ( )

Definition at line 48 of file service_server.h.

◆ ServiceServer() [2/3]

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

Definition at line 65 of file service_server.cpp.

◆ ~ServiceServer()

ros::ServiceServer::~ServiceServer ( )

Definition at line 70 of file service_server.cpp.

◆ ServiceServer() [3/3]

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

Definition at line 58 of file service_server.cpp.

Member Function Documentation

◆ getService()

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

Definition at line 82 of file service_server.cpp.

◆ operator void *()

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

Definition at line 66 of file service_server.h.

◆ operator!=()

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

Definition at line 78 of file service_server.h.

◆ operator<()

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

Definition at line 68 of file service_server.h.

◆ operator=()

ServiceServer& ros::ServiceServer::operator= ( const ServiceServer other)

◆ operator==()

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

Definition at line 73 of file service_server.h.

◆ shutdown()

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

◆ NodeHandle

friend class NodeHandle

Definition at line 104 of file service_server.h.

◆ NodeHandleBackingCollection

friend class NodeHandleBackingCollection

Definition at line 105 of file service_server.h.

Member Data Documentation

◆ impl_

ImplPtr ros::ServiceServer::impl_

Definition at line 102 of file service_server.h.

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

Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim, Dirk Thomas , Jacob Perron
autogenerated on Thu Nov 23 2023 04:01:45