IClientMonitor interface | QSYS API Reference Guide
Estimated reading time: 2 minutes
Defines the contract for monitoring a client in the ASNA DataGate client.
Namespace: ASNA.DataGate.Client Assembly: ASNA.QSys.DataGate.Client.dll
Extends: IDisposable
Remarks
This interface provides properties and methods to monitor a client in the ASNA DataGate client. It includes properties to get the client’s application name, current function, status, start time, process name, user name, job name, server user name, client number, current locks, library list, and current open files. It also provides a method to forcibly terminate the client.
Properties
Type | Name | Description |
---|---|---|
String | Application | Gets the name of the application using this client. |
Boolean | CacheData | Gets or sets a value indicating whether data should be cached. |
String | CurrentFunction | Gets the name of the function at the current time. |
IEnumerable<ILock> | CurrentLocks | Gets all locks created by this client. |
IEnumerable<IOpenFile> | CurrentOpenFiles | Gets all files opened by this client. |
String | Job | Gets the job associated with this client. |
ILibraryList | LibraryList | Gets the Library List in use by the client. |
Int32 | Number | Gets the number associated with this client. |
String | Process | Gets the process running this client. |
String | ServerUser | Gets the server user associated with this client. |
DateTime | Started | Gets the DateTime when the client started. |
String | Status | Gets the status of the client. |
String | User | Gets the user name associated with this client. |
Int32 | ValidFields | Gets the number of valid fields in the client. |
Methods
Signature | Description |
---|---|
Kill(Int32) | Forcibly terminates the current client. |
void Kill(int delay)
Forcibly terminates the current client.
Remarks
This method will forcibly terminate the client after the specified delay. Use this method with caution as it can lead to data loss if the client is in the middle of a transaction.
void Kill(int delay)
Parameters
Type | Parameter name | Description |
---|---|---|
Int32 | delay | Wait time in milliseconds before terminating the client. |