%3 ::nx::Object ::nx::Object __default_accessor __default_method_call_protection __object_configureparameter __resolve_method_path contains copy delete object method delete object property delete object variable destroy_on_cleanup info info info lookup parameters info lookup slots info lookup syntax info lookup variables info object method args info object method body info object method callprotection info object method debug info object method definition info object method definitionhandle info object method deprecated info object method exists info object method handle info object method origin info object method parameters info object method registrationhandle info object method returns info object method submethods info object method syntax info object method type info object slots info object variables info variable definition info variable name info variable parameter move object alias object forward object method object property object variable private protected public qn require namespace require object method require private object method require protected object method require public object method serialize ::xo::MessageRelay ::xo::MessageRelay can_be_used encode_message send_to_subscriber start_of_page subscribe sweep ::xo::MessageRelay->::nx::Object

Class ::xo::MessageRelay

::xo::MessageRelay[i] create ...
Generic Message Relay class
Defined in packages/xotcl-core/tcl/message-relay-procs.tcl

Class Relations

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

Methods (to be applied on instances)

  • can_be_used (scripted, public)

     <instance of xo::MessageRelay[i]> can_be_used

    Check, if a message relay can be used in the current configuration.

    Testcases:
    No testcase defined.

  • encode_message (scripted, public)

     <instance of xo::MessageRelay[i]> encode_message mode msg

    Provide different "encoding" depending on the mode. Notice that for one chat, multiple clients might have difference modes, since the modes are determined at also by the capabilities of the client browser. So the incoming message has to be recoded multiple times.

    Parameters:
    mode (required)
    msg (required)

    Testcases:
    No testcase defined.

  • send_to_subscriber (scripted, public)

     <instance of xo::MessageRelay[i]> send_to_subscriber key msg

    Send a message to a service identified by the key (communication hub).

    Parameters:
    key (required)
    id for an existing communication hub
    msg (required)
    message to be sent

    Testcases:
    No testcase defined.

  • subscribe (scripted, public)

     <instance of xo::MessageRelay[i]> subscribe [ -initmsg initmsg ] \
    [ -mode mode ] key

    Subscribe to a service identified by a key.

    Switches:
    -initmsg (optional)
    optional message to be sent, when subscription happens
    -mode (optional, defaults to "default")
    optional mode
    Parameters:
    key (required)
    unique id for a (potentially new communication hub)

    Testcases:
    No testcase defined.

  • sweep (scripted, public)

     <instance of xo::MessageRelay[i]> sweep key

    Check existing subscriptions and clean stale ones.

    Parameters:
    key (required)
    key of the communication hub

    Testcases:
    No testcase defined.