PLCnext API Documentation 25.0.2.69
|
Namespace for the NotificationManager More...
Namespaces | |
namespace | Services |
Namespace for services of the NotificationManager | |
Classes | |
class | Future |
Future object as proxy for return value an asynchronous function call More... | |
class | Future< void > |
Future object as proxy for return value an asynchronous function call More... | |
class | FutureBase |
Base class with common behavior for Future<T> and Future<void> More... | |
class | GenericPayload |
Generic access to a IPayload More... | |
class | IdType |
Representation of an unique id More... | |
class | INonBlockingNotificationSending |
Interface for non blocking sending of Notifications More... | |
class | INotificationManagerInfo |
Interface for information about the Notification Manager More... | |
class | INotificationReceiving |
Interface for subscribers of Notifications More... | |
class | INotificationSending |
Interface for sending of notifications More... | |
class | INotificationSubscriber |
Interface for subscribers of Notifications More... | |
class | IPayload |
Interface for Paylo objects More... | |
class | LongStringPayloadField |
class | NmSubscribeFailedPayload |
Payload base class for failed subscriptions More... | |
class | NmSubscribeToNotRegisteredPayload |
Payload class for subscribing to a not registered Notification More... | |
class | NmSubscribeToUnregisteredPayload |
Payload class for subscribing to an unregistered Notification More... | |
class | NonBlockingNotificationRegistration |
Proxy object for a non-blocking NotificationRegistration More... | |
class | NonBlockingNotificationRegistration3 |
Proxy object for a non-blocking NotificationRegistration More... | |
class | NonBlockingNotificationRegistration3ArgumentsBuffer |
class | NonBlockingNotificationRegistration3ArgumentsBufferBase |
Internal base class for ArgumentsBuffer More... | |
class | NonBlockingNotificationRegistration3Base |
Internal class for pimpl pattern More... | |
class | NonBlockingNotificationSendingAdapter |
Adapter for INonBlockingNotificationSending with additional functions More... | |
class | Notification |
Contains meta data and paylod of a Notification More... | |
class | NotificationManager |
Primary access to the NotificationManager More... | |
class | NotificationRegistration |
Proxy object for a NotificationRegistration More... | |
class | NotificationRegistrationBase |
Base class with common behavior of NotificationRegistration and NonBlockingNotificationRegistration More... | |
class | NotificationRegistrationInfo |
Information about the registration of a Notification More... | |
class | NotificationSubscriber |
Proxy class for an subscriber of notifications More... | |
class | SpecializedPayload |
Base class for custom Payload classes More... | |
class | SpecializedPayloadHelper |
Helper class to get access to INotificationManagerInfo More... | |
class | StringPayload |
Payload class to send a String More... | |
Typedefs | |
using | NotificationIdType = IdType< Arp::uint64, struct NotificationIdTag > |
type for Notification ids | |
using | NotificationNameIdType = IdType< Arp::uint32, struct NotificationNameIdTag > |
type for Notification name ids | |
using | NotificationNameIdList = std::vector< NotificationNameIdType > |
collection of Notification name ids | |
using | PayloadTypeIdType = IdType< Arp::uint16, struct PayloadTypeIdTag > |
type for Payload type ids | |
using | RawPayloadType = std::vector< Arp::Base::Rsc::Commons::RscVariant< RawPayloadTypeLength > > |
type for the internally transferred payloads | |
using | NotificationDispatcherIdType = IdType< Arp::uint16, struct NotificationDispatcherIdTag > |
type for the Notification dispatcher ids | |
Functions | |
template<typename T , typename TypeTag > | |
std::ostream & | operator<< (std::ostream &os, const Arp::System::Nm::IdType< T, TypeTag > &id) |
template<typename IdType > | |
std::vector< typename IdType::type > | ConvertIdTypesToRawIds (const std::vector< IdType > &ids) |
Converts a vector of IdType to a vector of the underlying type More... | |
template<typename IdType > | |
std::vector< IdType > | ConvertRawIdsToIdTypes (const std::vector< typename IdType::type > &ids) |
Converts a vector of underlying ids to a vector of IdType More... | |
ARP_CXX_SYMBOL_EXPORT std::ostream & | operator<< (std::ostream &os, NotificationRegistrationStatus value) |
ARP_CXX_SYMBOL_EXPORT std::istream & | operator>> (std::istream &is, NotificationRegistrationStatus &value) |
template<typename T , int N> | |
T | rscvariant_cast (const RscVariant< N > &value) |
Casts an RscVariant to T | |
ARP_CXX_SYMBOL_EXPORT std::ostream & | operator<< (std::ostream &os, Severity value) |
ARP_CXX_SYMBOL_EXPORT std::istream & | operator>> (std::istream &is, Severity &value) |
Variables | |
constexpr int | RawPayloadTypeLength = 512 |
length of payload fields | |
enum ARP_CXX_SYMBOL_EXPORT | NotificationRegistrationStatus |
Enumeration to represent the status of the Notification | |
enum ARP_CXX_SYMBOL_EXPORT | Registered = 1 |
enum ARP_CXX_SYMBOL_EXPORT | Unregistered = 2 |
enum ARP_CXX_SYMBOL_EXPORT | Severity |
Enumeration of Severities for notifications | |
enum ARP_CXX_SYMBOL_EXPORT | Info = 1 |
enum ARP_CXX_SYMBOL_EXPORT | Warning = 2 |
enum ARP_CXX_SYMBOL_EXPORT | Error = 3 |
enum ARP_CXX_SYMBOL_EXPORT | Critical = 4 |
enum ARP_CXX_SYMBOL_EXPORT | Fatal = 5 |
enum ARP_CXX_SYMBOL_EXPORT | Emerge = 6 |
Namespace for the NotificationManager
std::vector< typename IdType::type > Arp::System::Nm::ConvertIdTypesToRawIds | ( | const std::vector< IdType > & | ids | ) |
Converts a vector of IdType to a vector of the underlying type
This function is used to enable RSC calls with a list of Ids.