Class DappP2PTransport

Hierarchy

P2PTransport<ExtendedP2PPairingResponse, TRANSPORT_P2P_PEERS_DAPP>
- DappP2PTransport

Index

Constructors

constructor

Properties

Accessors

connectionStatus

Methods

Constructors

constructor

new DappP2PTransport(name: string, keyPair: KeyPair, storage: Storage, matrixNodes: string[], iconUrl?: string, appUrl?: string): DappP2PTransport

Inherited from P2PTransport.constructor
- Defined in transports/DappP2PTransport.ts:16
Parameters
- name: string
- keyPair: KeyPair
- storage: Storage
- matrixNodes: string[]
- Optional iconUrl: string
- Optional appUrl: string
Returns DappP2PTransport

Properties

Protected _isConnected

_isConnected: TransportStatus = ...

The status of the transport

Protected client

client: P2PCommunicationClient

The client handling the encryption/decryption of messages

Protected Readonly name

name: string

The name of the app

Protected Optional newPeerListener

newPeerListener: (peer: ExtendedP2PPairingResponse) => void

The listener that will be invoked when a new peer is connected

Type declaration

- (peer: ExtendedP2PPairingResponse): void
- Parameters
  - peer: ExtendedP2PPairingResponse
  Returns void

Protected Readonly peerManager

peerManager: PeerManager<TRANSPORT_P2P_PEERS_DAPP>

Readonly type

type: TransportType = ...

The type of the transport

Accessors

connectionStatus

get connectionStatus(): TransportStatus

- Defined in transports/Transport.ts:59
Return the status of the connection

Returns TransportStatus

Methods

addListener

addListener(listener: (message: unknown, connectionInfo: ConnectionContext) => void): Promise<void>

Inherited from P2PTransport.addListener
- Defined in transports/Transport.ts:119
Add a listener to be called when a new message is received

Parameters
- listener: (message: unknown, connectionInfo: ConnectionContext) => void
  
  The listener that will be registered
  - - (message: unknown, connectionInfo: ConnectionContext): void
    - Parameters
      - message: unknown
      - connectionInfo: ConnectionContext
      Returns void
Returns Promise<void>

addPeer

addPeer(newPeer: ExtendedP2PPairingResponse): Promise<void>

Inherited from P2PTransport.addPeer
- Defined in transports/Transport.ts:148
Parameters
- newPeer: ExtendedP2PPairingResponse
Returns Promise<void>

connect

connect(): Promise<void>

Inherited from P2PTransport.connect
- Defined in transports/P2PTransport.ts:50
Returns Promise<void>

disconnect

disconnect(): Promise<void>

Inherited from P2PTransport.disconnect
- Defined in transports/P2PTransport.ts:73
Returns Promise<void>

getPairingRequestInfo

getPairingRequestInfo(): Promise<P2PPairingRequest>

Inherited from P2PTransport.getPairingRequestInfo
- Defined in transports/P2PTransport.ts:83
Returns Promise<P2PPairingRequest>

getPeers

getPeers(): Promise<ExtendedP2PPairingResponse[]>

Inherited from P2PTransport.getPeers
- Defined in transports/Transport.ts:144
Returns Promise<ExtendedP2PPairingResponse[]>

listen

listen(publicKey: string): Promise<void>

Inherited from P2PTransport.listen
- Defined in transports/P2PTransport.ts:87
Parameters
- publicKey: string
Returns Promise<void>

listenForNewPeer

listenForNewPeer(newPeerListener: (peer: ExtendedP2PPairingResponse) => void): Promise<void>

- Defined in transports/DappP2PTransport.ts:43
Parameters
- newPeerListener: (peer: ExtendedP2PPairingResponse) => void
  - - (peer: ExtendedP2PPairingResponse): void
    - Parameters
      - peer: ExtendedP2PPairingResponse
      Returns void
Returns Promise<void>

Protected notifyListeners

notifyListeners(message: unknown, connectionInfo: ConnectionContext): Promise<void>

Inherited from P2PTransport.notifyListeners
- Defined in transports/Transport.ts:180
Notify the listeners when a new message comes in

Parameters
- message: unknown
  
  Message
- connectionInfo: ConnectionContext
  
  Context info about the connection
Returns Promise<void>

removeAllPeers

removeAllPeers(): Promise<void>

Inherited from P2PTransport.removeAllPeers
- Defined in transports/Transport.ts:166
Returns Promise<void>

removeListener

removeListener(listener: (message: string, connectionInfo: ConnectionContext) => void): Promise<void>

Inherited from P2PTransport.removeListener
- Defined in transports/Transport.ts:134
Remove a listener

Parameters
- listener: (message: string, connectionInfo: ConnectionContext) => void
  - - (message: string, connectionInfo: ConnectionContext): void
    - Parameters
      - message: string
      - connectionInfo: ConnectionContext
      Returns void
Returns Promise<void>

removePeer

removePeer(peerToBeRemoved: ExtendedP2PPairingResponse): Promise<void>

Inherited from P2PTransport.removePeer
- Defined in transports/Transport.ts:158
Parameters
- peerToBeRemoved: ExtendedP2PPairingResponse
Returns Promise<void>

send

send(message: string, peer?: PeerInfo): Promise<void>

Inherited from P2PTransport.send
- Defined in transports/Transport.ts:102
Send a message through the transport

Parameters
- message: string
  
  The message to send
- Optional peer: PeerInfo
Returns Promise<void>

startOpenChannelListener

startOpenChannelListener(): Promise<void>

Overrides P2PTransport.startOpenChannelListener
- Defined in transports/DappP2PTransport.ts:28
Returns Promise<void>

stopListeningForNewPeers

stopListeningForNewPeers(): Promise<void>

- Defined in transports/DappP2PTransport.ts:50
Returns Promise<void>

Static isAvailable

isAvailable(): Promise<boolean>

Inherited from P2PTransport.isAvailable
- Defined in transports/P2PTransport.ts:46
Returns Promise<boolean>

Generated using TypeDoc