Class ::nsmcp::BoundedLogScanner

::nsmcp::BoundedLogScanner[i] create ... \
           [ -blockBytes:integer (default "4194304") ] \
           [ -buffer (default "") ] \
           [ -bufferEnd (default "0") ] \
           [ -bufferFrom (default "0") ] \
           [ -cacheDirectory:required cacheDirectory:required ] \
           [ -channel (default "") ] \
           [ -keys (default "") ] \
           [ -limit (default "") ] \
           [ -literals:required literals:required ] \
           [ -native:boolean (default "true") ] \
           [ -nativePrepared (default "false") ] \
           [ -nativeThreshold:integer (default "32") ] \
           [ -overlap (default "0") ] \
           [ -readBytes (default "65536") ] \
           [ -temporaryChannel (default "") ] \
           [ -temporaryPath (default "") ] \
           [ -windowCeiling (default "-1") ] \
           [ -windowHits (default "0") ]

Defined in /usr/local/ns/tcl/nsmcp/log-01-scanner.tcl

Class Relations

  • class: ::nx::Class[i]
  • superclass: ::nsmcp::Object[i]

Methods (to be applied on instances)

  • destroy (scripted, public)

     <instance of nsmcp::BoundedLogScanner[i]> destroy

    Release the scanner's private temporary channel and file. Close and remove temporary resources when present, then continue NX destruction.

    Returns:
    The superclass destruction result.

    Testcases:
    No testcase defined.
  • find (scripted, public)

     <instance of nsmcp::BoundedLogScanner[i]> find from [ ceiling ]

    Find the earliest candidate within a fixed byte interval. Use overlapping bounded windows for channels or the current memory chunk; never read beyond the ceiling.

    Parameters:
    from (required)
    Inclusive starting byte offset within the fixed scan interval.
    ceiling (optional)
    Exclusive upper byte bound; empty uses the configured scanner limit.
    Returns:
    The candidate byte offset, or -1 when no candidate is found.

    Testcases:
    No testcase defined.
  • load (scripted, public)

     <instance of nsmcp::BoundedLogScanner[i]> load bytes

    Load a bounded in-memory byte chunk for candidate scanning. Reject channel-backed scanners and chunks larger than the configured block bound.

    Parameters:
    bytes (required)
    Raw binary chunk, no larger than the configured block limit.
    Returns:
    The new in-memory byte limit.

    Testcases:
    No testcase defined.
  • nextLine (scripted, public)

     <instance of nsmcp::BoundedLogScanner[i]> nextLine position \
        [ filter ]

    Read an in-memory physical line, optionally using the literal prefilter. Return physical byte bounds and newline status without parsing or redacting the record.

    Parameters:
    position (required)
    Physical byte cursor within the loaded chunk.
    filter (optional, defaults to "true")
    Whether to apply the literal candidate prefilter; false reads sequentially. Defaults to 'true'.
    Returns:
    A dictionary with start, end, raw and terminated fields, or an empty result at exhaustion.

    Testcases:
    No testcase defined.