OSDP.Net.Model.ReplyData.FileTransferStatus Class Reference

The PD file transfer status sent as a reply. More...

Inheritance diagram for OSDP.Net.Model.ReplyData.FileTransferStatus:

Public Types
enum	ControlFlags { None = 0x0 , Interleave = 0x1 , LeaveSecureChannel = 0x2 , PollResponseAvailable = 0x4 }
	Control Flags. More...
enum	StatusDetail {   UnknownError = -4 , FileDataUnacceptable = -3 , UnrecognizedFileContents = -2 , AbortFileTransfer = -1 ,   OkToProceed = 0 , FileContentsProcessed = 1 , RebootingNow = 2 , FinishingFileTransfer = 3 ,   UnknownStatus = 4 }
	Status Detail. More...

Public Member Functions
	FileTransferStatus (StatusDetail detail, ControlFlags action=ControlFlags.None, ushort requestedDelay=0, ushort updateMessageMaximum=0)
	Initializes a new instance of the FileTransferStatus class to be sent by a PD in reply to an osdp_FILETRANSFER command.
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.

Properties
ControlFlags	Action [get]
	Gets the control flags.
ushort	RequestedDelay [get]
	Gets the request ACU time delay in milliseconds before next osdp_FILETRANSFER command.
StatusDetail	Detail [get]
	Gets the file transfer status.
ushort	UpdateMessageMaximum [get]
	Gets the alternative maximum message size.
override byte	Code [get]
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.

Detailed Description

The PD file transfer status sent as a reply.

Sent by a PD as osdp_FTSTAT (0x7A) in response to an CommandData.FileTransferFragment. See OSDP v2.2.2 subclause 7.25. An ACU parses an incoming reply with ParseData; a PD builds an outgoing reply with the public constructor.

Definition at line 18 of file FileTransferStatus.cs.

Member Enumeration Documentation

ControlFlags

enum OSDP.Net.Model.ReplyData.FileTransferStatus.ControlFlags

Control Flags.

Enumerator
None	No control flags set; the PD is dedicated to the file transfer, stays in the secure channel, and has no separate poll response available.
Interleave	The ACU may interleave other messages with the file transfer.
LeaveSecureChannel	The ACU shall leave the secure channel for the duration of the file transfer.
PollResponseAvailable	A separate poll response is available.

Definition at line 29 of file FileTransferStatus.cs.

StatusDetail

enum OSDP.Net.Model.ReplyData.FileTransferStatus.StatusDetail

Status Detail.

Enumerator
UnknownError	The error is unknown.
FileDataUnacceptable	The file data unacceptable (malformed).
UnrecognizedFileContents	Unrecognized file contents.
AbortFileTransfer	Abort file transfer.
OkToProceed	OK to proceed.
FileContentsProcessed	The File contents processed.
RebootingNow	Rebooting now, expect full communications reset.
FinishingFileTransfer	PD is finishing file transfer.
UnknownStatus	The status is unknown.

Definition at line 56 of file FileTransferStatus.cs.

Constructor & Destructor Documentation

FileTransferStatus()

OSDP.Net.Model.ReplyData.FileTransferStatus.FileTransferStatus ( StatusDetail detail, ControlFlags action = ControlFlags::None, ushort requestedDelay = 0, ushort updateMessageMaximum = 0 )

inline

Initializes a new instance of the FileTransferStatus class to be sent by a PD in reply to an osdp_FILETRANSFER command.

Parameters

detail	The status of the file transfer.
action	Control flags requesting a change in the ACU's communication procedure.
requestedDelay	Delay in milliseconds the ACU should wait before sending the next osdp_FILETRANSFER command, or zero for no delay.
updateMessageMaximum	Alternate maximum fragment size the ACU should use for the remainder of the transfer, or zero to request no change.

Definition at line 117 of file FileTransferStatus.cs.

References Action, Detail, RequestedDelay, and UpdateMessageMaximum.

Member Function Documentation

BuildData()

override byte[] OSDP.Net.Model.ReplyData.FileTransferStatus.BuildData ( )

inline

Definition at line 145 of file FileTransferStatus.cs.

References Action, Detail, RequestedDelay, and UpdateMessageMaximum.

ToString()

override string OSDP.Net.Model.ReplyData.FileTransferStatus.ToString ( )

inline

Definition at line 188 of file FileTransferStatus.cs.

Property Documentation

Action

ControlFlags OSDP.Net.Model.ReplyData.FileTransferStatus.Action

get

Gets the control flags.

Definition at line 127 of file FileTransferStatus.cs.

Referenced by BuildData(), and FileTransferStatus().

Code

override byte OSDP.Net.Model.ReplyData.FileTransferStatus.Code

get

Definition at line 139 of file FileTransferStatus.cs.

Detail

StatusDetail OSDP.Net.Model.ReplyData.FileTransferStatus.Detail

get

Gets the file transfer status.

Definition at line 133 of file FileTransferStatus.cs.

Referenced by BuildData(), and FileTransferStatus().

RequestedDelay

ushort OSDP.Net.Model.ReplyData.FileTransferStatus.RequestedDelay

get

Gets the request ACU time delay in milliseconds before next osdp_FILETRANSFER command.

Definition at line 130 of file FileTransferStatus.cs.

Referenced by BuildData(), and FileTransferStatus().

UpdateMessageMaximum

ushort OSDP.Net.Model.ReplyData.FileTransferStatus.UpdateMessageMaximum

get

Gets the alternative maximum message size.

Definition at line 136 of file FileTransferStatus.cs.

Referenced by BuildData(), and FileTransferStatus().

---

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

• OSDP.Net/Model/ReplyData/FileTransferStatus.cs