This procedure is defined in the server but not documented via ad_proc or proc_doc and may be intended as a private interface.
The procedure is defined as:
proc nsmcp::accessOrderedPlan {fileVar stateVar options limits publish} {
upvar 1 $fileVar file $stateVar state
if {[dict exists $file orderedPlanned]} {return}
if {[dict get $file compressed] && ![dict exists $file spool]} {return}
dict set file orderedPlanned true
set size [dict get $file size]; set path [dict get $file path]
if {[dict exists $file spool]} {set size [dict get $file decodedSize]; set path [dict get $file spool]}
set allowed [expr {max(0,min(2097152,[dict get $limits bytes]-[dict get $state examinedBytes]))}]
set remaining $allowed
set channel [open $path rb]
accessScanProgress $publish selecting-interval $state $file 0 $size
try {
if {$size==0} {dict set file orderedReason empty-file; return}
set first [accessOrderedProbe $channel 0 $size [dict get $limits line] remaining]
if {$first eq ""} {error "selection-no-complete-record"}
set tailFrom [expr {max(0,$size-2*[dict get $limits line]-2)}]
set data [accessOrderedRead $channel $tailFrom [expr {$size-$tailFrom}] remaining]
set lastNewline [string last \n $data]
if {$lastNewline<0} {error "selection-no-complete-record"}
set previous [string last \n $data [expr {$lastNewline-1}]]
if {$previous<0 && $tailFrom>0} {error "selection-oversized-record"}
set raw [string range $data [expr {$previous+1}] [expr {$lastNewline-1}]]
if {[string length $raw]>[dict get $limits line]} {error "selection-oversized-record"}
set stamp [accessOrderedTime $raw]
if {$stamp eq ""} {error "selection-unparseable-record"}
set last [dict create offset [expr {$tailFrom+$previous+1}] end [expr {$tailFrom+$lastNewline+1}] time $stamp]
set samples {}; accessOrderedObserve samples $first; accessOrderedObserve samples $last
set lower [accessOrderedLowerBound $channel [expr {max(0,[dict get $options from]-5)}] $first $last [dict get $limits line] remaining samples]
set upper [accessOrderedLowerBound $channel [expr {[dict get $options to]+5}] $first $last [dict get $limits line] remaining samples]
if {$lower>$upper} {error "selection-inconsistent-bounds"}
dict set file orderedSelection [dict create firstAt [dict get $first time] lastAt [dict get $last time] fromOffset $lower toOffset $upper completeEnd [dict get $last end] pendingTail [expr {[dict get $last end]<$size}] orderingAssumed true paddingSeconds 5]
dict set file orderedReason selected-by-start-time
dict set file offset $lower
dict set file scanStart $lower
dict set file scanEnd $upper
dict set file rangeUncertain true
if {$lower==$upper} {dict set file status outside-window}
} on error {message opts} {
# Probe failures never silently exclude a file. Keep the ordinary
# bounded scanner and expose why fast selection could not be used.
dict set file orderedReason $message
dict set file offset 0
} finally {
close $channel
set readBytes [expr {$allowed-$remaining}]
dict incr state examinedBytes $readBytes
dict incr state selectionProbeBytes $readBytes
dict set file selectionProbeBytes $readBytes
}
}
