Class P2PTransport<T, K>

Internalapi

Type Parameters

T extends P2PPairingRequest | ExtendedP2PPairingResponse
K extends TRANSPORT_P2P_PEERS_DAPP | TRANSPORT_P2P_PEERS_WALLET

Hierarchy (View Summary)

Transport<T, K, P2PCommunicationClient>
- P2PTransport

Index

Constructors

constructor

new P2PTransport<
    T extends ExtendedP2PPairingResponse
    | P2PPairingRequest,
    K extends TRANSPORT_P2P_PEERS_DAPP | TRANSPORT_P2P_PEERS_WALLET,
>(
    name: string,
    keyPair: KeyPair,
    storage: Storage,
    matrixNodes: NodeDistributions,
    storageKey: K,
    iconUrl?: string,
    appUrl?: string,
): P2PTransport<T, K>
Type Parameters
- T extends ExtendedP2PPairingResponse | P2PPairingRequest
- K extends TRANSPORT_P2P_PEERS_DAPP | TRANSPORT_P2P_PEERS_WALLET
Parameters
- name: string
- keyPair: KeyPair
- storage: Storage
- matrixNodes: NodeDistributions
- storageKey: K
- OptionaliconUrl: string
- OptionalappUrl: string
Returns P2PTransport<T, K>
Overrides Transport.constructor
- Defined in beacon-transport-matrix/src/P2PTransport.ts:29

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: T) => void

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

`Protected` `Readonly`peerManager

peerManager: PeerManager<K>

`Readonly`type

type: TransportType = TransportType.P2P

The type of the transport

Accessors

connectionStatus

get connectionStatus(): TransportStatus
Return the status of the connection

Returns TransportStatus
Inherited from Transport.connectionStatus
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:40

Methods

addListener

addListener(
listener: (message: unknown, connectionInfo: ConnectionContext) => void,
): Promise<void>
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
Returns Promise<void>
Inherited from Transport.addListener
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:66

addPeer

addPeer(newPeer: T, _sendPairingResponse?: boolean): Promise<void>
Parameters
- newPeer: T
- Optional_sendPairingResponse: boolean
Returns Promise<void>
Inherited from Transport.addPeer
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:74

connect

connect(): Promise<void>
Connect the transport

Returns Promise<void>
Overrides Transport.connect
- Defined in beacon-transport-matrix/src/P2PTransport.ts:49

disconnect

disconnect(): Promise<void>
Disconnect the transport

Returns Promise<void>
Overrides Transport.disconnect
- Defined in beacon-transport-matrix/src/P2PTransport.ts:72

getPairingRequestInfo

getPairingRequestInfo(): Promise<P2PPairingRequest>
Returns Promise<P2PPairingRequest>
- Defined in beacon-transport-matrix/src/P2PTransport.ts:82

getPeers

getPeers(): Promise<T[]>
Returns Promise<T[]>
Inherited from Transport.getPeers
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:73

listen

listen(publicKey: string): Promise<void>
Parameters
- publicKey: string
Returns Promise<void>
Overrides Transport.listen
- Defined in beacon-transport-matrix/src/P2PTransport.ts:86

`Protected`notifyListeners

notifyListeners(
message: unknown,
connectionInfo: ConnectionContext,
): Promise<void>
Notify the listeners when a new message comes in
Parameters
- message: unknown
  Message
- connectionInfo: ConnectionContext
  Context info about the connection
Returns Promise<void>
Inherited from Transport.notifyListeners
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:83

removeAllPeers

removeAllPeers(): Promise<void>
Returns Promise<void>
Inherited from Transport.removeAllPeers
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:76

removeListener

removeListener(
listener: (message: string, connectionInfo: ConnectionContext) => void,
): Promise<void>
Remove a listener
Parameters
- listener: (message: string, connectionInfo: ConnectionContext) => void
Returns Promise<void>
Inherited from Transport.removeListener
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:72

removePeer

removePeer(peerToBeRemoved: T): Promise<void>
Parameters
- peerToBeRemoved: T
Returns Promise<void>
Inherited from Transport.removePeer
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:75

send

send(message: string, peer?: PeerInfo): Promise<void>
Send a message through the transport
Parameters
- message: string
  The message to send
- Optionalpeer: PeerInfo
Returns Promise<void>
Inherited from Transport.send
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:60

setEventHandler

setEventHandler(event: ClientEvents, fun: Function): void
Parameters
- event: ClientEvents
- fun: Function
Returns void
Inherited from Transport.setEventHandler
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:32

startOpenChannelListener

startOpenChannelListener(): Promise<void>
Returns Promise<void>
- Defined in beacon-transport-matrix/src/P2PTransport.ts:78

`Static`isAvailable

isAvailable(): Promise<boolean>
Returns a promise that resolves to true if the transport is available, false if it is not

Returns Promise<boolean>
Overrides Transport.isAvailable
- Defined in beacon-transport-matrix/src/P2PTransport.ts:45

Class P2PTransport<T, K>

Internalapi

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns P2PTransport<T, K>

Properties

Protected_isConnected

Protectedclient

Protected Readonlyname

Protected OptionalnewPeerListener

Protected ReadonlypeerManager

Readonlytype

Accessors

connectionStatus

Returns TransportStatus

Methods

addListener

Parameters

Returns Promise<void>

addPeer

Parameters

Returns Promise<void>

connect

Returns Promise<void>

disconnect

Returns Promise<void>

getPairingRequestInfo

Returns Promise<P2PPairingRequest>

getPeers

Returns Promise<T[]>

listen

Parameters

Returns Promise<void>

ProtectednotifyListeners

Parameters

Returns Promise<void>

removeAllPeers

Returns Promise<void>

removeListener

Parameters

Returns Promise<void>

removePeer

Parameters

Returns Promise<void>

send

Parameters

Returns Promise<void>

setEventHandler

Parameters

Returns void

startOpenChannelListener

Returns Promise<void>

StaticisAvailable

Returns Promise<boolean>

Settings

On This Page

`Protected`_isConnected

`Protected`client

`Protected` `Readonly`name

`Protected` `Optional`newPeerListener

`Protected` `Readonly`peerManager

`Readonly`type

`Protected`notifyListeners

`Static`isAvailable