|
PIConnection Class |
Represents a connection to a PI server that handles open, close and executes operations.
Inheritance Hierarchy
Namespace: PIAdapters
Assembly: PIAdapters (in PIAdapters.dll) Version: 2.4.218-beta
Syntaxpublic class PIConnection : IComparable<PIConnection>, IComparable, IDisposable
The PIConnection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PIConnection | Creates a new OSI-PI connection. |
Properties| Name | Description | |
|---|---|---|
 | Connected | Gets flag that determines if PIConnection is currently connected to ServerName. |
| ConnectTimeout | Gets or sets the timeout interval (in milliseconds) for the adapter's connection. |
| Password | Gets or sets the password used for the adapter's PI connection. |
| Server | Gets PI server object for this PI connection. |
| ServerName | Gets or sets the name of the PI server for the adapter's PI connection. |
| UserName | Gets or sets the name of the PI user ID for the adapter's PI connection. |
Methods| Name | Description | |
|---|---|---|
| Close | Closes PIConnection. |
| CompareTo | Compares the current object with another object of the same type. |
| Dispose | Releases all the resources used by the PIConnection object. |
 | Dispose(Boolean) | Releases the unmanaged resources used by the PIConnection object and optionally releases the managed resources. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Open | Attempts to open PIConnection. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | Disconnected | Raised when PIConnection has been disconnected from server. |
Fields| Name | Description | |
|---|---|---|
  | DefaultConnectTimeout | Default value for ConnectTimeout. |
See Also