Click or drag to resize

IConnection Interface

Interface which describes a connection to a Brainboxes Device

Namespace:  Brainboxes.IO
Assembly:  Brainboxes.IO (in Brainboxes.IO.dll) Version: 1.5.0.0 (1.5.0.0)
Syntax
public interface IConnection : IDisposable

The IConnection type exposes the following members.

Properties
  NameDescription
Public propertyIsAvailable
Whether the Brainboxes Device is available, e.g. online or offline
Public propertyIsConnected
Whether the Brainboxes Device is connected
Public propertyStream
The Connections underlying stream which it exposes once a connection has been initiated
Public propertyTimeout
Timeout for Reads and Writes
Top
Methods
  NameDescription
Public methodConnect
Connect to a Brainboxes Device
Public methodDisconnect
Disconnect from a Brainboxes Device
Public methodDispose (Inherited from IDisposable.)
Top
Events
  NameDescription
Public eventConnectionStatusChangedEvent
When the status of the connection changes this event is raised e.g. when IsConnected changes from false to true or when IsAvailable changes: * for example for a TCPConnection if the IP address is goes from online to offline * or for example for a SerialConnection when the COM name is no longer present or in use by another program
Top
See Also