%3 ::nx::Object ::nx::Object ::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.

    Partial Call Graph (max 5 caller/called nodes):
    %3

    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
    msg

    Partial Call Graph (max 5 caller/called nodes):
    %3 security::csp::nonce security::csp::nonce (public) xo::MessageRelay instproc encode_message xo::MessageRelay instproc encode_message xo::MessageRelay instproc encode_message->security::csp::nonce

    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 - id for an existing communication hub
    msg - message to be sent

    Partial Call Graph (max 5 caller/called nodes):
    %3

    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
    (defaults to "default") (optional)
    optional mode
    Parameters:
    key - unique id for a (potentially new communication hub)

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.

  • sweep (scripted, public)

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

    Check existing subscriptions and clean stale ones.

    Parameters:
    key - key of the communication hub

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.