Represents a listener that can receive time-series data in real-time using Sockets.
Declaration Syntax
C# | Visual Basic | Visual C++ |
[ToolboxBitmapAttribute(typeof(DataListener))] public class DataListener : Component, ISupportLifecycle, IDisposable, ISupportInitialize, IProvideStatus, IPersistSettings
<ToolboxBitmapAttribute(GetType(DataListener))> _ Public Class DataListener _ Inherits Component _ Implements ISupportLifecycle, IDisposable, ISupportInitialize, IProvideStatus, _ IPersistSettings
[ToolboxBitmapAttribute(typeof(DataListener))] public ref class DataListener : public Component, ISupportLifecycle, IDisposable, ISupportInitialize, IProvideStatus, IPersistSettings
Members
All Members | Constructors | Methods | Properties | Fields | Events |
Icon | Member | Description |
---|---|---|
DataListener()()() |
Initializes a new instance of the DataListener class.
| |
DataListener(IContainer) |
Initializes a new instance of the DataListener class.
| |
BeginInit()()() |
Performs necessary operations before the DataListener properties are initialized.
| |
CacheData |
Gets or sets a boolean value that indicates whether the Data is to be updated with the latest time-series data.
| |
CanRaiseEvents |
Gets a value indicating whether the component can raise an event.
(Inherited from Component.) | |
ConnectToServer |
Gets or sets a boolean value that indicates whether the DataListener will connect to the Server
for receiving the time-series data or the Server will make a connection to the DataListener on
the specified Port for sending time-series data.
| |
Container |
Gets the IContainer that contains the Component.
(Inherited from Component.) | |
CreateObjRef(Type) |
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.) | |
Data |
Gets the newest time-series data received by the DataListener.
| |
DataChanged |
Occurs when the Data has changed.
| |
DataExtracted |
Occurs when time-series data is extracted from the received packets.
| |
DataInitComplete |
Occurs when the Data is populated completely on Start()()()up.
| |
DataInitFailure | ||
DataInitPartial |
Occurs when the Data cannot be populated completely on Start()()()up.
| |
DataInitStart |
Occurs when the Data is being populated on Start()()()up.
| |
DefaultCacheData |
Specifies the default value for the CacheData property.
| |
DefaultConnectToServer |
Specifies the default value for the ConnectToServer property.
| |
DefaultID |
Specifies the default value for the ID property.
| |
DefaultInitializeData |
Specifies the default value for the InitializeData property.
| |
DefaultInitializeDataTimeout |
Specifies the default value for the InitializeDataTimeout property.
| |
DefaultPersistSettings |
Specifies the default value for the PersistSettings property.
| |
DefaultPort |
Specifies the default value for the Port property.
| |
DefaultProtocol |
Specifies the default value for the Protocol property.
| |
DefaultServer |
Specifies the default value for the Server property.
| |
DefaultSettingsCategory |
Specifies the default value for the SettingsCategory property.
| |
DesignMode |
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.) | |
Dispose(Boolean) |
Releases the unmanaged resources used by the DataListener and optionally releases the managed resources.
(Overrides Component.Dispose(Boolean).) | |
Dispose()()() |
Releases all resources used by the Component.
(Inherited from Component.) | |
Disposed |
Occurs when the component is disposed by a call to the Dispose()()() method.
(Inherited from Component.) | |
Enabled |
Gets or sets a boolean value that indicates whether the DataListener is currently enabled.
| |
EndInit()()() |
Performs necessary operations after the DataListener properties are initialized.
| |
Equals(Object) |
Determines whether the current DataListener object is equal to obj.
(Overrides Object.Equals(Object).) | |
Events |
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.) | |
Finalize()()() |
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.) | |
FindData(Int32) |
Gets the current data for the specified historianID.
| |
GetHashCode()()() |
Returns the hash code for the current DataListener object.
(Overrides Object.GetHashCode()()().) | |
GetLifetimeService()()() |
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.) | |
GetService(Type) | (Inherited from Component.) | |
GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
ID |
Gets or sets the alpha-numeric identifier of the DataListener.
| |
Initialize()()() |
Initializes the DataListener.
| |
InitializeData |
Gets or sets a boolean value that indicates whether the DataListener will initialize the Data from the Server on startup.
| |
InitializeDataTimeout |
Gets or sets the time (in milliseconds) to wait for the Data to be initialized from the Server on Start()()()up.
| |
InitializeLifetimeService()()() |
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.) | |
ListenerStarted |
Occurs when the DataListener has started.
| |
ListenerStarting |
Occurs when the DataListener is starting up.
| |
ListenerStopped |
Occurs when DataListener has stopped.
| |
ListenerStopping |
Occurs when the DataListener is being stopped.
| |
LoadSettings()()() |
Loads saved settings for the DataListener from the config file if the PersistSettings property is set to true.
| |
MemberwiseClone(Boolean) |
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.) | |
MemberwiseClone()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
Name |
Gets the unique identifier of the DataListener.
| |
OnDataChanged()()() |
Raises the DataChanged event.
| |
OnDataExtracted(IList<(Of <(IDataPoint>)>)) |
Raises the DataExtracted event.
| |
OnDataInitComplete()()() |
Raises the DataInitComplete event.
| |
OnDataInitFailure()()() |
Raises the DataInitFailure event.
| |
OnDataInitPartial()()() |
Raises the DataInitPartial event.
| |
OnDataInitStart()()() |
Raises the DataInitStart event.
| |
OnListenerStarted()()() |
Raises the ListenerStarted event.
| |
OnListenerStarting()()() |
Raises the ListenerStarting event.
| |
OnListenerStopped()()() |
Raises the ListenerStopped event.
| |
OnListenerStopping()()() |
Raises the ListenerStopping event.
| |
OnSocketConnected()()() |
Raises the SocketConnected event.
| |
OnSocketConnecting()()() |
Raises the SocketConnecting event.
| |
OnSocketDisconnected()()() |
Raises the SocketDisconnected event.
| |
Parser |
Gets the underlying PacketParser used the DataListener for extracting the time-series data.
| |
PersistSettings |
Gets or sets a boolean value that indicates whether the settings of DataListener are to be saved to the config file.
| |
Port |
Gets or sets the network port of the Server where the DataListener will connect to get the time-series data.
| |
Protocol |
Gets or sets the TransportProtocol to be used for receiving time-series data from the Server.
| |
RunTime |
Gets the up-time (in seconds) of the DataListener.
| |
SaveSettings()()() |
Saves settings for the DataListener to the config file if the PersistSettings property is set to true.
| |
Server |
Gets or sets the DNS name or IP address of the server from where the DataListener will get the time-series data.
| |
SettingsCategory |
Gets or sets the category under which the settings of DataListener are to be saved to the config file if the PersistSettings property is set to true.
| |
Site | (Inherited from Component.) | |
SocketConnected |
Occurs when the underlying Socket connection for receiving time-series data is established.
| |
SocketConnecting |
Occurs when the underlying Socket connection for receiving time-series data is being attempted.
| |
SocketDisconnected |
Occurs when the underlying Socket connection for receiving time-series data is terminated.
| |
Start()()() |
Starts the DataListener synchronously.
| |
StartAsync()()() |
Starts the DataListener asynchronously.
| |
Status |
Gets the descriptive status of the DataListener.
| |
Stop()()() |
Stops the DataListener.
| |
ToString()()() |
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.) | |
TotalBytesReceived |
Gets the total number of bytes received by the DataListener since it was Start()()()ed.
| |
TotalPacketsReceived |
Gets the total number of packets received by the DataListener since it was Start()()()ed.
|
Inheritance Hierarchy
Object | |||
MarshalByRefObject | |||
Component | |||
DataListener |
See Also