Information details of a message packet. More...

Inheritance diagram for OSDP.Net.Model.Packet:

Public Member Functions
	Packet (IncomingMessage message)
	Initializes a new instance of the Packet class from an incoming message.
object	ParsePayloadData ()
	Parse the payload data into an object.

Properties
IncomingMessage	IncomingMessage `[get]`
	The underlying incoming message.
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 it is a reply.
ReplyType?	ReplyType `[get]`
	The type of reply sent or null 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.
ReadOnlySpan< byte >	RawPayloadData `[get]`
	Raw bytes of the payload data.
ReadOnlySpan< byte >	RawData `[get]`
	Raw bytes of the entire message data.

Detailed Description

Information details of a message packet.

Definition at line 13 of file Packet.cs.

Constructor & Destructor Documentation

◆ Packet()

OSDP.Net.Model.Packet.Packet ( IncomingMessage message )

inline

Initializes a new instance of the Packet class from an incoming message.

Parameters

message The incoming message to parse.

Definition at line 23 of file Packet.cs.

References OSDP.Net.Messages.Message.Address, Address, CommandType, IncomingMessage, OSDP.Net.Messages.IncomingMessage.IsUsingCrc, IsUsingCrc, OSDP.Net.Messages.IncomingMessage.IsUsingDefaultKey, OSDP.Net.Messages.Message.MessageType, OSDP.Net.Messages.IncomingMessage.OriginalMessageData, OSDP.Net.Messages.IncomingMessage.Payload, ReplyType, OSDP.Net.Messages.IncomingMessage.Sequence, Sequence, and OSDP.Net.Messages.IncomingMessage.Type.

Member Function Documentation

◆ ParsePayloadData()

object OSDP.Net.Model.Packet.ParsePayloadData ( )

inline

Parse the payload data into an object.

Returns: A message data object representation of the payload data

Implements OSDP.Net.Model.IPacket.

Definition at line 98 of file Packet.cs.

Referenced by OSDP.Net.Tracing.OSDPPacketTextFormatter.FormatPacket().

Property Documentation

◆ Address

byte OSDP.Net.Model.Packet.Address

get

Address of the message.

Implements OSDP.Net.Model.IPacket.

Definition at line 52 of file Packet.cs.

Referenced by Packet().

◆ CommandType

CommandType? OSDP.Net.Model.Packet.CommandType

get

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

Implements OSDP.Net.Model.IPacket.

Definition at line 62 of file Packet.cs.

Referenced by OSDP.Net.Tracing.OSDPPacketTextFormatter.FormatPacket(), Packet(), and ParsePayloadData().

◆ IncomingMessage

IncomingMessage OSDP.Net.Model.Packet.IncomingMessage

get

The underlying incoming message.

Definition at line 47 of file Packet.cs.

Referenced by Packet().

◆ IsPayloadDecrypted

bool OSDP.Net.Model.Packet.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.

Implements OSDP.Net.Model.IPacket.

Definition at line 82 of file Packet.cs.

Referenced by OSDP.Net.Tracing.OSDPPacketTextFormatter.FormatPacket(), and ParsePayloadData().