JSDoc: Class: ConnectivityManager

Constructor

new ConnectivityManager(cypherpokerRef)

Creates an instance of ConnectivityManager.

Parameters:

Name	Type	Description
`cypherpokerRef`	CypherPoker	The CypherPoker instance for which this class is controlling connectivity.

Source:

libs/ConnectivityManager.js, line 13

See:

Extends

EventDispatcher

Members

api

Properties:

Name	Type	Default	Description
`api`	Object	null	Reference to a multi-network routing interface over which RPC API functions are invoked. For example, APIRouter.

Source:

libs/ConnectivityManager.js, line 91

(readonly) apiConnected

Properties:

Name	Type	Default	Description
`apiConnected`	Boolean	false	True if the instance is connected to the API services provider and ready to accept requests.

Source:

libs/ConnectivityManager.js, line 107

(readonly) cypherpoker

Properties:

Name	Type	Description
`cypherpoker`	CypherPoker	The main CypherPoker instance for which this class is managing connectivity, as set at instantiation.

Source:

libs/ConnectivityManager.js, line 67

p2p

Properties:

Name	Type	Default	Description
`p2p`	Object	null	Reference to a peer-to-peer multi-network routing interface supporting a dynamic private ID, direct send (single or multi), and broadcast functionality. For example, P2PRouter

Source:

libs/ConnectivityManager.js, line 76

(readonly) p2pConnected

Properties:

Name	Type	Default	Description
`p2pConnected`	Boolean	false	True if the instance is connected to the peer-to-peer network and ready to accept requests.

Source:

libs/ConnectivityManager.js, line 116

selectors

Properties:

Name Type Description

selectors

Object

Name/value pairs for UI elements and their associated CSS-style DOM selectors within the connectivity management template connectivityManage.html

Properties

Name	Type	Default	Description
`gatewaysList`	String	"#gatewaysList"	Pulldown selection list of available server gateways.
`serverSDBTypeRadioGroup`	String	"#serverSDBTypeRadioGroup"	Radio group containing options for the SDB variant to generate when starting a gateway.
`serverSDB`	String	"#serverSDB"	The generated SDB textfield element for the server when it's started.
`serverAccessGroup`	String	"#serverAccessGroup"	Checkbox button group for determining the inclusion of entity types (e.g. "api", "p2p", etc.), in the SDB.
`connectSDB`	String	"#connectSDB"	Textarea containing SDB to use for establishing connection(s).
`apiConnectionList`	String	"#apiConnectionList"	Pulldown selection list of saved API connections.
`apiConnectionURL`	String	"#apiConnectionURL"	The URL input field for the API connection.
`apiConnectionCreate`	String	"#apiConnectionCreate"	The API creation JavaScript snippet input field.
`p2pConnectionList`	String	"#p2pConnectionList"	Pulldown selection list of saved P2P connections.
`p2pConnectionURL`	String	"#p2pConnectionURL"	The URL input field for the P2P connection.
`p2pConnectionCreate`	String	"#p2pConnectionCreate"	The P2P creation JavaScript snippet input field.
`manualConnectionData`	String	"#manualConnectionData"	A TextArea input for establishing manual peer to peer connections input field.

Source:

libs/ConnectivityManager.js, line 45

Methods

addEventListener(type, listener, contextopt)

Registers a new event listener with the extending class instance.

Parameters:

