constructor new default ( reconnectDelayOnClose ? ) : default Parameters reconnectDelayOnClose : number = 5000 on on : OEvent < ( ( conn : default ,
localPublicKey : PublicKey ,
remotePublicKey : PublicKey ,
connectionRoutesGroupName : string ,
initiatedLocally : boolean ) => void ) > = ... on on : OEvent < ( ( conn : default ,
localPublicKey : PublicKey ,
remotePublicKey : PublicKey ,
connectionRoutesGroupName : string ,
initiatedLocally : boolean ) => void ) > = ... on on : OEvent < ( ( ) => void ) > = ... on on : OEvent < ( ( state : boolean ) => void ) > = ... online get onlineState( ) : boolean Returns boolean add add ( cryptoApi , commServerUrl ) : { id : string ; isNew : boolean ; } Parameters cryptoApi : CryptoApi commServerUrl : string Returns { id : string ; isNew : boolean ; } add add ( cryptoApi , host , port ) : { id : string ; isNew : boolean ; } Parameters cryptoApi : CryptoApi host : string port : number Returns { id : string ; isNew : boolean ; } add add ( cryptoApi , remotePublicKey , commServerUrl , connectionRoutesGroupName ) : { id : string ; isNew : boolean ; } Parameters cryptoApi : CryptoApi remotePublicKey : PublicKey commServerUrl : string connectionRoutesGroupName : string Returns { id : string ; isNew : boolean ; } add add ( cryptoApi , remotePublicKey , host , port , connectionRoutesGroupName ) : { id : string ; isNew : boolean ; } Parameters cryptoApi : CryptoApi remotePublicKey : PublicKey host : string port : number connectionRoutesGroupName : string Returns { id : string ; isNew : boolean ; } add add ( cryptoApi , url , connectionRoutesGroupName ) : { id : string ; isNew : boolean ; } Parameters cryptoApi : SymmetricCryptoApiWithKeys url : string connectionRoutesGroupName : string Returns { id : string ; isNew : boolean ; } close close ( localPublicKey ? , remotePublicKey ? , connectionRoutesGroupName ? , catchAll ? ) : void Parameters OptionallocalPublicKey : PublicKey OptionalremotePublicKey : PublicKey OptionalconnectionRoutesGroupName : string OptionalcatchAll : boolean Returns void connection debug debug ( header ? ) : void Returns void disable disable ( localPublicKey ? , routeId ? ) : Promise < void > Parameters OptionallocalPublicKey : PublicKey OptionalrouteId : string Returns Promise < void > disable disable ( localPublicKey ? , remotePublicKey ? , connectionRoutesGroupName ? , routeId ? ) : Promise < void > Parameters OptionallocalPublicKey : PublicKey OptionalremotePublicKey : PublicKey OptionalconnectionRoutesGroupName : string OptionalrouteId : string Returns Promise < void > enable enable ( localPublicKey ? , routeId ? ) : Promise < void > Parameters OptionallocalPublicKey : PublicKey OptionalrouteId : string Returns Promise < void > enable enable ( localPublicKey ? , remotePublicKey ? , connectionRoutesGroupName ? , routeId ? ) : Promise < void > Parameters OptionallocalPublicKey : PublicKey OptionalremotePublicKey : PublicKey OptionalconnectionRoutesGroupName : string OptionalrouteId : string Returns Promise < void > is is ( url , localPublicKey , remotePublicKey , connectionRoutesGroupName ) : boolean Parameters url : string localPublicKey : PublicKey remotePublicKey : PublicKey connectionRoutesGroupName : string Returns boolean Staticappend append ( connectionRoutesGroup ) : void Returns void
This module manages incoming and outgoing connections.
You can define how a connection between two participants can be reached (called a connection route) and this module will try to open a single connection between those two participants using those routes.
Routes can be enabled / disabled giving the user control of when and how to establish connections.