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

Represents a fragment of data for a multipart message. More...

Public Member Functions

 MessageDataFragment (int totalSize, int offset, ushort fragmentSize, byte[] dataFragment, MessageDataFragmentFieldSize sizeAndOffsetFieldSize)
 Initializes a new instance of the MessageDataFragment class.

Static Public Member Functions

static MessageDataFragment ParseData (ReadOnlySpan< byte > data, MessageDataFragmentFieldSize sizeAndOffsetFieldSize)
 Parses the message payload bytes.

Properties

int TotalSize [get]
 Get the total message data size as little-endian format.
int Offset [get]
 Get the offset of the current message.
ushort FragmentSize [get]
 Get the size of the fragment.
byte[] DataFragment [get]
 Get the fragment data.

Detailed Description

Represents a fragment of data for a multipart message.

Definition at line 27 of file MessageDataFragment.cs.

Constructor & Destructor Documentation

◆ MessageDataFragment()

OSDP.Net.Model.CommandData.MessageDataFragment.MessageDataFragment ( int totalSize,
int offset,
ushort fragmentSize,
byte[] dataFragment,
MessageDataFragmentFieldSize sizeAndOffsetFieldSize )
inline

Initializes a new instance of the MessageDataFragment class.

Parameters
totalSizeTotal message data size as little-endian format
offsetOffset of the current message
fragmentSizeSize of the fragment
dataFragmentMessage fragment data
sizeAndOffsetFieldSizeThe field size used for TotalSize and Offset.

Definition at line 39 of file MessageDataFragment.cs.

References DataFragment, FragmentSize, Offset, and TotalSize.

Referenced by ParseData().

Member Function Documentation

◆ ParseData()

MessageDataFragment OSDP.Net.Model.CommandData.MessageDataFragment.ParseData ( ReadOnlySpan< byte > data,
MessageDataFragmentFieldSize sizeAndOffsetFieldSize )
inlinestatic

Parses the message payload bytes.

Parameters
dataMessage payload as bytes
sizeAndOffsetFieldSizeThe field size used for TotalSize and Offset.
Returns
An instance of MessageDataFragment representing the message payload

Definition at line 84 of file MessageDataFragment.cs.

References MessageDataFragment().

Referenced by OSDP.Net.Model.CommandData.FileTransferFragment.ParseData(), and OSDP.Net.Model.Packet.ParsePayloadData().

Property Documentation

◆ DataFragment

byte [] OSDP.Net.Model.CommandData.MessageDataFragment.DataFragment
get

Get the fragment data.

Definition at line 67 of file MessageDataFragment.cs.

Referenced by MessageDataFragment().

◆ FragmentSize

ushort OSDP.Net.Model.CommandData.MessageDataFragment.FragmentSize
get

Get the size of the fragment.

Definition at line 62 of file MessageDataFragment.cs.

Referenced by MessageDataFragment().

◆ Offset

int OSDP.Net.Model.CommandData.MessageDataFragment.Offset
get

Get the offset of the current message.

Definition at line 57 of file MessageDataFragment.cs.

Referenced by MessageDataFragment().

◆ TotalSize

int OSDP.Net.Model.CommandData.MessageDataFragment.TotalSize
get

Get the total message data size as little-endian format.

Definition at line 52 of file MessageDataFragment.cs.

Referenced by MessageDataFragment().


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