SmartSoft Component-Developer API
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Smart::IActiveQueryServerHandler< RequestType, AnswerType > Class Template Reference

#include <smartIProcessingPatterns_T.h>

Inheritance diagram for Smart::IActiveQueryServerHandler< RequestType, AnswerType >:
Smart::IQueryServerHandler< RequestType, AnswerType > Smart::ITask Smart::IShutdownObserver

Public Types

using IQueryServer = IQueryServerPattern< RequestType, AnswerType >
 
using IQueryServerHandlerPtr = std::shared_ptr< Smart::IQueryServerHandler< RequestType, AnswerType > >
 
- Public Types inherited from Smart::IQueryServerHandler< RequestType, AnswerType >
using IQueryServer = IQueryServerPattern< RequestType, AnswerType >
 

Public Member Functions

 IActiveQueryServerHandler (IQueryServerHandlerPtr inner_handler_ptr)
 
virtual ~IActiveQueryServerHandler ()=default
 
- Public Member Functions inherited from Smart::IQueryServerHandler< RequestType, AnswerType >
virtual ~IQueryServerHandler ()=default
 Default destructor. More...
 
- Public Member Functions inherited from Smart::ITask
 ITask (IComponent *component=nullptr)
 Default constructor. More...
 
virtual ~ITask ()=default
 Default destructor. More...
 
virtual int start ()=0
 Creates and starts a new thread (if not yet started) More...
 
virtual int stop (const bool wait_till_stopped=true)=0
 Stops the currently active thread (if it was started before) More...
 
- Public Member Functions inherited from Smart::IShutdownObserver
 IShutdownObserver (ShutdownSubject *subject=nullptr)
 The default constructor. More...
 
virtual ~IShutdownObserver ()
 The default destructor. More...
 

Protected Member Functions

void signal_to_stop ()
 
int process_fifo_queue ()
 
- Protected Member Functions inherited from Smart::ITask
virtual void on_shutdown ()
 Default implementation of the IShutdownObserver interface. More...
 
virtual bool test_canceled ()=0
 Tests whether the thread has been signaled to stop. More...
 
virtual void sleep_for (const Duration &duration)=0
 Blocks execution of the calling thread during the span of time specified by rel_time. More...
 
virtual int task_execution ()=0
 Method which runs in a separate thread if activated. More...
 
- Protected Member Functions inherited from Smart::IShutdownObserver
void attach_self_to (ShutdownSubject *subject)
 call this method from within the constructor of derived classes More...
 
void detach_self_from (ShutdownSubject *subject)
 this method is called within the destructor More...
 

Protected Attributes

std::atomic< bool > signalled_to_stop
 

Member Typedef Documentation

◆ IQueryServer

template<class RequestType , class AnswerType >
using Smart::IActiveQueryServerHandler< RequestType, AnswerType >::IQueryServer = IQueryServerPattern<RequestType,AnswerType>

◆ IQueryServerHandlerPtr

template<class RequestType , class AnswerType >
using Smart::IActiveQueryServerHandler< RequestType, AnswerType >::IQueryServerHandlerPtr = std::shared_ptr<Smart::IQueryServerHandler<RequestType,AnswerType> >

Constructor & Destructor Documentation

◆ IActiveQueryServerHandler()

template<class RequestType , class AnswerType >
Smart::IActiveQueryServerHandler< RequestType, AnswerType >::IActiveQueryServerHandler ( IQueryServerHandlerPtr  inner_handler_ptr)
inline

◆ ~IActiveQueryServerHandler()

template<class RequestType , class AnswerType >
virtual Smart::IActiveQueryServerHandler< RequestType, AnswerType >::~IActiveQueryServerHandler ( )
virtualdefault

Member Function Documentation

◆ process_fifo_queue()

template<class RequestType , class AnswerType >
int Smart::IActiveQueryServerHandler< RequestType, AnswerType >::process_fifo_queue ( )
inlineprotected

◆ signal_to_stop()

template<class RequestType , class AnswerType >
void Smart::IActiveQueryServerHandler< RequestType, AnswerType >::signal_to_stop ( )
inlineprotected

Member Data Documentation

◆ signalled_to_stop

template<class RequestType , class AnswerType >
std::atomic<bool> Smart::IActiveQueryServerHandler< RequestType, AnswerType >::signalled_to_stop
protected

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