@haxall/haxall
    Preparing search index...

    Class HxLib

    Base class for all Haxall library runtime instances. All Haxall libs must be standard Haystack 4 libs. This class is used to model the instance of the library within a HxRuntime to provide runtime services.

    To create a new library:

    1. Create a pod with a standard Haystack 4 "lib/lib.trio" definition
    2. Register the lib name using the indexed prop "ph.lib"
    3. Create subclass of HxLib
    4. Ensure your lib definition has typeName tag for subclass qname

    Also see docHaxall::Libs.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    type$

    Methods

    compare equals hash houseKeepingFreq isImmutable isRunning log name observables observe onHouseKeeping onReady onRecUpdate onStart onSteadyState onStop onUnready rec rt services subscriptions toImmutable toStr trap typeof web with echo make

    Constructors

    Properties

    type$: Type

    Methods

    • 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

    • Equality is based on reference equality

      Parameters

      Returns boolean

    • Identity hash

      Returns number

    • Override to return non-null for onHouseKeeping callback

      Returns Duration

    • 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

    • Running flag. On startup this flag transitions to true before calling ready and start on the library. On shutdown this flag transitions to false before calling unready and stop on the library.

      Returns boolean

    • Logger to use for this library

      Returns Log

    • Programmatic name of the library

      Returns string

    • Return list of observables this extension publishes. This method must be overridden as a const field and set in the constructor.

      Returns List<Observable>

    • Subscribe this library to an observable. The callback must be an Actor instance or Method literal on this class. If callback is a method, then its called on the lib's dedicated background actor. pool. This method should be called in the onStart callback. The observation is automatically unsubscribed on stop. You should not unsubscribe this subscription - it must be managed by the extension itself. See docHaxall::Observables#fantomObserve.

      Parameters

      Returns Subscription

    • Callback made periodically to perform background tasks. Override houseKeepingFreq to enable the frequency of this callback.

      Returns void

    • Callback when all libs are fully started. This is called on dedicated background actor.

      Returns void

    • Callback when associated database rec is modified. This is called on dedicated background actor.

      Returns void

    • Callback when library is started. This is called on dedicated background actor.

      Returns void

    • Callback when runtime reaches steady state. This is called on dedicated background actor.

      Returns void

    • Callback when library is stopped. This is called on dedicated background actor.

      Returns void

    • Callback before we stop the runtime This is called on dedicated background actor.

      Returns void

    • Database record which enables this library and stores settings. This field may be overridden with a haystack::TypedDict subclass. Also see docHaxall::Libs#settings.

      Returns Dict

    • Runtime

      Returns HxRuntime

    • Return list of services this library publishes. This callback is made during initialization and each time a lib is added/removed from the runtime.

      Returns List<HxService>

    • Observable subscriptions for this extension

      Returns List<Subscription>

    • 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>

    • Return name

      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

    • Web service handling for this library

      Returns HxLibWeb

    • 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

    • Framework use only. Subclasses must declare public no-arg constructor.

      Parameters

      • ...args: unknown[]

      Returns HxLib

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods