Difference between revisions of "User:Dzonatas Sol/SNOW-375 Resources/Interface"

From Second Life Wiki
Jump to: navigation, search
(Created page with '{| border="1" cellpadding="5" cellspacing="0" |- | Resource || Method || Description |- |- | rowspan="1" | /Interface/Connect | style="text-align:right;" | POST | Attempt to neg...')
 
Line 1: Line 1:
 +
__NOTOC__
 
{| border="1" cellpadding="5" cellspacing="0"
 
{| border="1" cellpadding="5" cellspacing="0"
 
|-
 
|-
Line 7: Line 8:
 
| rowspan="1" | /Interface/Connect
 
| rowspan="1" | /Interface/Connect
 
| style="text-align:right;" | POST
 
| style="text-align:right;" | POST
| Attempt to negotiate a connection to enable the above resources
+
| -> &connect <- &result
  
 +
|-
 +
| rowspan="1" | /Interface/UI
 +
| style="text-align:right;" | POST
 +
| -> { UI: bool } <- { status: string }
 +
 +
|-
 +
| rowspan="1" | /Interface/Status
 +
| style="text-align:right;" | POST
 +
| -> { Status: string } <- { status: string }
 +
 +
|}
 +
 +
 +
== /Interface/Connect ==
 +
 +
=== Forward: ===
 +
 +
Attempt to negotiate a connection. A reverse /Interface/Connect query is made by this forward interface, which is the Snowglobe Viewer.
 +
 +
An optional session cookie is set as an extra security measure to in order to lock-down a single client/server connection.
 +
 +
=== Reverse: ===
 +
 +
The application that requested the initial connection also listens for this query. On a successful query the Snowglobe's ControlGroup variable "InterfaceStartupCapability" is set to http://host:port/Interface/Connect, as detected by the forward interface.
 +
 +
 +
== /Interface/Status ==
 +
 +
A message that describes the changed state of the connection.
 +
 +
 +
== connect ==
 +
 +
{
 +
{|
 +
|-
 +
| (host)
 +
| : string
 +
|-
 +
| port
 +
| : integer
 +
|}
 +
}
 +
 +
Host is optional for remote sessions.
 +
 +
 +
== result ==
 +
 +
{
 +
{|
 +
|-
 +
| status
 +
| : string
 +
|-
 +
| session
 +
| : uuid
 +
|-
 +
| Version
 +
| : string
 
|}
 
|}
 +
|

Revision as of 19:13, 31 July 2010

Resource Method Description
/Interface/Connect POST -> &connect <- &result
/Interface/UI POST -> { UI: bool } <- { status: string }
/Interface/Status POST -> { Status: string } <- { status: string }


/Interface/Connect

Forward:

Attempt to negotiate a connection. A reverse /Interface/Connect query is made by this forward interface, which is the Snowglobe Viewer.

An optional session cookie is set as an extra security measure to in order to lock-down a single client/server connection.

Reverse:

The application that requested the initial connection also listens for this query. On a successful query the Snowglobe's ControlGroup variable "InterfaceStartupCapability" is set to http://host:port/Interface/Connect, as detected by the forward interface.


/Interface/Status

A message that describes the changed state of the connection.


connect

{

(host)  : string
port  : integer

}

Host is optional for remote sessions.


result

{

status  : string
session  : uuid
Version  : string

|