TIBCO EMS .NET API 8.5
TIBCO EMS .NET API 8.5
TIBCO.EMS.ADMIN.MStoreInfo Class Reference

Class representing information about server's mstore-based store. More...

Inheritance diagram for TIBCO.EMS.ADMIN.MStoreInfo:
TIBCO.EMS.ADMIN.StoreInfo

Public Member Functions

override System.String ToString ()
 Returns a String that represents the current Object More...
 

Properties

long NotInUseSpace [get]
 Get the amount of space in the store file that is not in use. More...
 
long InUseSpace [get]
 Get the amount of space in the store file that is in use. More...
 
long Size [get]
 Get the total size of the store file. More...
 
System.String FileName [get]
 Get the file name. More...
 
long DiscardScanInterval [get]
 Get the interval for discard scan. More...
 
long DiscardScanBytes [get]
 Get the number of bytes examined at each discard scan interval. More...
 
bool FirstScanFinished [get]
 Determine if the first scan is finished. More...
 
bool TimeBoundCompactAvailable [get]
 Indicates whether or not this mstore can be compacted in a time-bound manner or through the mstore_truncate property. More...
 
bool TruncationEnabled [get]
 Indicates whether or not the server will periodically check if there is unused space at the end of the file and, if so, truncate the file. More...
 
bool SynchronousWriteEnabled [get]
 Indicates whether or not the file is opened in synchronous write mode. More...
 
long WriteRate [get]
 Get the number of bytes written per second. More...
 
- Properties inherited from TIBCO.EMS.ADMIN.StoreInfo
long MsgCount [get]
 Get the number of data messages stored in the store. More...
 
long MsgBytes [get]
 Get the total size of the data messages stored in the store. More...
 
long SwappedCount [get]
 Get the number of data messages stored in the store as a result of swapping out non-persistent messages. More...
 
long SwappedBytes [get]
 Get the total size of the data messages stored in the store as a result of swapping out non-persistent messages. More...
 
long FreeSpace [get]
 Get the amount of space in the store that is not in use, deprecated. More...
 
long UsedSpace [get]
 Get the amount of space in the store that is in use, deprecated. More...
 
long FileSize [get]
 Get the total size of the store, deprecated. More...
 
double AverageWriteTime [get]
 Get the average time (in seconds) a write call takes. This measurement is not available when the store is asynchronous. More...
 
double WriteUsage [get]
 Get the Ratio between time spent within write and total time (server_rate_interval). This measurement is not available when the store is asynchronous. More...
 

Additional Inherited Members

- Protected Member Functions inherited from TIBCO.EMS.ADMIN.StoreInfo
 StoreInfo (MapMessage msg)
 Initializes a new instance of the StoreInfo with the specified map message More...
 
 StoreInfo (MapMessage msg, Store type)
 Initializes a new instance of the StoreInfo with the specified map message and store type More...
 
- Protected Attributes inherited from TIBCO.EMS.ADMIN.StoreInfo
long freeSpace
 
long usedSpace
 
long fileSize
 
int fragmentation = -1
 

Detailed Description

Class representing information about server's mstore-based store.

Member Function Documentation

override System.String TIBCO.EMS.ADMIN.MStoreInfo.ToString ( )
inline

Returns a String that represents the current Object

Property Documentation

long TIBCO.EMS.ADMIN.MStoreInfo.DiscardScanBytes
get

Get the number of bytes examined at each discard scan interval.

Returns
the amount in bytes
long TIBCO.EMS.ADMIN.MStoreInfo.DiscardScanInterval
get

Get the interval for discard scan.

Returns
period in milliseconds
System.String TIBCO.EMS.ADMIN.MStoreInfo.FileName
get

Get the file name.

Returns
file name
bool TIBCO.EMS.ADMIN.MStoreInfo.FirstScanFinished
get

Determine if the first scan is finished.

Returns
true or false
long TIBCO.EMS.ADMIN.MStoreInfo.InUseSpace
get

Get the amount of space in the store file that is in use.

Returns
the number of bytes that are in use
long TIBCO.EMS.ADMIN.MStoreInfo.NotInUseSpace
get

Get the amount of space in the store file that is not in use.

Returns
the number of bytes that are free
long TIBCO.EMS.ADMIN.MStoreInfo.Size
get

Get the total size of the store file.

Returns
the size in bytes
bool TIBCO.EMS.ADMIN.MStoreInfo.SynchronousWriteEnabled
get

Indicates whether or not the file is opened in synchronous write mode.

Returns
true if synchronous mode is enabled, false otherwise
bool TIBCO.EMS.ADMIN.MStoreInfo.TimeBoundCompactAvailable
get

Indicates whether or not this mstore can be compacted in a time-bound manner or through the mstore_truncate property.

Returns
true if time-bound compact is available for this mstore, false otherwise

Since EMS 8.3.0

bool TIBCO.EMS.ADMIN.MStoreInfo.TruncationEnabled
get

Indicates whether or not the server will periodically check if there is unused space at the end of the file and, if so, truncate the file.

Returns
true if truncation is enabled, false otherwise

Since EMS 8.3.0

long TIBCO.EMS.ADMIN.MStoreInfo.WriteRate
get

Get the number of bytes written per second.

Returns
the byte rate.

since EMS 6.1


Copyright © Cloud Software Group, Inc. All rights reserved.