Name	Type	Attributes	Default	Description
`type`	String			The event type to register.
`listener`	function			The listening function to invoke on the event.
`context`	Object	<optional>	null	Unlike the traditional `addEventListener` parameter, this is the context or scope in which to invoke the listening function (since we can't use capture phases). If null, the listener is invoked in the context of the EventDispatcher or extending instance.

Inherited From:

EventDispatcher#addEventListener

Source:

libs/EventDispatcher.js, line 56

adjustURL(connectionURL) → {String}

Adjusts a URL that contains additional information that would be considered invalid (such as a "tunnel@" protocol prefix, for example).

Parameters:

Name	Type	Description
`connectionURL`	String	The URL to adjust.

Source:

libs/ConnectivityManager.js, line 858

Returns:

The adjusted URL.

Type: String

canShareConnections(connectObj1, connectObj2) → {Boolean}

Determines if two connection and transport settings objects are the same and can therefore be shared.

Parameters:

Name	Type	Description
`connectObj1`	Object	The first connection info object to compare.
`connectObj2`	Object	The second connection info object to compare.

Source:

libs/ConnectivityManager.js, line 261

Returns:

True if both the URLs and transports specified by the settings are the same, false otherwise.

Type: Boolean

(async) confirmConnectAPI(gameActiveopt, joinActiveopt)

Trigerred after onConnectAPIClick either directly or as a result of a confirmation by the plyer. A new API connection is established by gathering the url, create script, and generating a connection type via getTransportType, creating a new connectInfo object, and using it to replace the current cypherpoker.settings.api.connectInfo setting.

Parameters:

Name	Type	Attributes	Default	Description
`gameActive`	Boolean	<optional>	false	If true, any existing games are destroyed prior to establishing the new connection.
`joinActive`	Boolean	<optional>	false	If true, any existing table advertisement or join requests are cancelled prior to establishing the new connection.

Source:

libs/ConnectivityManager.js, line 1041

(async) confirmConnectP2P(gameActiveopt, joinActiveopt)

Trigerred after onConnectP2PClick either directly or as a result of a confirmation by the plyer. A new P2P connection is established by gathering the url, create script, and generating a connection type via getTransportType, creating a new connectInfo object, and using it to replace the current cypherpoker.settings.p2p.connectInfo setting.

Parameters:

Name	Type	Attributes	Default	Description
`gameActive`	Boolean	<optional>	false	If true, any existing games are destroyed prior to establishing the new connection.
`joinActive`	Boolean	<optional>	false	If true, any existing table advertisement or join requests are cancelled prior to establishing the new connection.

Source:

libs/ConnectivityManager.js, line 1170

(async) confirmConnectSDB(gameActiveopt, joinActiveopt)

Trigerred after onConnectUsingSDBClick either directly or as a result of a confirmation by the plyer. New connection(s) is/are determined from the SDB, closing any current connections, and establishing new ones.

Parameters:

Name	Type	Attributes	Default	Description
`gameActive`	Boolean	<optional>	false	If true, any existing games are destroyed prior to establishing the new connection.
`joinActive`	Boolean	<optional>	false	If true, any existing table advertisement or join requests are cancelled prior to establishing the new connection.

Source:

libs/ConnectivityManager.js, line 987

(async) connectAPI(sharedConnectionopt) → {Promise}

Creates a new API connection specified in the api definition of the settings object, and assigns it to the api reference. If a connection aready exists, it's destroyed and removed first.

Parameters:

Name	Type	Attributes	Default	Description
`sharedConnection`	Object	<optional>	null	An optional shared / multiplexed connection already established (for example, the connection used for the p2p);

Source:

libs/ConnectivityManager.js, line 450

Returns:

The returned promise will resolve with the true if the connection was successfully established and false if the connection attempt failed.

Type: Promise

(async) connectFromSDB(sdb, entityTypeopt, statusCBopt) → {Promise}

Establishes connection(s) using information from a Services Descriptor Bundle. This may result in new api and/or p2p instances being created and connected. Related connectInfo objects in the settings object are updated accordingly.

Parameters:

Name	Type	Attributes	Default	Description
`sdb`	String \| Array			Either Base85 / Ascii85 (including `-s` variant), or Base64 encoded string, or a native JavaScript array containing SDB entities.
`entityType`	String	<optional>	"*"	The type of SDB entity to connect to, if contained in the `sdb`. Valid types are "api" or "p2p". If "*" is supplied, all included entities are connected.
`statusCB`	function	<optional>	null	Optional callback function that tracks the status of the connection(s) progress. This function will receive a single object parameter with properties `entity` (the entity for which the status is being reported), `status` (either "connecting", "connected", or "failed"), and `url` (the assembled connection URL).

Source:

libs/ConnectivityManager.js, line 300

Returns:

The returned promise will resolve with the true if all the specified connections connected successfuly, or false if one or more failed.

Type: Promise

(async) connectP2P(sharedConnectionopt) → {Promise}

Creates a new peer-to-peer rendezvous / signalling connection specified in the p2p definition of the settings object, and assigns it to the p2p reference. If a connection aready exists, it's destroyed and removed first.

Parameters:

Name	Type	Attributes	Default	Description
`sharedConnection`	Object	<optional>	null	An optional shared / multiplexed connection already established (for example, the connection used for the api);

Source:

libs/ConnectivityManager.js, line 491

Returns:

The returned promise will resolve with the true if the connection was successfully established and false if the connection attempt failed.

Type: Promise

getConnectionName(connectionInfo) → {String}

Returns a descriptive, human-readable name for a connection type.

Parameters:

Name	Type	Description
`connectionInfo`	String \| Object	Either a connection type to evaluate directly or an object containing a `type` property to evaluate.

Source:

libs/ConnectivityManager.js, line 763

Returns:

A descriptive name for the connection type. A blank string is returned for any unrecignized type.

Type: String

getConnectionParameters(connectionURL) → {URLSearchParams}

Returns the parameters included with a supplied URL.

Parameters:

Name	Type	Description
`connectionURL`	String	The URL from which to determine the parameters.

Source:

libs/ConnectivityManager.js, line 877

Returns:

The parameters included with the URL

Type: URLSearchParams

getConnectionSecurity(connectionInfo, addSpaceopt) → {String}

Returns a human-readable security descriptor (e.g. "Secure") for a connection type.

Parameters:

Name	Type	Attributes	Default	Description
`connectionInfo`	String \| Object			Either a connection url to evaluate directly or an object containing a `url` property to evaluate.
`addSpace`	Boolean	<optional>	true	If true, an extra space is added to the end of the descriptor unless it's an empty string.

Source:

libs/ConnectivityManager.js, line 794

Returns:

The security descriptor, either "Secure" or an empty string for insecure.

Type: String

getListeners(type) → {Array}

Returns all registered listeners for a specific event type.

Parameters:

Name	Type	Description
`type`	String	The event type to return registered listeners for.

Inherited From:

EventDispatcher#getListeners

Source:

libs/EventDispatcher.js, line 40

Returns:

A list of registered event listener objects for the specific event. Each object contains a listener function reference and an execution context reference.

Type: Array

getSavedConnections(connectionTypeopt) → {Array|Object}

Loads any saved connections stored by the user.

Parameters:

Name	Type	Attributes	Default	Description
`connectionType`	String	<optional>	null	The type of connection information to retrieve, either `api` or `p2p`

Source:

libs/ConnectivityManager.js, line 711

Returns:

Indexed array of objects containing saved connection information, or an object containing all saved connections contained in named indexed arrays.

Type: Array | Object

getTransportType(connectionURL) → {String}

Returns the transport type based on a supplied URL.

Parameters:

Name	Type	Description
`connectionURL`	String	The URL from which to determine the transport type.

Source:

libs/ConnectivityManager.js, line 828

Returns:

The transport type represented by the URL. null is returned if the transport type can't be determined.

Type: String

(async) onConnectAPIClick()

Invoked by a button on the API connectivity form to trigger a connection to the currently selected (or manually entered), connection. Prior to triggering this action, this function displays warning dialogs if a game or a table advertisement / join request is currently active.

Source:

libs/ConnectivityManager.js, line 951

(async) onConnectP2PClick()

Invoked by a button on the P2P connectivity form to trigger a connection to the currently selected (or manually entered), connection. Prior to triggering this action, this function displays warning dialogs if a game or a table advertisement / join request is currently active.

Source:

libs/ConnectivityManager.js, line 1131

(async) onConnectUsingSDBClick()

Invoked by the SDB connect button in the connectivity options of the user interface (the alternative to manual address entry).

Source:

libs/ConnectivityManager.js, line 645

(async) onEnableServerAccessClick(cbRef)

Invoked by the toggle switch used to enable external access to API / P2P functionality.

Parameters:

Name	Type	Description
`cbRef`	HTMLElement	The styled checkbox (sliding toggle), that trigerred this function.

Source:

libs/ConnectivityManager.js, line 524

(async) onSaveAPIClick()

Invoked by a button on the API connectivity form to trigger the saving of information currently enetered into the form as a new entry which will subsequently be included in the population of the API connections. list.

Source:

libs/ConnectivityManager.js, line 1094

(async) onSaveP2PClick()

Invoked by a button on the P2P connectivity form to trigger the saving of information currently enetered into the form as a new entry which will subsequently be included in the population of the P2P connections. list.

Source:

libs/ConnectivityManager.js, line 1223

onServerSDBOptionClick()

Invoked when any of the SDb generation options (radio buttons or checkboxes), are clicked in the server portion of the connectivity management interface.

Source:

libs/ConnectivityManager.js, line 618

populateAPIConnectionInputs()

Populates the API connection input fields (url and create script) in the user interface, using the currently selected option in the API connections list (HTML select element).

Source:

libs/ConnectivityManager.js, line 933

populateConnectionsList(connectionType, defaultSelectionopt)

Populates a pulldown selection list (HTML select element), with connection options. The existing / default connection information specified in the CypherPoker.settings is added to the list first so that there will always be at least one option.

Parameters:

Name	Type	Attributes	Default	Description
`connectionType`	String			The type of connection list to populate, either "api" or "p2p".
`defaultSelection`	String	<optional>	null	The default selection to set the list to. If `null` the first (current / default) option is selected.

Source:

libs/ConnectivityManager.js, line 894

populateGatewaysList()

Populates the list of enabled gateways in the server portion of the connectivity management interface,

Source:

libs/ConnectivityManager.js, line 172

populateP2PConnectionInputs()

Populates the P2P connection input fields (url and create script) in the user interface, using the currently selected option in the P2P connections list (HTML select element).

Source:

libs/ConnectivityManager.js, line 1113

populateServerSDB(gatewayObj)

Populates the server-generated SDB textarea element in the user interface when server connectivity is enabled, or when the SDB format or options change.

Parameters:

Name	Type	Description
`gatewayObj`	Object	Object containing information about the gateway such as would be added in during populateGatewaysList.

Source:

libs/ConnectivityManager.js, line 581

registerListener(eventType, router, funcRef, context)

Registers an event listener for an event handled by this class. Any changes to connectivity will also include updates to registered listeners.
Currently supported listeners include:

"message" - dispatched by the p2p











    Parameters:
    


    
    
        
        Name
        

        Type

        

        

        Description
    
    

    
    

        
            
                eventType
            

            
            
                
String


            
            

            

            

            The type of event to register a listener for.
        

    

        
            
                router
            

            
            
                
String


            
            

            

            

            The router type to register the listener with. Valid types
include "api" and "p2p".
        

    

        
            
                funcRef
            

            
            
                
function


            
            

            

            

            The handler function to register for the event.
        

    

        
            
                context
            

            
            
                
*


            
            

            

            

            The context in which to execute funcRef.
        

    
    









    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        libs/ConnectivityManager.js, line 134
    
    

    

    

    



















        
            

    

    
    removeEventListener(type, listener, contextopt)
    

    




    Removes an event listener from the extending instance.










    Parameters:
    


    
    
        
        Name
        

        Type

        
        Attributes
        

        
        Default
        

        Description
    
    

    
    

        
            
                type
            

            
            
                
String


            
            

            
                
                

                

                
                
            

            
                
                
                
            

            The event type to remove the function from.
        

    

        
            
                listener
            

            
            
                
function


            
            

            
                
                

                

                
                
            

            
                
                
                
            

            The listening function to remove.
        

    

        
            
                context
            

            
            
                
Object


            
            

            
                
                
                    <optional>

                

                

                
                
            

            
                
                
                    null
                
                
            

            The context or scope in which the listener exists.
        

    
    









    

    

    
    Inherited From:
    
        EventDispatcher#removeEventListener
    
    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        libs/EventDispatcher.js, line 73
    
    

    

    

    



















        
            

    

    
    (async) saveConnection(connectionInfo, connectionType) → {Boolean}
    

    




    Saves a connection info object for later retieval.










    Parameters:
    


    
    
        
        Name
        

        Type

        

        

        Description
    
    

    
    

        
            
                connectionInfo
            

            
            
                
Object


            
            

            

            

            An object containing information on how to establish
the connection.
        

    

        
            
                connectionType
            

            
            
                
String


            
            

            

            

            The type of connection that connectionInfo
represents, either "api" or "p2p".
        

    
    









    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        libs/ConnectivityManager.js, line 739
    
    

    

    

    














Returns:

        

    True if the information was successfully saved, false otherwise.





    
        Type
    
    
        
Boolean


    


    





        
            

    

    
    serverSDBToClipboard()
    

    




    Copies the current contents of the server-generated SDB textarea element
to the system clipboard.
















    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        libs/ConnectivityManager.js, line 634
    
    

    

    

    



















        
            

    

    
    showSDBConnectStatus()
    

    




    Displays connection status using the main dialog when a connection attempt
has been started using a SDB.
















    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        libs/ConnectivityManager.js, line 670
    
    

    

    

    



















        
            

    

    
    (async) startConnections(apiFatalFailopt, p2pFatalFailopt)
    

    




    Creates and starts the api and p2p
connections by calling connectAPI and
connectP2P.










    Parameters:
    


    
    
        
        Name
        

        Type

        
        Attributes
        

        
        Default
        

        Description
    
    

    
    

        
            
                apiFatalFail
            

            
            
                
Boolean


            
            

            
                
                
                    <optional>

                

                

                
                
            

            
                
                
                    false
                
                
            

            If true, a connection failure to the API
services server is considered fatal and will throw an exception, otherwise only
a connection failure warning is displayed in the console.
        

    

        
            
                p2pFatalFail
            

            
            
                
Boolean


            
            

            
                
                
                    <optional>

                

                

                
                
            

            
                
                
                    false
                
                
            

            If true, a connection failure to the
peer-to-peer network is considered fatal and will throw an exception, otherwise
only a connection failure warning is displayed in the console.
        

    
    









    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        libs/ConnectivityManager.js, line 208

Name	Type	Description
`eventType`	String	The type of event to register a listener for.
`router`	String	The router type to register the listener with. Valid types include `"api"` and `"p2p"`.
`funcRef`	function	The handler function to register for the event.
`context`	*	The context in which to execute `funcRef`.

Name	Type	Attributes	Default	Description
`type`	String			The event type to remove the function from.
`listener`	function			The listening function to remove.
`context`	Object	<optional>	null	The context or scope in which the listener exists.

Name	Type	Description
`connectionInfo`	Object	An object containing information on how to establish the connection.
`connectionType`	String	The type of connection that `connectionInfo` represents, either "api" or "p2p".

Name	Type	Attributes	Default	Description
`apiFatalFail`	Boolean	<optional>	false	If true, a connection failure to the API services server is considered fatal and will throw an exception, otherwise only a connection failure warning is displayed in the console.
`p2pFatalFail`	Boolean	<optional>	false	If true, a connection failure to the peer-to-peer network is considered fatal and will throw an exception, otherwise only a connection failure warning is displayed in the console.