SmartSoft Component-Developer API
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Smart::ICommunicationPattern Class Reference

This is the base class for all communication-patterns. More...

#include <smartICommunicationPattern.h>

Inheritance diagram for Smart::ICommunicationPattern:
Smart::IShutdownObserver Smart::IClientPattern Smart::IServerPattern Smart::IEventClientPattern< ActivationType, EventType > Smart::IPushClientPattern< DataType > Smart::IQueryClientPattern< RequestType, AnswerType > Smart::ISendClientPattern< DataType > Smart::IEventServerPattern< ActivationType, EventType, UpdateType > Smart::IPushServerPattern< DataType > Smart::IQueryServerPattern< RequestType, AnswerType > Smart::ISendServerPattern< DataType >

Public Member Functions

 ICommunicationPattern (IComponent *component)
 Default Constructor initializing an IShutdownObserver. More...
 
virtual ~ICommunicationPattern ()=default
 Default Destructor. More...
 
- Public Member Functions inherited from Smart::IShutdownObserver
 IShutdownObserver (ShutdownSubject *subject=nullptr)
 The default constructor. More...
 
virtual ~IShutdownObserver ()
 The default destructor. More...
 
virtual void on_shutdown ()=0
 This is the main update method that will be automatically called from the given subject each time the subject undergoes a notable change. More...
 

Protected Member Functions

 ICommunicationPattern (const ICommunicationPattern &)=delete
 
ICommunicationPatternoperator= (const ICommunicationPattern &)=delete
 
 ICommunicationPattern ()=delete
 
- 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

IComponenticomponent
 the internal pointer to the component (can be accessed in derived classes) More...
 

Detailed Description

This is the base class for all communication-patterns.

Each ICommunicationPattern needs to implement the IShutdownObserver interface in order for the instance of an IComponent to manage the shutdown procedures of all attached CommunicationPatterns.

Constructor & Destructor Documentation

◆ ICommunicationPattern() [1/3]

Smart::ICommunicationPattern::ICommunicationPattern ( const ICommunicationPattern )
protecteddelete

◆ ICommunicationPattern() [2/3]

Smart::ICommunicationPattern::ICommunicationPattern ( )
protecteddelete

◆ ICommunicationPattern() [3/3]

Smart::ICommunicationPattern::ICommunicationPattern ( IComponent component)
inline

Default Constructor initializing an IShutdownObserver.

Parameters
componentthe management class of the component

◆ ~ICommunicationPattern()

virtual Smart::ICommunicationPattern::~ICommunicationPattern ( )
virtualdefault

Default Destructor.

Member Function Documentation

◆ operator=()

ICommunicationPattern& Smart::ICommunicationPattern::operator= ( const ICommunicationPattern )
protecteddelete

Member Data Documentation

◆ icomponent

IComponent* Smart::ICommunicationPattern::icomponent
protected

the internal pointer to the component (can be accessed in derived classes)


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