OSDP.Net.Model.IPacket Interface Reference

Represents a parsed OSDP packet with decoded message information. More...

Inheritance diagram for OSDP.Net.Model.IPacket:

Public Member Functions
object?	ParsePayloadData ()
	Parse the payload data into an object.

Properties
byte	Address [get]
	Address of the message.
byte	Sequence [get]
	Sequence number of the message.
CommandType?	CommandType [get]
	The type of command sent or null if it is a reply.
ReplyType?	ReplyType [get]
	The type of reply sent or null if it is a command.
bool	IsUsingCrc [get]
	Is CRC being used.
bool	IsPayloadDecrypted [get]
	Indicates whether the payload was successfully decrypted.
bool	IsSecureMessage [get]
	Indicates if the message was sent via an established secure channel.
bool	IsUsingDefaultKey [get]
	Indicates if the secure channel is using the default key.
ReadOnlyMemory< byte >	RawPayloadData [get]
	Raw bytes of the payload data.
ReadOnlyMemory< byte >	RawData [get]
	Raw bytes of the entire message data.

Detailed Description

Represents a parsed OSDP packet with decoded message information.

This interface enables easier mocking and testing of packet consumers.

Definition at line 12 of file IPacket.cs.

Member Function Documentation

ParsePayloadData()

object? OSDP.Net.Model.IPacket.ParsePayloadData

(

)

Parse the payload data into an object.

Returns

A message data object representation of the payload data

Implemented in OSDP.Net.Model.Packet.

Property Documentation

Address

byte OSDP.Net.Model.IPacket.Address

get

Address of the message.

Implemented in OSDP.Net.Model.Packet.

Definition at line 17 of file IPacket.cs.

CommandType

CommandType? OSDP.Net.Model.IPacket.CommandType

get

The type of command sent or null if it is a reply.

Implemented in OSDP.Net.Model.Packet.

Definition at line 27 of file IPacket.cs.

IsPayloadDecrypted

bool OSDP.Net.Model.IPacket.IsPayloadDecrypted

get

Indicates whether the payload was successfully decrypted.

When true, the payload contains decrypted data that can be parsed. When false, the payload is still encrypted because the secure channel was not established or the required key was not available.

Implemented in OSDP.Net.Model.Packet.

Definition at line 47 of file IPacket.cs.

IsSecureMessage

bool OSDP.Net.Model.IPacket.IsSecureMessage

get

Indicates if the message was sent via an established secure channel.

Implemented in OSDP.Net.Model.Packet.

Definition at line 52 of file IPacket.cs.

IsUsingCrc

bool OSDP.Net.Model.IPacket.IsUsingCrc

get

Is CRC being used.

Implemented in OSDP.Net.Model.Packet.

Definition at line 37 of file IPacket.cs.

IsUsingDefaultKey

bool OSDP.Net.Model.IPacket.IsUsingDefaultKey

get

Indicates if the secure channel is using the default key.

Implemented in OSDP.Net.Model.Packet.

Definition at line 57 of file IPacket.cs.

RawData

ReadOnlyMemory<byte> OSDP.Net.Model.IPacket.RawData

get

Raw bytes of the entire message data.

Implemented in OSDP.Net.Model.Packet.

Definition at line 67 of file IPacket.cs.

RawPayloadData

ReadOnlyMemory<byte> OSDP.Net.Model.IPacket.RawPayloadData

get

Raw bytes of the payload data.

Implemented in OSDP.Net.Model.Packet.

Definition at line 62 of file IPacket.cs.

ReplyType

ReplyType? OSDP.Net.Model.IPacket.ReplyType

get

The type of reply sent or null if it is a command.

Implemented in OSDP.Net.Model.Packet.

Definition at line 32 of file IPacket.cs.

Sequence

byte OSDP.Net.Model.IPacket.Sequence

get

Sequence number of the message.

Implemented in OSDP.Net.Model.Packet.

Definition at line 22 of file IPacket.cs.

---

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

• OSDP.Net/Model/IPacket.cs