@haxall/haxall
    Preparing search index...

    Class HxWatch

    HxWatch is a subscription to a set of records in a project database. It provides an efficient mechanism to poll for changes. Also see docHaxall::Watches#fantom.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    type$

    Methods

    add addAll addGrid close compare dis equals hash id isClosed isEmpty isImmutable lease list poll remove removeAll removeGrid rt toImmutable toStr trap typeof with echo make

    Constructors

    Properties

    type$: Type

    Methods

    • Convenience for addAll([id])

      Parameters

      Returns void

    • Add the given records to this watch. Silently ignore any ids already subscribed by this watch, not found in the database, or which are inaccessible to the current user. Raise exception if watch is closed. This call renews the lease.

      Parameters

      Returns void

    • Convenience for addAll for id column of each row. If any row is missing an id tag then it is silently skipped.

      Parameters

      Returns void

    • Close this watch and unsubscribe all its records. If watch is already closed, this method is a no op.

      Returns void

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that  =>  0
      this > that   =>  >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3)  =>  1
      8.compare(8)  =>  0
      3 <=> 8       =>  -1  // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Debug display string used during watchOpen

      Returns string

    • Equality based on reference equality

      Parameters

      Returns boolean

    • Identity hash

      Returns number

    • Identifier which uniquely identifies this watch in the project

      Returns string

    • Return if this watch has been closed

      Returns boolean

    • Return if the list of recs currently subscribed is empty.

      Returns boolean

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • The lease determines the max duration which may elapse without a renew call before the watch is expired. The default is 1min. Clients can attempt to tune the lease time by setting this field, but no guarantee is made that the framework will honor extremely long lease times.

      Returns Duration

    • The lease determines the max duration which may elapse without a renew call before the watch is expired. The default is 1min. Clients can attempt to tune the lease time by setting this field, but no guarantee is made that the framework will honor extremely long lease times.

      Parameters

      Returns void

    • List the rec ids currently subscribed by this watch. Raise exception if watch is closed.

      Returns List<Ref>

    • Get all the records which have been modified since the given ticks. An empty list is returned if no changes have been made to the watched records since ticks. There is no ordering to the resulting list. This method automatically renews the lease and keeps track of the last poll ticks. Also see docHaxall::Watches#fantom.

      Parameters

      Returns List<Dict>

    • Convenience for removeAll([id])

      Parameters

      Returns void

    • Remove the given records from this watch. Any ids not currently subscribed by this watch are silently ignored. Raise exception if watch is closed. This call renews the lease.

      Parameters

      Returns void

    • Convenience for removeAll for id column of each row

      Parameters

      Returns void

    • Runtime associated with this watch

      Returns HxRuntime

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Debug string

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x()      a.trap("x", null)
      a->x = b    a.trap("x", [b])
      a->x(b)     a.trap("x", [b])
      a->x(b, c)  a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Parameters

      • ...args: unknown[]

      Returns HxWatch

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods