roswrap::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 std::shared_ptr< Impl >	ImplPtr
typedef std::weak_ptr< Impl >	ImplWPtr

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 46 of file service_server.h.

Member Typedef Documentation

ImplPtr

typedef std::shared_ptr<Impl> roswrap::ServiceServer::ImplPtr

private

Definition at line 99 of file service_server.h.

ImplWPtr

typedef std::weak_ptr<Impl> roswrap::ServiceServer::ImplWPtr

private

Definition at line 100 of file service_server.h.

Constructor & Destructor Documentation

ServiceServer() [1/3]

roswrap::ServiceServer::ServiceServer ( )

inline

Definition at line 49 of file service_server.h.

ServiceServer() [2/3]

roswrap::ServiceServer::ServiceServer

(

const ServiceServer &

rhs

)

~ServiceServer()

roswrap::ServiceServer::~ServiceServer

(

)

ServiceServer() [3/3]

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

private

Member Function Documentation

getService()

std::string roswrap::ServiceServer::getService

(

)

const

operator void *()

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

inline

Definition at line 66 of file service_server.h.

operator!=()

bool roswrap::ServiceServer::operator!= ( const ServiceServer &  rhs ) const

inline

Definition at line 78 of file service_server.h.

operator<()

bool roswrap::ServiceServer::operator< ( const ServiceServer &  rhs ) const

inline

Definition at line 68 of file service_server.h.

operator==()

bool roswrap::ServiceServer::operator== ( const ServiceServer &  rhs ) const

inline

Definition at line 73 of file service_server.h.

shutdown()

void roswrap::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

Friends And Related Function Documentation

NodeHandle

friend class NodeHandle

friend

Definition at line 104 of file service_server.h.

NodeHandleBackingCollection

friend class NodeHandleBackingCollection

friend

Definition at line 105 of file service_server.h.

Member Data Documentation

impl_

ImplPtr roswrap::ServiceServer::impl_

private

Definition at line 102 of file service_server.h.

---

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

• service_server.h