Difference between revisions of "LSL Protocol/Restrained Love Open Relay Group/x-xtensions"
m (LSL Protocol/Restrained Life Relay/ORG extensions moved to LSL Protocol/Restrained Life Open Relay Group/x-xtensions: co-located wiht other ORG pages) |
|||
Line 1: | Line 1: | ||
{{ ORG Restrained Life Relay Specs TOC }} | |||
== !x-tensions == | |||
IN PROGRESS DON'T READ | |||
; Description : Queries the relay to discover the list of supported x-tensions | |||
; Implementation : Returns the list of ORG extensions implemented in the relay | |||
; Syntax : '''!x-tensions''' | |||
::(channel) = the channel to be opened up by the relay | |||
:: (time) = the length of time to keep the channel open | |||
; Examples | |||
: Opens up a listener on channel 1234 for one minute '!x-listen/1234/60' | |||
: opens up a listener on channel -56789 indefinitely '!x-listen/-56789' | |||
; Discussion | |||
There are many instances where a relay is embedded in a bigger device (e.g., the Think Kink PBA, collars, and the Cool HUD). These devices often need additional listeners, and might even need listeners for short periods of time to listen to some external object. Of course, it would be simple for the devices to always listen on the specified channel, but that would add to lag which is a big enough problem as it is. The goal here is to allow the device to use the relay channel (to which the person should ''always'' be listening) to open up the additional listener as needed, cutting down on overall lag as the second listener is only open as needed. | |||
It should be the responsibility of the bigger device and not the relay to shut the channel down. | |||
=!x-tensions= | =!x-tensions= | ||
Queries the relay for supported x-tensions. | Queries the relay for supported x-tensions. |
Revision as of 13:42, 11 June 2009
!x-tensions
IN PROGRESS DON'T READ
- Description
- Queries the relay to discover the list of supported x-tensions
- Implementation
- Returns the list of ORG extensions implemented in the relay
- Syntax
- !x-tensions
- (channel) = the channel to be opened up by the relay
- (time) = the length of time to keep the channel open
- Examples
- Opens up a listener on channel 1234 for one minute '!x-listen/1234/60'
- opens up a listener on channel -56789 indefinitely '!x-listen/-56789'
- Discussion
There are many instances where a relay is embedded in a bigger device (e.g., the Think Kink PBA, collars, and the Cool HUD). These devices often need additional listeners, and might even need listeners for short periods of time to listen to some external object. Of course, it would be simple for the devices to always listen on the specified channel, but that would add to lag which is a big enough problem as it is. The goal here is to allow the device to use the relay channel (to which the person should always be listening) to open up the additional listener as needed, cutting down on overall lag as the second listener is only open as needed.
It should be the responsibility of the bigger device and not the relay to shut the channel down.
!x-tensions
Queries the relay for supported x-tensions.
Scenario:
-> blah,k(R),!x-tensions <- blah,k(C),!x-tensions,vision/listen/email
The relay should answer, in the acknowledgement field by the list of supported x-tensions, separated by slashes "/". Note that only the x-tension names are given, not the full list of meta-commands (email extension has 3 meta-commands, for instance). Note that extension names do not contain the "!x-".