TCache - Revision history

Ultibo: Created page with "Return to Unit Filesystem TOC === Description === ---- ''To be documented'' === Class definitions === ----

2018-05-17T04:36:16Z

Created page with "Return to Unit Filesystem TOC === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsible..."

New page
Return to [[Unit_Filesystem|Unit Filesystem]]

TOC

=== Description ===
----

''To be documented''

=== Class definitions ===
----

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TCache = class(TObject)</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: A simple block cache with Read Only/Read Write modes and Free/Clean/Dirty page tracking. (No longer used)
|-
|colspan="2"| 
|-
| <code>constructor Create(ADriver:TFileSysDriver);</code>
| style="width: 50%;"| 
|-
| <code>destructor Destroy; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FDriver:TFileSysDriver;</code>
|  
|-
|colspan="2"| 
|-
| <code>FLock:TCriticalSectionHandle;</code>
|  
|-
|colspan="2"| 
|-
| <code>FBuffer:Pointer;</code>
|  
|-
| <code>FPageSize:LongWord;</code>
|  
|-
| <code>FPageCount:LongWord;</code>
|  
|-
| <code>FCacheSize:LongWord;</code>
|  
|-
| <code>FCacheMode:TCacheMode;</code>
|  
|-
| <code>FCacheState:TCacheState;</code>
|  
|-
| <code>FCacheTimeout:LongWord;</code>
|  
|-
|colspan="2"| 
|-
| <code>FReadCached:Int64;</code>
|  
|-
| <code>FReadDirect:Int64;</code>
|  
|-
|colspan="2"| 
|-
| <code>FWriteBack:Int64;</code>
|  
|-
| <code>FWriteThrough:Int64;</code>
|  
|-
| <code>FWriteDirect:Int64;</code>
|  
|-
|colspan="2"| 
|-
| <code>FHitCount:Int64;</code>
|  
|-
| <code>FMissCount:Int64;</code>
|  
|-
|colspan="2"| 
|-
| <code>FFailCount:Int64;</code>
|  
|-
| <code>FSuccessCount:Int64;</code>
|  
|-
|colspan="2"| 
|-
| <code>FFlushCount:Int64;</code>
|  
|-
| <code>FDiscardCount:Int64;</code>
|  
|-
| <code>FUnknownCount:Int64;</code>
|  
|-
|colspan="2"| 
|-
| <code>FFirstPage:TCachePage;</code>
| First Cache Page (Any State)
|-
| <code>FLastPage:TCachePage;</code>
| Last Cache Page (Any State)
|-
| <code>FFirstEmpty:TCachePage;</code>
| First Free Page
|-
| <code>FLastEmpty:TCachePage;</code>
| Last Free Page
|-
| <code>FFirstClean:TCachePage;</code>
| First Clean Page (Used with no Write pending)
|-
| <code>FLastClean:TCachePage;</code>
| Last Clean Page (Used with no Write pending)
|-
| <code>FFirstDirty:TCachePage;</code>
| First Dirty Page (Used with Write pending)
|-
| <code>FLastDirty:TCachePage;</code>
| Last Dirty Page (Used with Write pending)
|-
|colspan="2"| 
|-
| <code>FTimer:TCacheTimer;</code>
|  
|-
| <code>FThread:TCacheThread;</code>
|  
|-
|colspan="2"| 
|-
| <code>function AcquireLock:Boolean;</code>
|  
|-
| <code>function ReleaseLock:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function AddPage(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function RemovePage(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function AddEmpty(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function AddClean(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function AddDirty(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function AddUnknown(APage:TCachePage):Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function UpdateClean(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function UpdateDirty(APage:TCachePage):Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function RoundPageSize(APageSize:LongWord):LongWord;</code>
|  
|-
| <code>function RoundCacheSize(ACacheSize,APageSize:LongWord):LongWord;</code>
|  
|-
|colspan="2"| 
|-
| <code>function LinkPage(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function UnlinkPage(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function LinkEmpty(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function UnlinkEmpty(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function LinkClean(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function UnlinkClean(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function LinkDirty(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function UnlinkDirty(APage:TCachePage):Boolean;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>property PageSize:LongWord read FPageSize;</code>
|  
|-
| <code>property PageCount:LongWord read FPageCount;</code>
|  
|-
| <code>property CacheSize:LongWord read FCacheSize;</code>
|  
|-
| <code>property CacheMode:TCacheMode read FCacheMode;</code>
|  
|-
| <code>property CacheState:TCacheState read FCacheState;</code>
|  
|-
| <code>property CacheTimeout:LongWord read FCacheTimeout;</code>
|  
|-
|colspan="2"| 
|-
| <code>property ReadCached:Int64 read FReadCached;</code>
|  
|-
| <code>property ReadDirect:Int64 read FReadDirect;</code>
|  
|-
|colspan="2"| 
|-
| <code>property WriteBack:Int64 read FWriteBack;</code>
|  
|-
| <code>property WriteThrough:Int64 read FWriteThrough;</code>
|  
|-
| <code>property WriteDirect:Int64 read FWriteDirect;</code>
|  
|-
|colspan="2"| 
|-
| <code>property HitCount:Int64 read FHitCount;</code>
|  
|-
| <code>property MissCount:Int64 read FMissCount;</code>
|  
|-
|colspan="2"| 
|-
| <code>property FailCount:Int64 read FFailCount;</code>
|  
|-
| <code>property SuccessCount:Int64 read FSuccessCount;</code>
|  
|-
|colspan="2"| 
|-
| <code>property FlushCount:Int64 read FFlushCount;</code>
|  
|-
| <code>property DiscardCount:Int64 read FDiscardCount;</code>
|  
|-
| <code>property UnknownCount:Int64 read FUnknownCount;</code>
|  
|-
|colspan="2"| 
|-
| <code>function OpenCache(ACacheSize,APageSize:LongWord; ACacheMode:TCacheMode):Boolean;</code>
|  
|-
| <code>function CloseCache:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function DeviceRead(ADevice:TDiskDevice; ASector:LongWord; ACount:Word; var ABuffer):Boolean;</code>
|  
|-
| <code>function DeviceErase(ADevice:TDiskDevice; ASector:LongWord; ACount:Word):Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function GetDevicePage(ADevice:TDiskDevice; ASector:LongWord):TCachePage; virtual;</code>
|  
|-
| <code>function GetEmptyPage:TCachePage;</code>
|  
|-
|colspan="2"| 
|-
| <code>function AllocDevicePage(ADevice:TDiskDevice; ASector:LongWord; AWrite:Boolean):TCachePage; virtual;</code>
|  
|-
|colspan="2"| 
|-
| <code>function DiscardPage(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function DiscardCache(AFirst,AAll:Boolean):Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function ReleaseDevicePages(ADevice:TDiskDevice):Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function FlushPage(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function FlushPageEx(APage:TCachePage):Boolean;</code>
|  
|-
| <code>function FlushCache(AFirst,AAll:Boolean):Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function CheckTimer:Boolean;</code>
|  
|-
| <code>function ProcessTimer:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function SchedulePage(APage:TCachePage; ATimeout:LongWord):Boolean;</code>
|  
|-
| <code>function UnschedulePage(APage:TCachePage):Boolean;</code>
|  
|-
|}
</div></div>
<br />

=== Function declarations ===
----

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">constructor TCache.Create(ADriver:TFileSysDriver);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">destructor TCache.Destroy;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.AcquireLock:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.ReleaseLock:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.AddPage(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a new page to the Page list and the Empty list</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.RemovePage(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a Page from the Page list and any other lists then Free the Page</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.AddEmpty(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a Page to the Empty list, removing from other lists if needed</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.AddClean(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a Page to the Clean list, removing from other lists if needed</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.AddDirty(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a Page to the Dirty list, removing from other lists if needed</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.AddUnknown(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Make a Page Unknown by removing from any other lists if needed</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.UpdateClean(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Move a Page to the end of the Clean list</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.UpdateDirty(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Move a Page to the end of the Dirty list</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.RoundPageSize(APageSize:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Round Page Size to the power of 2 of Sector Size</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.RoundCacheSize(ACacheSize,APageSize:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Round Cache Size to the next multiple of Page Size</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.LinkPage(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Link APage to PrevPage,NextPage siblings and Adjust FirstPage/LastPage</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.UnlinkPage(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Unlink APage from PrevPage,NextPage Siblings and Adjust FirstPage/LastPage</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.LinkEmpty(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Link APage to PrevLink,NextLink siblings and Adjust FirstEmpty/LastEmpty</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.UnlinkEmpty(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Unlink APage from PrevLink,NextLink Siblings and Adjust FirstEmpty/LastEmpty</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.LinkClean(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Link APage to PrevLink,NextLink siblings and Adjust FirstClean/LastClean</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.UnlinkClean(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Unlink APage from PrevLink,NextLink Siblings and Adjust FirstClean/LastClean</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.LinkDirty(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Link APage to PrevLink,NextLink siblings and Adjust FirstDirty/LastDirty</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.UnlinkDirty(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Unlink APage from PrevLink,NextLink Siblings and Adjust FirstDirty/LastDirty</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.PrepareDeviceWrite(ADevice:TDiskDevice; APage:TCachePage; ASector,ACount:LongWord):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Prepare a Cache Page for Write by ensuring that required sectors are cached</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Sector
| Passed Sector will be the starting sector for the write to this Page
|-
! Count
| Passed Count will be the write count to this Page (Calculated by caller)
|-
! Note
| Only called internally by DeviceWrite
Caller must hold the lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.CalculateDevicePage(ADevice:TDiskDevice; ASector:LongWord; var ACount:LongWord):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Calculate the number of sectors remaining in a page given the starting sector</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Only called internally by DeviceRead/DeviceWrite/DeviceErase
Caller must hold the lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.OpenCache(ACacheSize,APageSize:LongWord; ACacheMode:TCacheMode):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate the Memory, Create the Empty Pages and Open Cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.CloseCache:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Flush all Dirty Pages, Release the Memory and Close the Cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.DeviceRead(ADevice:TDiskDevice; ASector,ACount:LongWord; var ABuffer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Read Data from the Physical Device using either Cached or Direct access</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| AllocDevicePage does all checks for Size, Sector and Count.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.DeviceWrite(ADevice:TDiskDevice; ASector,ACount:LongWord; const ABuffer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Write Data to the Physical Device using either Cached or Direct access</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| AllocDevicePage does all checks for Size, Sector and Count.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.DeviceErase(ADevice:TDiskDevice; ASector,ACount:LongWord):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Erase Data from the Physical Device and update cached pages accordingly</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.GetDevicePage(ADevice:TDiskDevice; ASector:LongWord):TCachePage;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Clean or Dirty Page that contains this Sector on this Device</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.GetEmptyPage:TCachePage;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the First Empty Page, Discard First Clean Page if none Empty</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.AllocDevicePage(ADevice:TDiskDevice; ASector:LongWord; AWrite:Boolean):TCachePage;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate an Empty Page to the Device and mark as Clean or Dirty</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.DiscardPage(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return a Clean Page to Empty</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.DiscardCache(AFirst,AAll:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find any Clean Pages older than CacheTimeout and Discard them</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.ReleaseDevicePages(ADevice:TDiskDevice):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return all Clean or Dirty Pages on the Device to Empty</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.FlushPage(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return a Dirty Page to Clean</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.FlushPageEx(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return a Dirty Page to Clean if it is older than CacheTimeout</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Only called by CacheThread with page scheduled from CacheTimer
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.FlushCache(AFirst,AAll:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find any Dirty Pages older than CacheTimeout and Flush them</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.CheckTimer:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.ProcessTimer:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.SchedulePage(APage:TCachePage; ATimeout:LongWord):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TCache.UnschedulePage(APage:TCachePage):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]