![]() |
Data
|
[ToolboxBitmapAttribute(typeof(DataListener))] public class DataListener : Component, ISupportLifecycle, IDisposable, ISupportInitialize, IProvideStatus, IPersistSettings
The DataListener type exposes the following members.
Name | Description | |
---|---|---|
![]() | DataListener | Initializes a new instance of the DataListener class. |
![]() | DataListener(IContainer) | Initializes a new instance of the DataListener class. |
Name | Description | |
---|---|---|
![]() | 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) |
![]() | Data | Gets the newest time-series data received by the DataListener. |
![]() | DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
![]() | Enabled | Gets or sets a boolean value that indicates whether the DataListener is currently enabled. |
![]() | Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
![]() | ID | Gets or sets the alpha-numeric identifier of 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 Startup. |
![]() | IsDisposed | Gets a flag that indicates whether the object has been disposed. |
![]() | Name | Gets the unique identifier of the DataListener. |
![]() | 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. |
![]() | 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 | Gets or sets the ISite of the Component. (Inherited from Component) |
![]() | Status | Gets the descriptive status of the DataListener. |
![]() | TotalBytesReceived | Gets the total number of bytes received by the DataListener since it was Started. |
![]() | TotalPacketsReceived | Gets the total number of packets received by the DataListener since it was Started. |
Name | Description | |
---|---|---|
![]() | BeginInit | Performs necessary operations before the DataListener properties are initialized. |
![]() | CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
![]() | Dispose | Releases all resources used by the Component. (Inherited from Component) |
![]() | Dispose(Boolean) |
Releases the unmanaged resources used by the DataListener and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean)) |
![]() | EndInit | Performs necessary operations after the DataListener properties are initialized. |
![]() | Equals |
Determines whether the current DataListener object is equal to obj.
(Overrides ObjectEquals(Object)) |
![]() | Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component) |
![]() | FindData | Gets the current data for the specified historianID. |
![]() | GetHashCode |
Returns the hash code for the current DataListener object.
(Overrides ObjectGetHashCode) |
![]() | GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
![]() | GetService | Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object) |
![]() | Initialize | Initializes the DataListener. |
![]() | InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
![]() | LoadSettings | Loads saved settings for the DataListener from the config file if the PersistSettings property is set to true. |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
![]() | MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
![]() | OnDataChanged | Raises the DataChanged event. |
![]() | OnDataExtracted | 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. |
![]() | SaveSettings | Saves settings for the DataListener to the config file if the PersistSettings property is set to true. |
![]() | Start | Starts the DataListener synchronously. |
![]() | StartAsync | Starts the DataListener asynchronously. |
![]() | 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) |
Name | Description | |
---|---|---|
![]() | 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 Startup. |
![]() | DataInitFailure | Occurs when the Data cannot be populated on Startup due to the unavailability of the Server. |
![]() | DataInitPartial | Occurs when the Data cannot be populated completely on Startup. |
![]() | DataInitStart | Occurs when the Data is being populated on Startup. |
![]() | Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component) |
![]() | 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. |
![]() | 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. |
Name | Description | |
---|---|---|
![]() ![]() | 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. |
Name | Description | |
---|---|---|
![]() | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
![]() | GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |