Skip to main content Link Menu Expand (external link) Document Search Copy Copied

["tunnel", "connect"]

Table of contents

  1. Description
  2. Specification
    1. Requests
      1. Args
    2. Responses
  3. Support table
  4. Examples
    1. Requests

Description

This request is related to the rooms specification. It allows peers to create a tunnel used for communication using a third peer which acts as a relay.

The location of the primary documentation for this request is unknown.

Specification

Requests

Name 
["tunnel", "connect"]
Type 
"duplex"
Args Must be an array containing exactly one object.

Args

The object within the args array must have the following schema:

Field name Required Type Description 
portal
 
true
 
string

Id of the relay server. All observed requests used the at-sign format.

Set when a peer connects to a relay server.

Set when a relay server connects to a target peer. 

target
 
true
 
string

Id of the target peer. All observed requests used the at-sign format.

Set when a peer connects to a relay server.

Set when a relay server connects to a target peer. 

origin
 
false
 
string

Id of the peer which asked for the tunnel to be created. All observed requests used the at-sign format.

Set when a relay server connects to a target peer.

Notes:

  • When a peer connects to a relay server two arguments are set portal and target.
  • When a relay server connects to a target peer three arguments are set portal , target and origin.

Responses

Unknown.

Support table

Sends Accepts
go-ssb
v0.2.1
Unknown.
v0.2.1
Unknown.
Patchwork
3.18.1
Unknown.
3.18.1
Unknown.
Manyverse
v0.2203.21-beta
Unknown.
v0.2203.21-beta
Unknown.

Examples

Requests

Unknown.