OSDP.Net 5.2.1
A .NET library for implementing the Open Supervised Device Protocol (OSDP)
Loading...
Searching...
No Matches
OSDP.Net.Model.CommandData.EncryptionKeyConfiguration Class Reference

Command data to set the encryption key configuration on a PD. More...

Inheritance diagram for OSDP.Net.Model.CommandData.EncryptionKeyConfiguration:
OSDP.Net.Model.CommandData.CommandData OSDP.Net.Model.PayloadData

Public Member Functions

 EncryptionKeyConfiguration (KeyType keyType, byte[] keyData)
 Initializes a new instance of the EncryptionKeyConfiguration class.
override ReadOnlySpan< byte > SecurityControlBlock ()
override byte[] BuildData ()
override string ToString ()
Public Member Functions inherited from OSDP.Net.Model.PayloadData
byte[] BuildData ()
 Converts the payload into a byte array to be sent over the wire.
ReadOnlySpan< byte > SecurityControlBlock ()
 Retrieves the security control block for a specific command data type.
virtual void CustomMessageUpdate (Span< byte > messageBuffer)
 Updates the message data before sending in the specified byte buffer.

Static Public Member Functions

static EncryptionKeyConfiguration ParseData (ReadOnlySpan< byte > data)
 Parses the message payload bytes.

Properties

KeyType KeyType [get]
 Gets the type of the key.
byte[] KeyData [get]
 Gets 16 bytes of key data.
override CommandType CommandType [get]
override byte Code [get]
Properties inherited from OSDP.Net.Model.CommandData.CommandData
CommandType CommandType [get]
 Message command code.
Properties inherited from OSDP.Net.Model.PayloadData
byte Code [get]
 Gets the command or reply code byte value that represent the type of data.
virtual bool IsSecurityInitialization [get]
 Gets a value indicating whether the security initialization is performed by this payload.

Additional Inherited Members

Static Protected Member Functions inherited from OSDP.Net.Model.CommandData.CommandData
static T[] SplitData< T > (int size, Func< byte[], T > parseDataFunction, ReadOnlySpan< byte > payloadData)
 Splits data into multiple elements of type T based on a specified size.

Detailed Description

Command data to set the encryption key configuration on a PD.

Definition at line 12 of file EncryptionKeyConfiguration.cs.

Constructor & Destructor Documentation

◆ EncryptionKeyConfiguration()

OSDP.Net.Model.CommandData.EncryptionKeyConfiguration.EncryptionKeyConfiguration ( KeyType keyType,
byte[] keyData )
inline

Initializes a new instance of the EncryptionKeyConfiguration class.

Parameters
keyTypeType of the key.
keyData16 bytes of key data.

Definition at line 19 of file EncryptionKeyConfiguration.cs.

References KeyData, and KeyType.

Referenced by ParseData().

Member Function Documentation

◆ BuildData()

override byte[] OSDP.Net.Model.CommandData.EncryptionKeyConfiguration.BuildData ( )
inline

Definition at line 45 of file EncryptionKeyConfiguration.cs.

References KeyData, and KeyType.

◆ ParseData()

EncryptionKeyConfiguration OSDP.Net.Model.CommandData.EncryptionKeyConfiguration.ParseData ( ReadOnlySpan< byte > data)
inlinestatic

Parses the message payload bytes.

Parameters
dataMessage payload as bytes
Returns
An instance of EncryptionKeyConfiguration representing the message payload

Definition at line 60 of file EncryptionKeyConfiguration.cs.

References EncryptionKeyConfiguration(), and KeyType.

Referenced by OSDP.Net.Device.EnqueuePollReply(), and OSDP.Net.Model.Packet.ParsePayloadData().

◆ ToString()

override string OSDP.Net.Model.CommandData.EncryptionKeyConfiguration.ToString ( )
inline

Definition at line 68 of file EncryptionKeyConfiguration.cs.

Property Documentation

◆ Code

override byte OSDP.Net.Model.CommandData.EncryptionKeyConfiguration.Code
get

Definition at line 39 of file EncryptionKeyConfiguration.cs.

◆ CommandType

override CommandType OSDP.Net.Model.CommandData.EncryptionKeyConfiguration.CommandType
get

Definition at line 36 of file EncryptionKeyConfiguration.cs.

◆ KeyData

byte [] OSDP.Net.Model.CommandData.EncryptionKeyConfiguration.KeyData
get

Gets 16 bytes of key data.

Definition at line 33 of file EncryptionKeyConfiguration.cs.

Referenced by BuildData(), and EncryptionKeyConfiguration().

◆ KeyType

KeyType OSDP.Net.Model.CommandData.EncryptionKeyConfiguration.KeyType
get

Gets the type of the key.

Definition at line 28 of file EncryptionKeyConfiguration.cs.

Referenced by BuildData(), EncryptionKeyConfiguration(), and ParseData().


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