@haxall/haxall
    Preparing search index...

    Class ConnectConfig

    Configuration for a CONNECT request

    Hierarchy (View Summary)

    • Obj
      • ConnectConfig
    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Parameters

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      Returns void

    • The authentication data.

      This setting only applies to clients with version >= 5

      Returns Buf

    • The authentication method to use. If null, extended authentication is not performed.

      This setting only applies to clients with version >= 5

      Returns string

    • Is a clean session (v3) or clean start (v5) requested

      Returns boolean

    • 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

    • How long to wait for CONNACK after the CONNECT message is sent

      Returns Duration

    • 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

    • 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 keep-alive time interval (which will be converted to seconds)

      Returns Duration

    • The maximum packets size the client is willing to accept. May not be set to zero. If set to null, there is no limit on the packet size.

      This setting only applies to clients with version >= 5

      Returns number

    • The password

      Returns Buf

    • Used to limit the number of QoS 1 and QoS 2 publications that the client is willing to process concurrently. May not set to zero.

      This setting only applies to clients with version >= 5

      Returns number

    • If false, the server may return a reason string or user properties on a CONNACK or DISCONNECT packet, but MUST NOT send a reason string or user properties on any packet other than PUBLISH, CONNACK, or DISCONNECT.

      If true, the server may return a reason string or user properties on any packet where it is allowed.

      This setting only applies to clients with version >= 5

      Returns boolean

    • If true, the client is requesting the server to return response information in the CONNACK (but the server may choose not to).

      This setting only applies to clients with version >= 5

      Returns boolean

    • The session expiry interval (in seconds). If set to 0, the session ends when the network connection is closed. If set to 0xFFFF_FFFF the session does not expire.

      This setting only applies to clients with version >= 5

      Returns Duration

    • 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

    • The username

      Returns string

    • User properties to send as part of the connection request.

      This setting only applies to clients with version >= 5

      Returns List<StrPair>

    • 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