TCPConnection Class |
A TCP connection to a Brainboxes Device
Inheritance HierarchyNamespace: Brainboxes.IO
Assembly: Brainboxes.IO (in Brainboxes.IO.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxThe TCPConnection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TCPConnection | Create a TCP Connection to a Brainboxes EDDevice Use Brainboxes Boost.IO to find out the IP address of the Brainboxes EDDevice on your network |
Properties| Name | Description | |
|---|---|---|
 | ConnectionTimeout | Connection timeout for the socket in milliseconds, default 20 seconds This is approximately the same as the TCPClient connection timeout, however unlike the TCPClient, this connection timeout can be altered |
| 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.
(Inherited from Connection) |
| IsConnected |
Whether this connection instance to a Brainboxes Device is active
(Inherited from Connection) |
| Port | The TCP port of the Connection to the Brainboxes Device e.g. "9500" |
| Stream |
The Connections underlying stream class
(Inherited from Connection) |
| Timeout |
The connection and stream timeouts (for both stream read and stream write), measured in millseconds
(Overrides ConnectionTimeout) |
Methods| Name | Description | |
|---|---|---|
| Connect |
Connect to the ED Device
(Inherited from Connection) |
| Disconnect |
Disconnect from the ED Device
(Inherited from Connection) |
| Dispose |
Dispose of this Brainboxes device
(Inherited from Connection) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ToString |
ToString
(Overrides ConnectionToString) |
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 on-line to off-line
* or for example for a SerialConnection when the COM name is no longer present or in use by another program
(Inherited from Connection) |
Fields| Name | Description | |
|---|---|---|
  | DEFAULT_ASCII_PORT | The default port for ASCII |
| DEFAULT_MODBUSTCP_PORT | The default port for Modbus TCP |
| IP | The IP address of the Connection to the Brainboxes Device e.g. "192.168.0.1" |
See Also