AceSmartSoft API Documentation
Classes | Typedefs | Enumerations | Functions | Variables
SmartACE Namespace Reference

Namespace of the framework. More...

Classes

class  CommParameterRequest
 
class  CommParameterResponse
 
class  EventClient
 Handles the event service on client side. More...
 
class  EventClientConnector
 
class  EventClientServiceHandler
 
class  EventHandler
 Handler class to process fired events asynchronously at the client. More...
 
class  EventServer
 Template for generating a class which handles the event service on server side. More...
 
class  EventServerAcceptor
 
class  EventServerServiceHandler
 
class  EventTestHandler
 Condition Test Handler (decides at server whether event fires or not). More...
 
class  IniParameterError
 Exception class to describe errors while processing parameters in SmartParameter. More...
 
class  ManagedTask
 Wrapper for active objects. More...
 
class  MessageQueue
 unbounded message queue for communication between threads. More...
 
class  NSAdapterACE
 This class defines the client-side interface of the Naming-Service. More...
 
class  NSKeyType
 This helper class encapsulates the "name" part of the name-value pair of a naming-service entry. More...
 
class  NSProxy
 
class  NSValueType
 
class  ParameterMaster
 Master part of parameter pattern. More...
 
class  ParameterSlave
 Slave part of Parameter pattern. More...
 
class  ParameterUpdateHandler
 
class  ParamResponseType
 
class  PushClient
 Client part of the Push pattern to provide a flexible push service. More...
 
class  PushClientConnector
 
class  PushClientServiceHandler
 
class  PushServer
 Server part of the Push pattern to provide a push timed service. More...
 
class  PushServerAcceptor
 
class  PushServerServiceHandler
 
class  QueryClient
 Client part of query pattern to perform two-way communication. More...
 
class  QueryClientConnector
 
class  QueryClientServiceHandler
 
class  QueryServer
 server query template. More...
 
class  QueryServerAcceptor
 
class  QueryServerHandler
 Handler Class for QueryServer for incoming requests. More...
 
class  QueryServerServiceHandler
 
class  ReactorTask
 
class  ScopedStateLock
 
class  SendClient
 Client part of one-way communication pattern. More...
 
class  SendClientConnector
 
class  SendClientServiceHandler
 
class  SendServer
 Server part of one-way communication pattern. More...
 
class  SendServerAcceptor
 
class  SendServerHandler
 Handler Class for SendServer for incoming commands. More...
 
class  SendServerServiceHandler
 
class  ServiceHandler
 
class  ShutdownTimer
 
class  SIDhandler
 
class  SmartAdministrativeMonitor
 
class  SmartCntCondClass
 
class  SmartCommStateRequest
 
class  SmartCommStateResponse
 
class  SmartCommWiring
 
class  SmartComponent
 Component management class. More...
 
class  SmartCondClass
 
class  SmartCVwithMemory
 
class  SmartCVwithoutMemory
 
class  SmartError
 Exception class to describe errors in constructors of communication patterns. More...
 
class  SmartIniParameter
 Ini-parameter management. More...
 
class  SmartMonitor
 
class  SmartQueryClientInterface
 
class  SmartQueryServerInterface
 
class  SmartSendClientInterface
 
class  SmartSendServerInterface
 
class  StateChangeHandler
 Handler class for state changes at the slave. More...
 
class  StateMaster
 Master part of state pattern. More...
 
class  StateSlave
 Slave part of state pattern. More...
 
class  StateSlaveHandler
 
class  StateUpdateThread
 
class  Task
 Base class for active objects. More...
 
class  ThreadQueueQueryHandler
 Decorator for QueryServerHandler to defer handling to another thread. More...
 
class  TimerHandler
 Interface to receive notification from a TimerThread. More...
 
class  TimerHandlerHandleUpcall
 Functor for Timer_Queues. More...
 
class  TimerManagerThread
 single/continuous timer. More...
 
class  WiringHandler
 
class  WiringMaster
 Master part of wiring pattern. More...
 
class  WiringSlave
 Slave part of wiring pattern. More...
 

Typedefs

typedef ACE_Singleton< NSAdapterACE, ACE_Thread_Mutex > NAMING
 
typedef ACE_Thread_Mutex SmartMutex
 typedef of ACE class More...
 
