fluencelabs/dweb-transports
1
0
Fork 0
mirror of https://github.com/fluencelabs/dweb-transports synced 2025-03-16 02:40:49 +00:00
Code Issues Projects Releases Wiki Activity

Move from transports= to paused = in URLS (transport= is still supported)

Browse Source
This commit is contained in:
Mitra Ardron 2018-05-05 21:04:15 -07:00
parent b6587853be
commit 317079a87d
3 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
API.md
View File

@ -271,6 +271,8 @@ The Transports Class manages multiple transports
_transports List of transports loaded (internal) _transports List of transports loaded (internal)
namingcb If set will be called cb(urls) => urls to convert to urls from names. namingcb If set will be called cb(urls) => urls to convert to urls from names.
_transportclasses All classes whose code is loaded e.g. {HTTP: TransportHTTP, IPFS: TransportIPFS} _transportclasses All classes whose code is loaded e.g. {HTTP: TransportHTTP, IPFS: TransportIPFS}
_optionspaused Saves paused option for setup
``` ```
#####static _connected() #####static _connected()

2
Transport.js
View File

@ -347,5 +347,5 @@ Transport.STATUS_CONNECTED = 0; // Connected - all other numbers are some versio
Transport.STATUS_FAILED = 1; // Failed to connect Transport.STATUS_FAILED = 1; // Failed to connect
Transport.STATUS_STARTING = 2; // In the process of connecting Transport.STATUS_STARTING = 2; // In the process of connecting
Transport.STATUS_LOADED = 3; // Code loaded, but haven't tried to connect. (this is typically hard coded in subclasses constructor) Transport.STATUS_LOADED = 3; // Code loaded, but haven't tried to connect. (this is typically hard coded in subclasses constructor)
Transport.STATUS_PAUSED = 4; // It was launched, probably connected, but now paused so will be ignored by validFor Transport.STATUS_PAUSED = 4; // It was launched, probably connected, but now paused so will be ignored by validFor // Note this is copied to dweb-archive/Nav.js so check if change
exports = module.exports = Transport; exports = module.exports = Transport;

28
Transports.js
View File

@ -2,12 +2,19 @@ const Url = require('url');
const errors = require('./Errors'); const errors = require('./Errors');
const utils = require('./utils'); const utils = require('./utils');
/*
Handles multiple transports, API should be (almost) the same as for an individual transport)
*/
class Transports { class Transports {
/*
Handles multiple transports, API should be (almost) the same as for an individual transport)
Fields:
_transports List of transports loaded (internal)
namingcb If set will be called cb(urls) => urls to convert to urls from names.
_transportclasses All classes whose code is loaded e.g. {HTTP: TransportHTTP, IPFS: TransportIPFS}
_optionspaused Saves paused option for setup
*/
constructor(options, verbose) { constructor(options, verbose) {
if (verbose) console.log("Transports(%o)",options); if (verbose) console.log("Transports(%o)",options);
} }
@ -483,12 +490,16 @@ class Transports {
static async p_setup1(verbose, cb) { static async p_setup1(verbose, cb) {
/* Second stage of setup, connect if possible */ /* Second stage of setup, connect if possible */
// Does all setup1a before setup1b since 1b can rely on ones with 1a, e.g. YJS relies on IPFS // Does all setup1a before setup1b since 1b can rely on ones with 1a, e.g. YJS relies on IPFS
await Promise.all(this._transports.map((t) => t.p_setup1(verbose, cb))) await Promise.all(this._transports
.filter((t) => (! this._optionspaused.includes(t.name)))
.map((t) => t.p_setup1(verbose, cb)))
} }
static async p_setup2(verbose, cb) { static async p_setup2(verbose, cb) {
/* Second stage of setup, connect if possible */ /* Second stage of setup, connect if possible */
// Does all setup1a before setup1b since 1b can rely on ones with 1a, e.g. YJS relies on IPFS // Does all setup1a before setup1b since 1b can rely on ones with 1a, e.g. YJS relies on IPFS
await Promise.all(this._transports.map((t) => t.p_setup2(verbose, cb))) await Promise.all(this._transports
.filter((t) => (! this._optionspaused.includes(t.name)))
.map((t) => t.p_setup2(verbose, cb)))
} }
static async refreshstatus(t) { static async refreshstatus(t) {
@ -504,21 +515,24 @@ class Transports {
} }
} }
static async p_connect(options, verbose) { static async p_connect(options, verbose) { //TODO-API paused
/* /*
This is a standardish starting process, feel free to subclass or replace ! This is a standardish starting process, feel free to subclass or replace !
It will connect to a set of standard transports and is intended to work inside a browser. It will connect to a set of standard transports and is intended to work inside a browser.
options = { defaulttransports: ["IPFS"], statuselement: el, http: {}, ipfs: {} } options = { defaulttransports: ["IPFS"], statuselement: el, http: {}, ipfs: {}; paused: ["IPFS"] }
*/ */
if (verbose) console.group("p_connect ---"); if (verbose) console.group("p_connect ---");
try { try {
options = options || {}; options = options || {};
let setupoptions = {}; let setupoptions = {};
let tabbrevs = options.transports; // Array of transport abbreviations let tabbrevs = options.transports; // Array of transport abbreviations
let tpaused = options.paused; // Array of transports paused
if (!(tabbrevs && tabbrevs.length)) { tabbrevs = options.defaulttransports || [] } if (!(tabbrevs && tabbrevs.length)) { tabbrevs = options.defaulttransports || [] }
if (! tabbrevs.length) { tabbrevs = ["HTTP", "YJS", "IPFS", "WEBTORRENT"]; } if (! tabbrevs.length) { tabbrevs = ["HTTP", "YJS", "IPFS", "WEBTORRENT"]; }
tabbrevs = tabbrevs.map(n => n.toUpperCase()); tabbrevs = tabbrevs.map(n => n.toUpperCase());
tpaused = tpaused.map(n => n.toUpperCase()); // In case its input by user instead of saved state in history
let transports = this.setup0(tabbrevs, options, verbose); let transports = this.setup0(tabbrevs, options, verbose);
this._optionspaused = options.paused;
if (options.statuscb) { if (options.statuscb) {
this.statuscb = options.statuscb; this.statuscb = options.statuscb;
} }