Payload class for changes of the link state of an Ethernet port More...
#include <EthernetLinkStatePayload.hpp>
Inheritance diagram for Arp::System::NmPayload::Device::EthernetLinkStatePayload:
Public Types | |
| using | ArgumentsType = std::tuple< uint32, uint32, EthernetLinkState > |
| ArgumentsType to be used with NonBlockingNotificationRegistration3 More... | |
 Public Types inherited from Arp::System::Nm::SpecializedPayload< EthernetLinkStatePayload > | |
| using | ValueType = RawPayloadType::value_type |
| using | FieldType = Arp::System::Rsc::Services::RscType |
Public Member Functions | |
| EthernetLinkStatePayload (const ArgumentsType &args) | |
| Creates a payload object More... | |
| EthernetLinkStatePayload (uint32 interface, uint32 port, EthernetLinkState state) | |
| Creates a payload object More... | |
| uint32 | GetInterface () const |
| Returns the id of interface More... | |
| uint32 | GetPort () const |
| Returns the id of the port More... | |
| EthernetLinkState | GetState () const |
| Returns the state of the interface More... | |
| Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< EthernetLinkStatePayload > | |
| 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 Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< EthernetLinkStatePayload > | |
| static PayloadTypeIdType | GetPayloadTypeId () |
| Returns the PayloadTypeId More... | |
| static const String | GetPayloadTypeName () |
| Returns the PayloadType name More... | |
| Protected Member Functions inherited from Arp::System::Nm::SpecializedPayload< EthernetLinkStatePayload > | |
| 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 Protected Member Functions inherited from Arp::System::Nm::SpecializedPayload< EthernetLinkStatePayload > | |
| static size_t | FieldIndexToFormatStringIndex (size_t fieldIndex) |
Detailed Description
Payload class for changes of the link state of an Ethernet port
This class is used by the device interface to notify of link state changes.
Member Typedef Documentation
◆ ArgumentsType
| using Arp::System::NmPayload::Device::EthernetLinkStatePayload::ArgumentsType = std::tuple<uint32, uint32, EthernetLinkState> |
ArgumentsType to be used with NonBlockingNotificationRegistration3
Constructor & Destructor Documentation
◆ EthernetLinkStatePayload() [1/2]
|
explicit |
Creates a payload object
◆ EthernetLinkStatePayload() [2/2]
| Arp::System::NmPayload::Device::EthernetLinkStatePayload::EthernetLinkStatePayload | ( | uint32 | interface, |
| uint32 | port, | ||
| EthernetLinkState | state | ||
| ) |
Creates a payload object
- Parameters
-
interface id of the interface port id of the port state state of the interface (Up, Down)
Member Function Documentation
◆ GetInterface()
| uint32 Arp::System::NmPayload::Device::EthernetLinkStatePayload::GetInterface | ( | ) | const |
Returns the id of interface
◆ GetPort()
| uint32 Arp::System::NmPayload::Device::EthernetLinkStatePayload::GetPort | ( | ) | const |
Returns the id of the port
◆ GetState()
| EthernetLinkState Arp::System::NmPayload::Device::EthernetLinkStatePayload::GetState | ( | ) | const |
Returns the state of the interface
The documentation for this class was generated from the following file:
- Arp/System/NmPayload/Device/EthernetLinkStatePayload.hpp
