m2etis::pubsub::BasicChannelInterface< EventType > Struct Template Reference

#include <ChannelInterface.h>

Inheritance diagram for m2etis::pubsub::BasicChannelInterface< EventType >:

Public Member Functions
virtual	~BasicChannelInterface ()
	Destructor. More...
virtual void	publish (const typename message::M2Message< EventType >::Ptr msg)=0
	publishes a message on the channel More...
virtual void	subscribe (BasicDeliverCallbackInterface< EventType > &callback, boost::shared_ptr< filter::FilterExp< EventType > >)=0
	subscribes to the channel More...
virtual void	unsubscribe ()=0
virtual void	unsubscribe (boost::shared_ptr< filter::FilterExp< EventType > >)=0
	deregisters single filter More...
virtual ChannelName	getChannel () const =0
	Gets a identification of the channel. More...
virtual std::string	getSelf () const =0
virtual message::M2Message< EventType >::Ptr	createMessage () const =0
virtual message::M2Message< EventType >::Ptr	createMessage (const EventType &payload) const =0

Detailed Description

template<class EventType>
struct m2etis::pubsub::BasicChannelInterface< EventType >

Definition at line 47 of file ChannelInterface.h.

Constructor & Destructor Documentation

template<class EventType>

virtual m2etis::pubsub::BasicChannelInterface< EventType >::~BasicChannelInterface ( )

inlinevirtual

Destructor.

Definition at line 51 of file ChannelInterface.h.

Member Function Documentation

template<class EventType>

virtual message::M2Message<EventType>::Ptr m2etis::pubsub::BasicChannelInterface< EventType >::createMessage ( ) const

pure virtual

Implemented in m2etis::pubsub::Channel< ChannelType, NetworkType, EventType >.

template<class EventType>

virtual message::M2Message<EventType>::Ptr m2etis::pubsub::BasicChannelInterface< EventType >::createMessage ( const EventType &  payload ) const

pure virtual

Implemented in m2etis::pubsub::Channel< ChannelType, NetworkType, EventType >.

template<class EventType>

virtual ChannelName m2etis::pubsub::BasicChannelInterface< EventType >::getChannel ( ) const

pure virtual

Gets a identification of the channel.

Returns

Returns an enum identifying the channel

Implemented in m2etis::pubsub::Channel< ChannelType, NetworkType, EventType >.

template<class EventType>

virtual std::string m2etis::pubsub::BasicChannelInterface< EventType >::getSelf ( ) const

pure virtual

Implemented in m2etis::pubsub::Channel< ChannelType, NetworkType, EventType >.

template<class EventType>

virtual void m2etis::pubsub::BasicChannelInterface< EventType >::publish ( const typename message::M2Message< EventType >::Ptr  msg )

pure virtual

publishes a message on the channel

Parameters

[in]

msg

published message on the channel

Implemented in m2etis::pubsub::Channel< ChannelType, NetworkType, EventType >.

Here is the caller graph for this function:

template<class EventType>

virtual void m2etis::pubsub::BasicChannelInterface< EventType >::subscribe ( BasicDeliverCallbackInterface< EventType > &  callback, boost::shared_ptr< filter::FilterExp< EventType > >    )

pure virtual

subscribes to the channel

Parameters

[in]	callback	callback method
[in]	predicate	filter

Implemented in m2etis::pubsub::Channel< ChannelType, NetworkType, EventType >.

Here is the caller graph for this function:

template<class EventType>

virtual void m2etis::pubsub::BasicChannelInterface< EventType >::unsubscribe ( )

pure virtual

Implemented in m2etis::pubsub::Channel< ChannelType, NetworkType, EventType >.

Here is the caller graph for this function:

template<class EventType>

virtual void m2etis::pubsub::BasicChannelInterface< EventType >::unsubscribe ( boost::shared_ptr< filter::FilterExp< EventType > >  )

pure virtual

deregisters single filter

Parameters

[in]

predicate

filter

---

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

• ChannelInterface.h