BAOS SDK v2  1.0.1
An SDK providing access to IP-BAOS devices through BAOS binary protocol version 2.x
IndicationEvent Class Reference

An Indication event. More...

#include <baos/protocol/Indication.h>

Public Types

enum class  Type {
  SERVERITEM ,
  DP_VALUE ,
  UNKNOWN
}
 The indication types. More...
 
using UPtr = std::unique_ptr< IndicationEvent >
 Alias for an unique pointer from this class.
 
using EventDataType = std::variant< protocol::ServerItems, protocol::DatapointValueStates >
 The possible different payload types.
 

Public Member Functions

 IndicationEvent ()=default
 The default constructor.
 
 IndicationEvent (Type eventT, EventDataType &&pkt, IndPromise &&prom, std::uint64_t mID=0)
 Construct a new Indication Event object. More...
 

Public Attributes

Type eventType {Type::UNKNOWN}
 The indication type.
 
std::uint64_t msgID {0}
 The unqiue message id.
 
IndPromise indPromise
 The indication promise.
 
EventDataType data_
 The payload.
 

Detailed Description

An Indication event.

Represents in indication with its type and payload

Member Enumeration Documentation

◆ Type

enum Type
strong

The indication types.

Enumerator
SERVERITEM 

A server item indication.

DP_VALUE 

A datapoint value change indication.

UNKNOWN 

An indication of unknown type.

Constructor & Destructor Documentation

◆ IndicationEvent()

IndicationEvent ( Type  eventT,
EventDataType &&  pkt,
IndPromise &&  prom,
std::uint64_t  mID = 0 
)
inline

Construct a new Indication Event object.

Parameters
eventTThe IndicationEvent::Type
pktThe paylod / data
promThe promise related to this indication
mIDAn unqiue message id for this indication

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