Default |
[Missing <summary> documentation for "T:Brainboxes.IO.DefaultSerialProtocol"]
Inheritance HierarchyNamespace: Brainboxes.IO
Assembly: Brainboxes.IO (in Brainboxes.IO.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxThe DefaultSerialProtocol type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DefaultSerialProtocol | Initializes a new instance of the DefaultSerialProtocol class |
Properties| Name | Description | |
|---|---|---|
 | DataAvailable | Whether there is data available, returns 0 for no data and 1 more 1 or more characters |
| Encoding | The character encoding used to send and receive data, default UTF-8, should be a highly compatible option for text based communication protocols including full compatibility with ASCII |
| Stream |
Set the stream which the protocol data is written and read from
(Inherited from Protocol) |
| TerminatingCharacters | The character or sequence of characters that define the end of a data transmission, this will be automatically added to the end of sent data and stripped from the end of a received data The default terminating-character is \n New Line (Linux Standard Line Ending) Note Default Windows line ending is \r\n Carriage Return New Line, which will still work with this default, For better results with Windows line endings change this value to '\r\n' |
Methods| Name | Description | |
|---|---|---|
| Clone | Make a shallow copy of the DefaultSerialProtocol This means when it is assigned to each port the instance is not shared so each port maintains its own state |
| 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) |
| Receive | Receive data from the serial port decoded in the set encoding Will block until: the timeout is reached in which case an exception is thrown or until the terminating character is found |
| Send | Send data down the serial port encoded in the set encoding |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
See Also