Click or drag to resize
IListener Interface
The interface for objects that can listen to a stream of bytes and decode them into messages.

Namespace: VirtualRadar.Interface.Listener
Assembly: VirtualRadar.Interface (in VirtualRadar.Interface.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public interface IListener : IBackgroundThreadExceptionCatcher, 
	IDisposable

The IListener type exposes the following members.

Properties
  NameDescription
Public propertyBytesExtractor
Gets the object that can extract the important bytes from the stream. Do not modify any properties on the extractor directly, always use ChangeSource(IConnector, IMessageBytesExtractor, IRawMessageTranslator) to perform configuration changes.
Public propertyConnectionStatus
Gets a value indicating whether the listener is connected to the source of aircraft message data.
Public propertyConnector
Gets the connector that is handling the connection for the listener. Do not modify any properties on the connection directly, always use ChangeSource(IConnector, IMessageBytesExtractor, IRawMessageTranslator) to perform configuration changes.
Public propertyIgnoreBadMessages
Gets or sets a value indicating whether exceptions thrown by the message translator cause a disconnection and raise ExceptionCaught or whether they are ignored.
Public propertyIsSatcomFeed
Gets or sets a value indicating that this is a satcom feed.
Public propertyRawMessageTranslator
Gets the object that translates raw messages into Port30003 format messages. Do not modify any properties on the translator directly, always use ChangeSource(IConnector, IMessageBytesExtractor, IRawMessageTranslator) to perform configuration changes.
Public propertyReceiverId
Gets or sets the identity of the receiver that is controlling this listener.
Public propertyReceiverName
Gets or sets the name of the receiver that is controlling this listener.
Public propertyStatistics
Gets the statistics for the listener.
Public propertyTotalBadMessages
Gets a count of the total number of messages that could not be translated.
Public propertyTotalMessages
Gets a count of the total number of messages received by the object.
Top
Methods
  NameDescription
Public methodChangeSource
Changes the connector and/or message bytes extractor used by the listener.
Public methodConnect
Connects to the source of aircraft data. Incoming messages from the source will raise events on the listener.
Public methodDisconnect
Called implicitly by Dispose, disconnects from the source of aircraft message data.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Top
Events
  NameDescription
Public eventConnectionStateChanged
Raised when the listener connects or disconnects. Note that exceptions raised during parsing of messages will cause the object to automatically disconnect.
Public eventExceptionCaught
Raised when an exception is caught on the background thread. The background thread should not pass ThreadAbortException through this.
(Inherited from IBackgroundThreadExceptionCatcher.)
Public eventModeSBytesReceived
Raised when bytes representing a Mode-S message have been received. This may not be on the same thread that started the listener - however all messages are guaranteed to be transmitted in the order in which they were received.
Public eventModeSMessageReceived
Raised when a message has been received from the source of raw data. This may not be on the same thread that started the listener - however all messages are guaranteed to be transmitted in the order in which they were received.
Public eventPort30003MessageReceived
Raised when a message has been received from a source of Port30003 data. This may not be on the same thread that started the listener - however all messages are guaranteed to be transmitted in the order in which they were received.
Public eventPositionReset
Raised when a decoder that the listener is using to translate messages indicates that the previous position reported for an aircraft was wrong and that its position has been reset.
Public eventRawBytesReceived
Raised when bytes have been received from the data source. This may not be on the same thread that started the listener - however all messages are guaranteed to be transmitted in the order in which they were received.
Public eventSourceChanged
Raised when the listener is asked to change source of data. If the change in source causes a disconnect and reconnect then this event is raised after the disconnect but before the reconnect.
Top
See Also