IDeviceC, P Interface

Interface to a Brainboxes Device

Namespace: Brainboxes.IO
Assembly: Brainboxes.IO (in Brainboxes.IO.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public interface IDevice<C, P> : IDisposable
where C : IConnection
where P : IProtocol

Public Interface IDevice(Of C As IConnection, P As IProtocol)
	Inherits IDisposable

type IDevice<'C, 'P when 'C : IConnection when 'P : IProtocol> = 
    interface
        interface IDisposable
    end

C: [Missing <typeparam name="C"/> documentation for "T:Brainboxes.IO.IDevice`2"]
P: [Missing <typeparam name="P"/> documentation for "T:Brainboxes.IO.IDevice`2"]

The IDeviceC, P type exposes the following members.

Properties

	Name	Description
	Connection	The connection to this device
	IsAvailable	Whether the connection to this 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
	Protocol	The protocol used to communicate which this device

Methods

	Name	Description
	Connect	Open Connection to a Brainboxes Device, must be called before SendCommand Throws exception on connection failure
	Disconnect	Disconnect from Brainboxes Device, will be automatically called when class is disposed
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable)

Events

	Name	Description
	DeviceStatusChangedEvent	Event called when the status of the device changes, either the IsConnected Property or the IsAvailable property