objectBroker
objectBroker
objectBroker
Stores and manages cache of objects to enable faster access
Metadata
addCSSHeadToWebskins()
Adds the result of a skin:loadCSS to all relevent webskin caches
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| stCSS |
struct |
Yes |
|
|
|
addhtmlHeadToWebskins()
Adds the result of a skin:htmlHead to all relevent webskin caches
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| id |
string |
No |
[runtime expression] |
|
|
| text |
string |
No |
|
|
|
| library |
string |
No |
|
|
|
| libraryState |
boolean |
No |
true |
|
|
| onReady |
string |
No |
|
|
|
addJSHeadToWebskins()
Adds the result of a skin:loadJS to all relevent webskin caches
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| stJS |
struct |
Yes |
|
|
|
AddToObjectBroker()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| stObj |
struct |
Yes |
|
|
|
| typename |
string |
Yes |
|
|
|
addWebskin()
Adds webskin to object broker if all conditions are met
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| ObjectID |
UUID |
No |
|
|
|
| typename |
string |
Yes |
|
|
|
| template |
string |
Yes |
|
|
|
| webskinCacheID |
string |
Yes |
|
|
|
| HTML |
string |
Yes |
|
|
|
| stCurrentView |
struct |
Yes |
|
|
|
CleanupObjectBroker()
Removes 10% of the items in the object broker if it is full.
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| typename |
string |
Yes |
|
|
|
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| typename |
string |
Yes |
|
|
|
| MaxObjects |
numeric |
No |
100 |
|
|
| MaxWebskins |
numeric |
No |
10 |
|
|
flushTypeWatchWebskins()
Finds all webskins watching this type for any CRUD functions and flushes them from the cache
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| objectID |
String |
Yes |
|
|
The typename that the CRUD function was performed on. |
| typename |
String |
Yes |
|
|
|
generateWebskinCacheID()
Generates a webskin Cache ID that can be hashed to store a specific version of a webskin cache.
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| typename |
String |
Yes |
|
|
|
| template |
String |
Yes |
|
|
|
| hashKey |
String |
No |
|
|
|
| bCacheByURL |
String |
No |
[runtime expression] |
|
|
| bCacheByForm |
String |
No |
[runtime expression] |
|
|
| bCacheByRoles |
String |
No |
[runtime expression] |
|
|
| lcacheByVars |
String |
No |
[runtime expression] |
|
|
GetFromObjectBroker()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| ObjectID |
UUID |
Yes |
|
|
|
| typename |
string |
Yes |
|
|
|
GetObjectCacheEntry()
Get an object's cache entry in the object broker
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| ObjectID |
UUID |
Yes |
|
|
|
| typename |
string |
Yes |
|
|
|
getWebskin()
Searches the object broker in an attempt to locate the requested webskin template. Returns a struct containing the webskinCacheID and the html.
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| ObjectID |
UUID |
No |
|
|
|
| typename |
string |
Yes |
|
|
|
| template |
string |
Yes |
|
|
|
| hashKey |
string |
Yes |
|
|
|
init()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| bFlush |
boolean |
No |
false |
|
Allows the application to force a total flush of the objectbroker. |
putObjectCacheEntry()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| stCacheEntry |
struct |
Yes |
|
|
|
| objectid |
UUID |
Yes |
|
|
|
| typename |
string |
Yes |
|
|
|
reapDeadEntriesFromBroker()
Cleans out soft references to recycled objects in the object broker.
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| None |
RemoveFromObjectBroker()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| lObjectIDs |
string |
Yes |
|
|
|
| typename |
string |
Yes |
|
|
|
| eventName |
string |
No |
flush |
|
Name of event that triggered the removal {flush,reap,evict} |
removeWebskin()
Searches the object broker in an attempt to locate the requested webskin template
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| ObjectID |
UUID |
No |
|
|
|
| typename |
string |
Yes |
|
|
|
| template |
string |
Yes |
|
|
|
trackObjectEvent()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| eventname |
string |
Yes |
|
|
|
| typename |
string |
Yes |
|
|
|
| objectid |
string |
Yes |
|
|
|