typedef ACE_RW_Thread_Mutex SmartRWMutex
 typedef of ACE class More...
 
typedef ACE_Recursive_Thread_Mutex SmartRecursiveMutex
 typedef of ACE class More...
 
typedef ACE_Semaphore SmartSemaphore
 typedef of ACE class More...
 
typedef ACE_Guard< ACE_Thread_Mutex > SmartGuard
 typedef of ACE class More...
 
typedef ACE_Read_Guard< ACE_RW_Thread_Mutex > SmartReadGuard
 typedef of ACE class More...
 
typedef ACE_Write_Guard< ACE_RW_Thread_Mutex > SmartWriteGuard
 typedef of ACE class More...
 
typedef ACE_Guard< ACE_Recursive_Thread_Mutex > SmartRecursiveGuard
 typedef of ACE class More...
 
typedef ACE_Condition_Thread_Mutex SmartConditionMutex
 typedef of ACE class More...
 
typedef ACE_Condition_Recursive_Thread_Mutex SmartConditionRecursiveMutex
 typedef for a recursive condition variable (used in SmartMonitor class) More...
 
typedef ACE_Time_Value SmartTimeValue
 define an interoperable TimeValue based on the ACE implementation More...
 
typedef ACE_Thread_Manager SmartThreadManager
 typedef of ACE class More...
 
typedef ACE_Thread_Control SmartThreadControl
 typedef of ACE class More...
 
typedef ACE_Thread SmartThread
 typedef of ACE class More...
 
typedef ACE_THR_FUNC SMART_THR_FUNC
 typedef of ACE class More...
 
typedef ACE_thread_t SmartThreadType
 typedef of ACE class More...
 
typedef ACE_hthread_t SmartHThreadType
 typedef of ACE class More...
 
typedef ACE_Message_Block SmartMessageBlock
 
typedef ACE_Timer_Heap_T< Smart::ITimerHandler *, TimerHandlerHandleUpcall< ACE_SYNCH_RECURSIVE_MUTEX >, ACE_SYNCH_RECURSIVE_MUTEX > TimerHeap
 

Enumerations

enum  SmartCommand {
  CMD_CONNECT, CMD_ACK_CONNECT, CMD_DISCARD, CMD_DISCONNECT,
  CMD_ACK_DISCONNECT, CMD_SERVER_INITIATED_DISCONNECT, CMD_COMMAND, CMD_REQUEST,
  CMD_ANSWER, CMD_UPDATE, CMD_SUBSCRIBE, CMD_ACK_SUBSCRIBE,
  CMD_UNSUBSCRIBE, CMD_GET_SERVER_INFO, CMD_SERVER_INFO, CMD_ACTIVATION_STATE,
  CMD_EVENT, CMD_ACTIVATE, CMD_ACK_ACTIVATE, CMD_DEACTIVATE
}
 this enum defines all possible commands between smartsoft-patterns. More...
 
enum  StateCommand {
  STATE_CMD_ERROR, STATE_CMD_SET_STATE, STATE_CMD_GET_CURRENT_STATE, STATE_CMD_GET_MAIN_STATES,
  STATE_CMD_GET_SUB_STATES
}
 

Functions

std::ostream & operator<< (std::ostream &o, const ACE_Time_Value &t)
 easy printing of Time_Values More...
 
std::chrono::steady_clock::duration convertToStdDurFrom (const ACE_Time_Value &time)
 
ACE_Time_Value convertToAceTimeFrom (const std::chrono::steady_clock::duration &dur)
 
template<>
int SmartACE::CommParameterRequest::get< std::string > (const std::string &key, std::string &value) const
 
template<>
int SmartACE::CommParameterRequest::getList< std::string > (const std::string &key, std::list< std::string > &valueList) const
 
std::ostream & operator<< (std::ostream &os, const CommParameterRequest &co)
 
std::ostream & operator<< (std::ostream &os, const CommParameterResponse &co)
 
std::ostream & operator<< (std::ostream &os, const ParamResponseType &e)
 
std::ostream & operator<< (std::ostream &o, const std::exception &e)
 allows printing exceptions based on std::exception More...
 

Variables

const std::string SMART_NONS = "NoNamingService"
 

