WSF
wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType > Class Template Reference

Define a generic service to enable creating, sending, and receiving any UCI message type. More...

#include <WsfUCI_MessageService.hpp>

Inheritance diagram for wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >:
Collaboration diagram for wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >:

Public Member Functions

 UCI_MessageService (UCI_Interface &aInterface, uci::base::AbstractServiceBusConnection *aAsbPtr, const char *aTopic)
virtual ~UCI_MessageService ()=default
 UCI_MessageService ()=delete
 UCI_MessageService (const UCI_MessageService &aSrc)=delete
const UCI_MessageServiceoperator= (const UCI_MessageService &aRhs)=delete
const UCI_FactoryService< MessageType, FactoryType > & GetTypeFactory () const
FactoryType & GetFactory () const
WriterType & GetWriter () const
ReaderType & GetReader () const
void Shutdown ()
Public Member Functions inherited from wsf::UCI_ServiceBase
 UCI_ServiceBase ()=default
virtual ~UCI_ServiceBase ()=default
 UCI_ServiceBase (const UCI_ServiceBase &aSrc)=delete
const UCI_ServiceBaseoperator= (const UCI_ServiceBase &aRhs)=delete

Detailed Description

template<class MessageType, class FactoryType, class ReaderType, class WriterType, class ListenerType>
class wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >

Define a generic service to enable creating, sending, and receiving any UCI message type.

Constructor & Destructor Documentation

◆ UCI_MessageService() [1/3]

template<class MessageType, class FactoryType, class ReaderType, class WriterType, class ListenerType>
wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >::UCI_MessageService ( UCI_Interface & aInterface,
uci::base::AbstractServiceBusConnection * aAsbPtr,
const char * aTopic )
inline

◆ ~UCI_MessageService()

template<class MessageType, class FactoryType, class ReaderType, class WriterType, class ListenerType>
virtual wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >::~UCI_MessageService ( )
virtualdefault

◆ UCI_MessageService() [2/3]

template<class MessageType, class FactoryType, class ReaderType, class WriterType, class ListenerType>
wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >::UCI_MessageService ( )
delete

◆ UCI_MessageService() [3/3]

template<class MessageType, class FactoryType, class ReaderType, class WriterType, class ListenerType>
wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >::UCI_MessageService ( const UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType > & aSrc)
delete

References UCI_MessageService().

Member Function Documentation

◆ GetFactory()

template<class MessageType, class FactoryType, class ReaderType, class WriterType, class ListenerType>
FactoryType & wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >::GetFactory ( ) const
inline

Referenced by UCI_MessageService().

◆ GetReader()

template<class MessageType, class FactoryType, class ReaderType, class WriterType, class ListenerType>
ReaderType & wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >::GetReader ( ) const
inline

◆ GetTypeFactory()

template<class MessageType, class FactoryType, class ReaderType, class WriterType, class ListenerType>
const UCI_FactoryService< MessageType, FactoryType > & wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >::GetTypeFactory ( ) const
inline

◆ GetWriter()

template<class MessageType, class FactoryType, class ReaderType, class WriterType, class ListenerType>
WriterType & wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >::GetWriter ( ) const
inline

◆ operator=()

template<class MessageType, class FactoryType, class ReaderType, class WriterType, class ListenerType>
const UCI_MessageService & wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >::operator= ( const UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType > & aRhs)
delete

References UCI_MessageService().

◆ Shutdown()

template<class MessageType, class FactoryType, class ReaderType, class WriterType, class ListenerType>
void wsf::UCI_MessageService< MessageType, FactoryType, ReaderType, WriterType, ListenerType >::Shutdown ( )
inlinevirtual

This method should be called sometime before object destruction to make sure that any messages still held by the listener are delivered to still-existing objects.

Implements wsf::UCI_ServiceBase.


The documentation for this class was generated from the following file:
Copyrights Multiple, All Rights Reserved