- Methods: All Methods Documented Methods Hide Methods
- Source: Display Source Hide Source
- Variables: Show Variables Hide Variables
Class ::xo::MessageRelay
::xo::MessageRelayGeneric Message Relay classcreate ...
Defined in packages/xotcl-core/tcl/message-relay-procs.tcl
Class Relations
Methods (to be applied on instances)
can_be_used (scripted, public)
<instance of xo::MessageRelay> can_be_used
Check, if a message relay can be used in the current configuration.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
encode_message (scripted, public)
<instance of xo::MessageRelay> 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):
- Testcases:
- No testcase defined.
send_to_subscriber (scripted, public)
<instance of xo::MessageRelay> 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):
- Testcases:
- No testcase defined.
subscribe (scripted, public)
<instance of xo::MessageRelay> 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):
- Testcases:
- No testcase defined.
sweep (scripted, public)
<instance of xo::MessageRelay> sweep key
Check existing subscriptions and clean stale ones.
- Parameters:
- key - key of the communication hub
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
- Methods: All Methods Documented Methods Hide Methods
- Source: Display Source Hide Source
- Variables: Show Variables Hide Variables