Detailed Description

Namespace of the framework.

Typedef Documentation

◆ NAMING

typedef ACE_Singleton<NSAdapterACE, ACE_Thread_Mutex> SmartACE::NAMING

◆ SMART_THR_FUNC

typedef ACE_THR_FUNC SmartACE::SMART_THR_FUNC

typedef of ACE class

◆ SmartConditionMutex

typedef ACE_Condition_Thread_Mutex SmartACE::SmartConditionMutex

typedef of ACE class

◆ SmartConditionRecursiveMutex

typedef ACE_Condition_Recursive_Thread_Mutex SmartACE::SmartConditionRecursiveMutex

typedef for a recursive condition variable (used in SmartMonitor class)

◆ SmartGuard

typedef ACE_Guard<ACE_Thread_Mutex> SmartACE::SmartGuard

typedef of ACE class

◆ SmartHThreadType

typedef ACE_hthread_t SmartACE::SmartHThreadType

typedef of ACE class

◆ SmartMessageBlock

typedef ACE_Message_Block SmartACE::SmartMessageBlock

◆ SmartMutex

typedef ACE_Thread_Mutex SmartACE::SmartMutex

typedef of ACE class

◆ SmartReadGuard

typedef ACE_Read_Guard<ACE_RW_Thread_Mutex> SmartACE::SmartReadGuard

typedef of ACE class

◆ SmartRecursiveGuard

typedef ACE_Guard<ACE_Recursive_Thread_Mutex> SmartACE::SmartRecursiveGuard

typedef of ACE class

◆ SmartRecursiveMutex

typedef ACE_Recursive_Thread_Mutex SmartACE::SmartRecursiveMutex

typedef of ACE class

◆ SmartRWMutex

typedef ACE_RW_Thread_Mutex SmartACE::SmartRWMutex

typedef of ACE class

◆ SmartSemaphore

typedef ACE_Semaphore SmartACE::SmartSemaphore

typedef of ACE class

◆ SmartThread

typedef ACE_Thread SmartACE::SmartThread

typedef of ACE class

◆ SmartThreadControl

typedef ACE_Thread_Control SmartACE::SmartThreadControl

typedef of ACE class

◆ SmartThreadManager

typedef ACE_Thread_Manager SmartACE::SmartThreadManager

typedef of ACE class

◆ SmartThreadType

typedef ACE_thread_t SmartACE::SmartThreadType

typedef of ACE class

◆ SmartTimeValue

typedef ACE_Time_Value SmartACE::SmartTimeValue

define an interoperable TimeValue based on the ACE implementation

◆ SmartWriteGuard

typedef ACE_Write_Guard<ACE_RW_Thread_Mutex> SmartACE::SmartWriteGuard

typedef of ACE class

◆ TimerHeap

typedef ACE_Timer_Heap_T<Smart::ITimerHandler *, TimerHandlerHandleUpcall<ACE_SYNCH_RECURSIVE_MUTEX>, ACE_SYNCH_RECURSIVE_MUTEX> SmartACE::TimerHeap

Enumeration Type Documentation

◆ SmartCommand

this enum defines all possible commands between smartsoft-patterns.

This emuneration defines all possible commands between client- and server-patterns in smartsoft-kernel. This command-ids are used as first parameter in every kernel-message-header.

1) Pattern independent commands

Two way connect:

CMD_CONNECT R0 connect command (used in ALL clients)
CMD_ACK_CONNECT A0 acknowledge-connect command (used in ALL servers)


One way discard:

CMD_DISCARD R1 discard command (used in ALL clients)


Two way disconnect:

CMD_DISCONNECT R2 disconnect command (used in ALL clients)
CMD_ACK_DISCONNECT A2 acknowledge-disconnect command (used in ALL servers)


One way server-initiated-disconnect:

CMD_SERVER_INITIATED_DISCONNECT R3 server-initiated-disconnect command (used in ALL servers)


2) Pattern specific commands:

SEND pattern:

CMD_COMMAND send-data command of SEND client pattern


QUERY pattern:

CMD_REQUEST D request-data command of QUERY client pattern
CMD_ANSWER D answer-data command of QUERY server pattern


PUSH_NEWEST pattern:

