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

Command data to set the keep alive time. More...

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

Public Member Functions

 KeepReaderActive (ushort keepAliveTimeInMilliseconds)
override ReadOnlySpan< byte > SecurityControlBlock ()
override byte[] BuildData ()
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 KeepReaderActive ParseData (ReadOnlySpan< byte > data)
 Parses the message payload bytes.

Properties

ushort KeepAliveTimeInMilliseconds [get]
 Gets the keep alive time in milliseconds.
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 keep alive time.

Definition at line 10 of file KeepReaderActive.cs.

Constructor & Destructor Documentation

◆ KeepReaderActive()

OSDP.Net.Model.CommandData.KeepReaderActive.KeepReaderActive ( ushort keepAliveTimeInMilliseconds)
inline

Definition at line 13 of file KeepReaderActive.cs.

References KeepAliveTimeInMilliseconds.

Referenced by ParseData().

Member Function Documentation

◆ BuildData()

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

Definition at line 37 of file KeepReaderActive.cs.

References KeepAliveTimeInMilliseconds.

◆ ParseData()

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

Parses the message payload bytes.

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

Definition at line 45 of file KeepReaderActive.cs.

References KeepReaderActive().

Referenced by OSDP.Net.Device.EnqueuePollReply().

Property Documentation

◆ Code

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

Definition at line 31 of file KeepReaderActive.cs.

◆ CommandType

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

Definition at line 28 of file KeepReaderActive.cs.

◆ KeepAliveTimeInMilliseconds

ushort OSDP.Net.Model.CommandData.KeepReaderActive.KeepAliveTimeInMilliseconds
get

Gets the keep alive time in milliseconds.

The keep alive time is used to determine how long a connection can remain idle before it is closed. Once the keep alive time elapses without any activity, the connection will be closed.

Definition at line 25 of file KeepReaderActive.cs.

Referenced by BuildData(), and KeepReaderActive().


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