@haxall/haxall
    Preparing search index...

    Class Message

    A message contains the application payload and delivery options for a publish packet.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Parameters

      • it: string

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: boolean

      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

    • The content type of the application message

      This setting only applies to clients with version >= 5

      Returns string

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • If specified, this is the lifetime of the application message in seconds. If the message expirty interval has passed and the server has not managed to start onward delivery to a matching subscriber, then the server MUST delete the copy of the message for that subscriber.

      If null, the application message does not expire.

      This option only applies to clients with version >= 5

      Returns Duration

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • 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 application payload.

      Since it is const make sure you use payload.in to read the contents of the payload.

      Returns Buf

    • Get the message properties from the configured fields.

      Returns Properties

    • The requested quality of service

      Returns QoS

    • Should the message be retained?

      Returns boolean

    • 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 a string representation of this object.

      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

    • User properties to send as part of the message.

      This setting only applies to clients with version >= 5

      Returns List<StrPair>

    • Set to true to notify the server and all recipients that the payload of the message is UTF-8 encoded character data. If false, the payload is treated as unspecified bytes

      This option only applies to clients with version >= 5

      Returns boolean

    • 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

      • f: (arg0: Message) => void
      • ...args: unknown[]

      Returns Message

    • Parameters

      • payload: Buf
      • Optionalqos: QoS
      • Optionalretain: boolean
      • Optionalf: (arg0: Message) => void
      • ...args: unknown[]

      Returns Message