An Echo Response (Reply ID 0x01) from the Line Quality Test Procedure, section 3.7. More...
Public Member Functions | |
| EchoResponse (byte sequenceNumber, byte[] data) | |
| Initializes a successful Echo Response carrying echoed test data. | |
| EchoResponse (byte sequenceNumber, EchoStatus status) | |
| Initializes a failed Echo Response. | |
| 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 bool | TryParse (ReadOnlySpan< byte > payload, out EchoResponse response) |
| Attempts to parse an Echo Response from an osdp_MFGREP payload. | |
Properties | |
| byte | SequenceNumber [get] |
| Gets the echoed test sequence number. | |
| EchoStatus | Status [get] |
| Gets the result status. | |
| byte[] | Data [get] |
| Gets the echoed test data. Always empty when Status is non-zero. | |
| 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
An Echo Response (Reply ID 0x01) from the Line Quality Test Procedure, section 3.7.
The responder echoes the bytes it received rather than regenerating them from the pattern. Regenerating would repair a corrupted payload on the way back and hide exactly the bit errors the test exists to find.
Definition at line 16 of file EchoResponse.cs.
Constructor & Destructor Documentation
◆ EchoResponse() [1/2]
|
inline |
Initializes a successful Echo Response carrying echoed test data.
- Parameters
-
sequenceNumber The sequence number from the request. data The test data exactly as received.
Definition at line 25 of file EchoResponse.cs.
Referenced by TryParse().
◆ EchoResponse() [2/2]
|
inline |
Initializes a failed Echo Response.
A non-zero status carries no test data.
- Parameters
-
sequenceNumber The sequence number from the request. status The failure status.
Definition at line 35 of file EchoResponse.cs.
Member Function Documentation
◆ BuildData()
|
inline |
Definition at line 63 of file EchoResponse.cs.
References Data, OSDP.Net.LineQuality.LineQualityProtocol.EchoCommandId, OSDP.Net.LineQuality.LineQualityProtocol.EchoHeaderLength, SequenceNumber, and Status.
◆ TryParse()
|
inlinestatic |
Attempts to parse an Echo Response from an osdp_MFGREP payload.
- Parameters
-
payload The reply payload, starting at the vendor code. response On success, the parsed response.
- Returns
truewhen the payload is a well-formed line quality echo response.
Definition at line 81 of file EchoResponse.cs.
References OSDP.Net.LineQuality.LineQualityProtocol.EchoCommandId, OSDP.Net.LineQuality.LineQualityProtocol.EchoHeaderLength, EchoResponse(), and OSDP.Net.LineQuality.LineQualityProtocol.IsLineQualityVendorCode().
Property Documentation
◆ Code
|
get |
Definition at line 57 of file EchoResponse.cs.
◆ Data
|
get |
Gets the echoed test data. Always empty when Status is non-zero.
Definition at line 54 of file EchoResponse.cs.
Referenced by BuildData().
◆ SequenceNumber
|
get |
Gets the echoed test sequence number.
Definition at line 48 of file EchoResponse.cs.
Referenced by BuildData().
◆ Status
|
get |
The documentation for this class was generated from the following file:
- OSDP.Net/LineQuality/EchoResponse.cs
