IConnection Interface |
Interface which describes a connection to a Brainboxes Device
Namespace: Brainboxes.IO
Assembly: Brainboxes.IO (in Brainboxes.IO.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxThe IConnection type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | IsAvailable | Whether this connection to a Brainboxes Device is available, e.g. online or offline. In case of network TCP connection: this is if the device is pingable on the network. In case of serial connection: this is if the device COM port is listed on the system and not open by another process. |
| IsConnected | Whether the Brainboxes Device has an active connection from this connection instance |
| Stream | The Connections underlying stream which it exposes once a connection has been initiated |
| Timeout | Timeout for Reads and Writes |
Methods| Name | Description | |
|---|---|---|
 | Connect | Connect to a Brainboxes Device |
| Disconnect | Disconnect from a Brainboxes Device |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
Events| Name | Description | |
|---|---|---|
 | ConnectionStatusChangedEvent | 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 |
See Also