Click or drag to resize
ISerialConnector Interface
An active connector that connects to a device over a serial COM port.

Namespace: VirtualRadar.Interface.Network
Assembly: VirtualRadar.Interface (in VirtualRadar.Interface.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public interface ISerialConnector : IConnector, 
	IBackgroundThreadExceptionCatcher, IDisposable

The ISerialConnector type exposes the following members.

Properties
  NameDescription
Public propertyAuthentication
Gets or sets the authentication to use with the connection. If this is set then the other side must implement the same authentication.
(Inherited from IConnector.)
Public propertyBaudRate
Gets or sets the baud rate to use.
Public propertyComPort
Gets or sets the COM port to listen to.
Public propertyConnection
Gets the first (or only) connection established by the connector.
(Inherited from IConnector.)
Public propertyConnectionStatus
Gets the connection status. This only reflects the status of the connector - individual connections being maintained by the connector have their own status.
(Inherited from IConnector.)
Public propertyCountExceptions
Gets the number of exceptions ever encountered by the connector.
(Inherited from IConnector.)
Public propertyCreated
Gets the date and time, at UTC, that the connector was first created.
(Inherited from IConnector.)
Public propertyDataBits
Gets or sets the data bits to use.
Public propertyEstablishingConnections (Inherited from IConnector.)
Public propertyHandshake
Gets or sets the handshake protocol to use.
Public propertyHasConnection
Gets a value indicating that the connector has established a connection with at least one end point.
(Inherited from IConnector.)
Public propertyIntent
Gets a description of the intended use of the connector. Only used for diagnostics.
(Inherited from IConnector.)
Public propertyIsPassive
Gets or sets a value indicating whether the connector waits for other things to connect to it or it actively connects to other things.
(Inherited from IConnector.)
Public propertyIsSingleConnection
Gets or sets a value indicating whether the connector supports multiple connections or a single connection.
(Inherited from IConnector.)
Public propertyLastException
Gets the last exception encountered by the connector.
(Inherited from IConnector.)
Public propertyName
Gets or sets the name of the connector.
(Inherited from IConnector.)
Public propertyParity
Gets or sets the parity to use.
Public propertyShutdownText
Gets or sets the text to send across the COM port on shutdown - a null or empty string will disable the feature. Can contain \r and \n.
Public propertyStaleMessageTimeout
Gets the maximum age (in milliseconds) that a message can sit in the transmit queue before it is considered stale and discarded.
(Inherited from IConnector.)
Public propertyStartupText
Gets or sets the text to send across the COM port on startup - a null or empty string will disable the feature. Can contain \r and \n.
Public propertyStopBits
Gets or sets the stop bits to use.
Top
Methods
  NameDescription
Public methodCloseConnection
Tells the connector to close all connections. This blocks until all connections have been shut down.
(Inherited from IConnector.)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodEstablishConnection
Tells the connector to establish a connection. This is a non-blocking call, the function will return immediately and establish the connection in the background.
(Inherited from IConnector.)
Public methodGetActivityHistory
Returns an array of the last so-many activities performed by the connector or any of its connections. Exactly how many is undefined. This always returns the most recent set of activities.
(Inherited from IConnector.)
Public methodGetConnections
Returns an array of established connections made by the connector.
(Inherited from IConnector.)
Public methodGetExceptionHistory
Returns an array of the last so-many exceptions encountered by the connector. Exactly how many is undefined, but it can be more than one and will never exceed CountExceptions. Always returns the most recent set of exceptions.
(Inherited from IConnector.)
Public methodGetFirstConnection
Returns the first established connection or null if there are no connections.
(Inherited from IConnector.)
Public methodRead(Byte, ConnectionReadDelegate)
Reads the next chunk from the first (or only) connection.
(Inherited from IConnector.)
Public methodRead(Byte, Int32, Int32, ConnectionReadDelegate)
Reads the next chunk from the first (or only) connection.
(Inherited from IConnector.)
Public methodRestartConnection
Closes the connection and then establishes the connection.
(Inherited from IConnector.)
Public methodWrite(Byte, Int32)
Writes the content of the buffer to every connection.
(Inherited from IConnector.)
Public methodWrite(Byte, Int32, Int32, Int32)
Writes the content of the buffer to every connection.
(Inherited from IConnector.)
Top
Events
  NameDescription
Public eventActivityRecorded
Raised when an activity is recorded by the connector.
(Inherited from IConnector.)
Public eventAddingConnection
Raised when a connection has been established. The connection will not yet be in the list of established connections, writes on the connector will not go to this connection. Usually raised from a background thread.
(Inherited from IConnector.)
Public eventConnectionClosed
Raised when a connection has been permanently closed. This will usually be raised from a background thread.
(Inherited from IConnector.)
Public eventConnectionEstablished
Raised when a connection has been established. This will usually be raised from a background thread. The connection will be in the list of established connections when this is raised.
(Inherited from IConnector.)
Public eventConnectionStateChanged
Raised when a connection's connection state has changed. This will usually be raised from a background thread. Sender will either be an IConnection or this IConnector.
(Inherited from IConnector.)
Public eventExceptionCaught
Raised when an exception is caught on the background thread. The background thread should not pass ThreadAbortException through this.
(Inherited from IBackgroundThreadExceptionCatcher.)
Top
See Also