AceSmartSoft API Documentation
Public Types | Public Member Functions | List of all members
SmartACE::EventServer< P, E, S > Class Template Reference

Template for generating a class which handles the event service on server side. More...

#include <smartEvent.hh>

Inheritance diagram for SmartACE::EventServer< P, E, S >:

Public Types

using IEventServerBase = Smart::IEventServerPattern< P, E, S >
 

Public Member Functions

 EventServer (SmartComponent *component, const std::string &service, IEventTestHandlerPtr handler)
 Constructor. More...
 
virtual ~EventServer ()
 Destructor. More...
 
Smart::StatusCode put (const S &state)
 Initiate testing the event conditions for the activations. More...
 

Detailed Description

template<class P, class E, class S = E>
class SmartACE::EventServer< P, E, S >

Template for generating a class which handles the event service on server side.

Template parameters:

Demonstrated in fifth example

Member Typedef Documentation

◆ IEventServerBase

template<class P , class E , class S = E>
using SmartACE::EventServer< P, E, S >::IEventServerBase = Smart::IEventServerPattern<P,E,S>

Constructor & Destructor Documentation

◆ EventServer()

template<class P , class E , class S = E>
SmartACE::EventServer< P, E, S >::EventServer ( SmartComponent component,
const std::string &  service,
IEventTestHandlerPtr  handler 
)

Constructor.

Parameters
componentmanagement class of the component
servicename of the service
handlertest handler decide if a event needs to fire

◆ ~EventServer()

template<class P , class E , class S = E>
virtual SmartACE::EventServer< P, E, S >::~EventServer ( )
virtual

Destructor.

Properly disconnects all service requestors in case of destruction such that all activations are properly deactivated at client side.

Member Function Documentation

◆ put()

template<class P , class E , class S = E>
Smart::StatusCode SmartACE::EventServer< P, E, S >::put ( const S &  state)

Initiate testing the event conditions for the activations.

Parameters
statecontains the current information checked in testEvent() against the individual activation parameters.
Returns
status code
  • SMART_OK : everything is ok
  • SMART_ERROR_COMMUNICATION : communication problems
  • SMART_ERROR : something went wrong

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