CMD_UPDATE D update-data command of PUSH_NEWEST server pattern
CMD_SUBSCRIBE R4 subscribe command of PUSH_NEWEST client pattern
CMD_ACK_SUBSCRIBE A4 acknowledge-subscribe command of PUSH_NEWEST server pattern
CMD_UNSUBSCRIBE R5 unsubscribe command of PUSH_NEWEST client pattern


PUSH_TIMED pattern:

CMD_GET_SERVER_INFO R6 get-server-info command of PUSH_TIMED client pattern
CMD_SERVER_INFO A6 send-server-info command of PUSH_TIMED server pattern
CMD_ACTIVATION_STATE R7 send-activation-state command of PUSH_TIMED server pattern


EVENT pattern:

CMD_EVENT D event-data command of EVENT server pattern
CMD_ACTIVATE R4 activate command of EVENT client pattern
CMD_ACK_ACTIVATE A4 acknowledge-activate command of EVENT server pattern
CMD_DEACTIVATE R5 deactivate command of EVENT client pattern
Enumerator
CMD_CONNECT 

R0 connect command.

CMD_ACK_CONNECT 

A0 acknowledge-connect command.

CMD_DISCARD 

R1 discard command.

CMD_DISCONNECT 

R2 disconnect command.

CMD_ACK_DISCONNECT 

A2 acknowledge-disconnect command.

CMD_SERVER_INITIATED_DISCONNECT 

R3 server-initiated-disconnect command.

CMD_COMMAND 

D send-data command.

CMD_REQUEST 

D request-data command.

CMD_ANSWER 

D answer-data command.

CMD_UPDATE 

D update-data command.

CMD_SUBSCRIBE 

R4 subscribe command.

CMD_ACK_SUBSCRIBE 

A4 acknowledge-subscribe command.

CMD_UNSUBSCRIBE 

R5 unsubscribe command.

CMD_GET_SERVER_INFO 

R6 get-server-info command.

CMD_SERVER_INFO 

A6 send-server-info command.

CMD_ACTIVATION_STATE 

R7 send-activation-state command.

CMD_EVENT 

D event-data command.

CMD_ACTIVATE 

R4 activate command.

CMD_ACK_ACTIVATE 

A4 acknowledge-activate command.

CMD_DEACTIVATE 

R5 deactivate command.

◆ StateCommand

Enumerator
STATE_CMD_ERROR 
STATE_CMD_SET_STATE 
STATE_CMD_GET_CURRENT_STATE 
STATE_CMD_GET_MAIN_STATES 
STATE_CMD_GET_SUB_STATES 

Function Documentation

◆ convertToAceTimeFrom()

ACE_Time_Value SmartACE::convertToAceTimeFrom ( const std::chrono::steady_clock::duration &  dur)

◆ convertToStdDurFrom()

std::chrono::steady_clock::duration SmartACE::convertToStdDurFrom ( const ACE_Time_Value &  time)

◆ operator<<() [1/5]

std::ostream& SmartACE::operator<< ( std::ostream &  o,
const std::exception &  e 
)

allows printing exceptions based on std::exception

◆ operator<<() [2/5]

std::ostream& SmartACE::operator<< ( std::ostream &  os,
const CommParameterResponse co 
)
inline

◆ operator<<() [3/5]

std::ostream& SmartACE::operator<< ( std::ostream &  os,
const ParamResponseType e 
)
inline

◆ operator<<() [4/5]

std::ostream& SmartACE::operator<< ( std::ostream &  o,
const ACE_Time_Value &  t 
)

easy printing of Time_Values

◆ operator<<() [5/5]

std::ostream& SmartACE::operator<< ( std::ostream &  os,
const CommParameterRequest co 
)
inline

◆ SmartACE::CommParameterRequest::get< std::string >()

template<>
int SmartACE::SmartACE::CommParameterRequest::get< std::string > ( const std::string &  key,
std::string &  value 
) const
inline

◆ SmartACE::CommParameterRequest::getList< std::string >()

template<>
int SmartACE::SmartACE::CommParameterRequest::getList< std::string > ( const std::string &  key,
std::list< std::string > &  valueList 
) const
inline

Variable Documentation

◆ SMART_NONS

const std::string SmartACE::SMART_NONS = "NoNamingService"