PLCnext API Documentation
22.9.0.33
|
Payload class for changes of the network configuration More...
#include <NetworkConfigurationChangedPayload.hpp>
Public Types | |
using | ArgumentsType = std::tuple< uint32, const char *, const char *, bool > |
ArgumentsType to be used with NonBlockingNotificationRegistration3 More... | |
![]() | |
using | ValueType = RawPayloadType::value_type |
using | FieldType = Arp::System::Rsc::Services::RscType |
Public Member Functions | |
NetworkConfigurationChangedPayload (const ArgumentsType &args) | |
Creates a payload object More... | |
NetworkConfigurationChangedPayload (uint32 deviceId, const String ¶meter, const String &value, bool successful) | |
Creates a payload object More... | |
uint32 | GetDeviceId () const |
Returns the id of the affected device More... | |
String | GetChangedParameter () const |
Returns the name of the changed parameter More... | |
String | GetValued () const |
Returns the new value of the changed parameter More... | |
String | GetValue () const |
Returns the new value of the changed parameter More... | |
![]() | |
SpecializedPayload (const Notification ¬ification) | |
Creates a view on a Notification object More... | |
SpecializedPayload (const GenericPayload &payloadArg) | |
Creates a view on a GenericPayload object More... | |
PayloadTypeIdType | GetId () const final |
Returns the PayloadTypeId More... | |
const String | GetName () const final |
Returns the PayloadTypeName More... | |
const RawPayloadType & | GetAsRawPayloadType () const final |
Returns a reference to the raw payload object More... | |
const String | ToString () const override |
Get a human readable string representation More... | |
RawPayloadType && | MoveOutRawPayload () |
bool | IsReadOnly () const |
Returns true if this object is a view on a Payload More... | |
Additional Inherited Members | |
![]() | |
static PayloadTypeIdType | GetPayloadTypeId () |
Returns the PayloadTypeId More... | |
static const String | GetPayloadTypeName () |
Returns the PayloadType name More... | |
![]() | |
SpecializedPayload (const String &formatString) | |
Creates a SpecializedPayload with an format string More... | |
void | SetFormatString (const String &formatString) |
size_t | AddField () |
Adds a payload field More... | |
size_t | AddField () |
Adds a payload field More... | |
void | SetFieldValue (size_t fieldIndex, const T &value) |
Sets the value of a payload field More... | |
void | SetFieldValue (size_t fieldIndex, T value) |
Sets the value of a payload field More... | |
const T | GetFieldValueAs (size_t fieldIndex) const |
Gets a field value with the specified type More... | |
const T | GetFieldValueAs (size_t fieldIndex) const |
Gets a field value with the specified type More... | |
size_t | GetFieldCount () const |
Gets the number of fields in the payload More... | |
![]() | |
static size_t | FieldIndexToFormatStringIndex (size_t fieldIndex) |
Payload class for changes of the network configuration
This class is used by the device interface to notify of networtk configuration changes.
using Arp::System::NmPayload::Device::NetworkConfigurationChangedPayload::ArgumentsType = std::tuple<uint32, const char*, const char*, bool> |
ArgumentsType to be used with NonBlockingNotificationRegistration3
|
explicit |
Creates a payload object
Arp::System::NmPayload::Device::NetworkConfigurationChangedPayload::NetworkConfigurationChangedPayload | ( | uint32 | deviceId, |
const String & | parameter, | ||
const String & | value, | ||
bool | successful | ||
) |
Creates a payload object
deviceId | id of the changed device |
parameter | changed parameter (e.g. ip-address, netmask, ...) |
value | new value of the changed parameter |
successful | true, if the change was executed successfully |
String Arp::System::NmPayload::Device::NetworkConfigurationChangedPayload::GetChangedParameter | ( | ) | const |
Returns the name of the changed parameter
uint32 Arp::System::NmPayload::Device::NetworkConfigurationChangedPayload::GetDeviceId | ( | ) | const |
Returns the id of the affected device
String Arp::System::NmPayload::Device::NetworkConfigurationChangedPayload::GetValue | ( | ) | const |
Returns the new value of the changed parameter
String Arp::System::NmPayload::Device::NetworkConfigurationChangedPayload::GetValued | ( | ) | const |
Returns the new value of the changed parameter
Deprecated! Use GetValue().