CacheServerAdmin Object

Crystal Enterprise Cache Page Server Admin PlugIn Library
See Also  

This object provides metrics and administration for the Cache Server. It stores information about the maximum processing threads, the maximum cache size, the minutes before an idle job is closed, the location of the cache files, the total threads running, the number of requests served, the number of bytes transferred, the cache hit rate, the number of current connections, and the number of requests that are queued. You can also retrieve the collection of Page Servers that the Cache Server has connections to, and the number of connections made to the Page Server(s). Management includes setting the directory for the Cache Server, the maximum idle time before a job is closed, and the maximum number of simultaneous processing threads allowed by the Cache Server.

Properties

Property Description

BytesTransferred Property

Returns the total number of bytes transferred in KB. Read-Only.

CacheSize Property

Returns the current cache size in KB. Read-Only.

CacheSizeUpdate Property

Gets or sets the cache size in KB.

Connections Property

Returns the number of current connections made to the Page Server(s). Read-Only.

Directory Property

Returns the Cache Server's current directory path. Read-Only.

DirectoryUpdate Property

Gets or sets the Cache Server's directory path.

DriveSpaceUsed Property

Returns the amount of disk space, in KB, used by the Cache Server. Read-Only.

HitRate Property

Returns the rate of requests that can be fulfilled by the Cache Server's cache. Read-Only.

MaxIdleTime Property

Returns the maximum time in minutes before an idle job is closed. Read-Only.

MaxIdleTimeUpdate Property

Gets or sets the maximum time in minutes before an idle job is closed.

MaxThreads Property

Returns the maximum number of simultaneous processing threads. Read-Only.

MaxThreadsUpdate Property

Gets or sets the maximum number of simultaneous processing threads.

PageServerConnection Property

Returns the collection of Page Servers connected to the current Cache Server. Read-Only.

QueuedRequests Property

Returns the number of requests to the Page Server(s) that are in the queue and are waiting to be processed. Read-Only.

Refresh Property

Returns the number of requests to the Page Server(s) that are in the queue and are waiting to be processed. Read-Only

RefreshAlwaysHitsDb Property

Returns whether or not a request to refresh the report from the viewer will always hit database. Read-Only

RefreshAlwaysHitsDbUpdate Property

Gets or sets whether or not a request to refresh the report from the viewer will always hit database.

RefreshUpdate Property

Gets or sets the amount of time in minutes before a shareable report will refresh from the database.

Threads Property

Returns the current number of processing threads running. Read-Only.

TotalRequests Property

Returns the total number of requests served.

Methods

Method Explanation

Commit Method

Use this method to commit to the APS any changes that are made to the cache server.



Crystal Decisions, Inc.
http://www.crystaldecisions.com
Support services:
http://support.crystaldecisions.com