OSDP.Net.Connections.IOsdpConnection Interface Reference

Defines a connection for communicating via OSDP protocol. More...

Inheritance diagram for OSDP.Net.Connections.IOsdpConnection:

Public Member Functions
Task	Open ()
	Open the connection for communications.
Task	Close ()
	Close the connection for communications.
Task	WriteAsync (byte[] buffer)
	Write to connection.
Task< int >	ReadAsync (byte[] buffer, CancellationToken token)
	Read from connection.

Properties
int	BaudRate [get]
	Speed of the connection.
bool	IsOpen [get]
	Is the connection open and ready to communicate.
TimeSpan	ReplyTimeout [get, set]
	Timeout value waiting for a reply.

Detailed Description

Defines a connection for communicating via OSDP protocol.

Definition at line 10 of file IOsdpConnection.cs.

Member Function Documentation

Close()

Task OSDP.Net.Connections.IOsdpConnection.Close

(

)

Close the connection for communications.

Implemented in OSDP.Net.Connections.OsdpConnection, OSDP.Net.Connections.ReadOnlySerialPortOsdpConnection, OSDP.Net.Connections.SerialPortOsdpConnection, OSDP.Net.Connections.TcpClientOsdpConnection, and OSDP.Net.Connections.TcpServerOsdpConnection.

Open()

Task OSDP.Net.Connections.IOsdpConnection.Open

(

)

Open the connection for communications.

Implemented in OSDP.Net.Connections.OsdpConnection, OSDP.Net.Connections.ReadOnlySerialPortOsdpConnection, OSDP.Net.Connections.SerialPortOsdpConnection, OSDP.Net.Connections.TcpClientOsdpConnection, and OSDP.Net.Connections.TcpServerOsdpConnection.

ReadAsync()

Task< int > OSDP.Net.Connections.IOsdpConnection.ReadAsync	(	byte[]	buffer,
		CancellationToken	token )

Read from connection.

Parameters

buffer	Array of bytes to read
token	Cancellation token to end reading of bytes

Returns

Number of actual bytes read

Implemented in OSDP.Net.Connections.OsdpConnection, OSDP.Net.Connections.ReadOnlySerialPortOsdpConnection, OSDP.Net.Connections.SerialPortOsdpConnection, OSDP.Net.Connections.TcpClientOsdpConnection, and OSDP.Net.Connections.TcpServerOsdpConnection.

WriteAsync()

Task OSDP.Net.Connections.IOsdpConnection.WriteAsync

(

byte[]

buffer

)

Write to connection.

Parameters

buffer

Array of bytes to write

Implemented in OSDP.Net.Connections.OsdpConnection, OSDP.Net.Connections.ReadOnlySerialPortOsdpConnection, OSDP.Net.Connections.SerialPortOsdpConnection, OSDP.Net.Connections.TcpClientOsdpConnection, and OSDP.Net.Connections.TcpServerOsdpConnection.

Property Documentation

BaudRate

int OSDP.Net.Connections.IOsdpConnection.BaudRate

get

Speed of the connection.

Implemented in OSDP.Net.Connections.OsdpConnection.

Definition at line 13 of file IOsdpConnection.cs.

IsOpen

bool OSDP.Net.Connections.IOsdpConnection.IsOpen

get

Is the connection open and ready to communicate.

Implemented in OSDP.Net.Connections.OsdpConnection, OSDP.Net.Connections.TcpClientOsdpConnection, and OSDP.Net.Connections.TcpServerOsdpConnection.

Definition at line 18 of file IOsdpConnection.cs.

ReplyTimeout

TimeSpan OSDP.Net.Connections.IOsdpConnection.ReplyTimeout

getset

Timeout value waiting for a reply.

Implemented in OSDP.Net.Connections.OsdpConnection.

Definition at line 23 of file IOsdpConnection.cs.

---

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

• OSDP.Net/Connections/IOsdpConnection.cs