Class Transport<T, K, S>

Type parameters

T: PeerInfo = PeerInfo
K: TRANSPORT_P2P_PEERS_DAPP | TRANSPORT_P2P_PEERS_WALLET | TRANSPORT_POSTMESSAGE_PEERS_DAPP | TRANSPORT_POSTMESSAGE_PEERS_WALLET = any
S: CommunicationClient = any

Hierarchy

Transport
- PostMessageTransport
- P2PTransport

Index

Constructors

constructor

Properties

Accessors

connectionStatus

Methods

Constructors

constructor

new Transport<T, K, S>(name: string, client: S, peerManager: PeerManager<K>): Transport<T, K, S>

- Defined in transports/Transport.ts:61
Type parameters
- T: PeerInfo = PeerInfo
- K: TRANSPORT_P2P_PEERS_DAPP | TRANSPORT_P2P_PEERS_WALLET | TRANSPORT_POSTMESSAGE_PEERS_DAPP | TRANSPORT_POSTMESSAGE_PEERS_WALLET = any
- S: CommunicationClient<S> = any
Parameters
- name: string
- client: S
- peerManager: PeerManager<K>
Returns Transport<T, K, S>

Properties

Protected _isConnected

_isConnected: TransportStatus = ...

The status of the transport

Protected client

client: S

The client handling the encryption/decryption of messages

Private listeners

listeners: ((message: unknown, connectionInfo: ConnectionContext) => void)[] = ...

The listeners that will be notified when new messages are coming in

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

Type declaration

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

Protected Readonly peerManager

peerManager: PeerManager<K>

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>

- 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: T, _sendPairingResponse?: boolean): Promise<void>

- Defined in transports/Transport.ts:148
Parameters
- newPeer: T
- _sendPairingResponse: boolean = true
Returns Promise<void>

connect

connect(): Promise<void>

- Defined in transports/Transport.ts:79
Connect the transport

Returns Promise<void>

disconnect

disconnect(): Promise<void>

- Defined in transports/Transport.ts:89
Disconnect the transport

Returns Promise<void>

getPeers

getPeers(): Promise<T[]>

- Defined in transports/Transport.ts:144
Returns Promise<T[]>

Abstract listen

listen(publicKey: string): Promise<void>

- Defined in transports/Transport.ts:193
Parameters
- publicKey: string
Returns Promise<void>

Protected notifyListeners

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

- Defined in transports/Transport.ts:176
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>

- Defined in transports/Transport.ts:162
Returns Promise<void>

removeListener

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

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

- Defined in transports/Transport.ts:154
Parameters
- peerToBeRemoved: T
Returns Promise<void>

send

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

- 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>

Static isAvailable

isAvailable(): Promise<boolean>

- Defined in transports/Transport.ts:72
Returns a promise that resolves to true if the transport is available, false if it is not

Returns Promise<boolean>

Generated using TypeDoc