Class P2PCommunicationClient

Internalapi

Hierarchy

CommunicationClient
- P2PCommunicationClient

Constructors

constructor

new P2PCommunicationClient(name, keyPair, replicationCount, storage, matrixNodes?, iconUrl?, appUrl?): P2PCommunicationClient
Parameters
- name: string
- keyPair: KeyPair
- replicationCount: number
- storage: Storage
- Optional matrixNodes: NodeDistributions
- Optional iconUrl: string
- Optional appUrl: string
Returns P2PCommunicationClient
Overrides CommunicationClient.constructor
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:95

Properties

`Private` `Readonly` ENABLED_RELAY_SERVERS

ENABLED_RELAY_SERVERS: NodeDistributions

`Private` `Readonly` activeListeners

activeListeners: Map<string, ((event) => void)> = ...

Type declaration

- (event): void
- Parameters
  - event: MatrixClientEvent<any>
  Returns void

`Private` `Optional` `Readonly` appUrl

appUrl?: string

`Private` client

client: ExposedPromise<MatrixClient, unknown> = ...

eventHandlers

eventHandlers: Map<ClientEvents, Function>

`Private` `Optional` `Readonly` iconUrl

iconUrl?: string

`Private` `Readonly` ignoredRooms

ignoredRooms: string[] = []

`Private` initialEvent

initialEvent: undefined | MatrixClientEvent<MESSAGE>

`Private` initialListener

initialListener: undefined | ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: MatrixClientEvent<MESSAGE>
  Returns void

`Protected` isMobileOS

isMobileOS: (() => boolean)

Type declaration

- (): boolean
- Returns boolean

`Protected` `Optional` `Readonly` keyPair

keyPair?: KeyPair

`Private` loginCounter

loginCounter: number = 0

`Private` `Readonly` name

name: string

relayServer

relayServer: undefined | ExposedPromise<{
    localTimestamp: number;
    server: string;
    timestamp: number;
}, unknown>

`Readonly` replicationCount

replicationCount: number

`Private` `Optional` selectedRegion

selectedRegion?: Regions

`Private` `Readonly` storage

storage: Storage

Methods

`Protected` createCryptoBoxClient

createCryptoBoxClient(otherPublicKey, selfKeypair): Promise<SessionKeys>
Create a cryptobox client
Parameters
- otherPublicKey: string
- selfKeypair: KeyPair
Returns Promise<SessionKeys>
Inherited from CommunicationClient.createCryptoBoxClient
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:36

`Protected` createCryptoBoxServer

createCryptoBoxServer(otherPublicKey, selfKeypair): Promise<SessionKeys>
Create a cryptobox server
Parameters
- otherPublicKey: string
- selfKeypair: KeyPair
Returns Promise<SessionKeys>
Inherited from CommunicationClient.createCryptoBoxServer
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:29

deleteRoomIdFromRooms

deleteRoomIdFromRooms(roomId): Promise<void>
Parameters
- roomId: string
Returns Promise<void>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:601

`Protected` encryptMessageAsymmetric

encryptMessageAsymmetric(recipientPublicKey, message): Promise<string>
Encrypt a message for a specific publicKey (receiver, asymmetric)
Parameters
- recipientPublicKey: string
- message: string
Returns Promise<string>
Inherited from CommunicationClient.encryptMessageAsymmetric
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:43

findBestRegionAndGetServer

findBestRegionAndGetServer(): Promise<undefined | {
server: string;
timestamp: number;
}>
To get the fastest region, we can't simply do one request, because sometimes, DNS and SSL handshakes make "faster" connections slower. So we need to do 2 requests and check which request was the fastest after 1s.

Returns Promise<undefined | {
server: string;
timestamp: number;
}>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:161

getBeaconInfo

getBeaconInfo(server): Promise<BeaconInfoResponse>
Parameters
- server: string
Returns Promise<BeaconInfoResponse>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:298

getPairingRequestInfo

getPairingRequestInfo(): Promise<P2PPairingRequest>
Returns Promise<P2PPairingRequest>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:118

getPairingResponseInfo

getPairingResponseInfo(request): Promise<P2PPairingResponse>
Parameters
- request: P2PPairingRequest
Returns Promise<P2PPairingResponse>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:137

getPublicKey

getPublicKey(): Promise<string>
Get the public key

Returns Promise<string>
Inherited from CommunicationClient.getPublicKey
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:18

getPublicKeyHash

getPublicKeyHash(): Promise<string>
get the public key hash

Returns Promise<string>
Inherited from CommunicationClient.getPublicKeyHash
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:22

getRelayServer

getRelayServer(): Promise<{
server: string;
timestamp: number;
}>
Returns Promise<{
server: string;
timestamp: number;
}>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:248

`Private` getRelevantJoinedRoom

getRelevantJoinedRoom(recipient): Promise<MatrixRoom>
Parameters
- recipient: string
Returns Promise<MatrixRoom>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:799

`Private` getRelevantRoom

getRelevantRoom(recipient): Promise<string>
Parameters
- recipient: string
Returns Promise<string>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:782

isChannelOpenMessage

isChannelOpenMessage(content): Promise<boolean>
Parameters
- content: MatrixClientEventMessageContent<string>
Returns Promise<boolean>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:765

isSender

isSender(event, senderPublicKey): Promise<boolean>
Parameters
- event: MatrixClientEvent<MESSAGE>
- senderPublicKey: string
Returns Promise<boolean>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:773

isTextMessage

isTextMessage(content): content is MatrixClientEventMessageContent<string>
Parameters
- content: MatrixClientEventMessageContent<any>
Returns content is MatrixClientEventMessageContent<string>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:733

listenForChannelOpening

listenForChannelOpening(messageCallback): Promise<void>
Parameters
- messageCallback: ((pairingResponse) => void)
  - - (pairingResponse): void
    - Parameters
      
      pairingResponse: ExtendedP2PPairingResponse
      
      Returns void
Returns Promise<void>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:619

listenForEncryptedMessage

listenForEncryptedMessage(senderPublicKey, messageCallback): Promise<void>
Parameters
- senderPublicKey: string
- messageCallback: ((message) => void)
  - - (message): void
    - Parameters
      
      message: string
      
      Returns void
Returns Promise<void>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:436

reset

reset(): Promise<void>
Returns Promise<void>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:423

sendMessage

sendMessage(message, peer): Promise<void>
Parameters
- message: string
- peer: ExtendedP2PPairingResponse | P2PPairingRequest
Returns Promise<void>
Overrides CommunicationClient.sendMessage
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:532

sendPairingResponse

sendPairingResponse(pairingRequest): Promise<void>
Parameters
- pairingRequest: P2PPairingRequest
Returns Promise<void>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:687

start

start(): Promise<void>
Returns Promise<void>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:324

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:414

tryJoinRooms

tryJoinRooms(roomId, retry?): Promise<void>
Parameters
- roomId: string
- retry: number = 1
Returns Promise<void>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:308

unsubscribeFromEncryptedMessage

unsubscribeFromEncryptedMessage(senderPublicKey): Promise<void>
Parameters
- senderPublicKey: string
Returns Promise<void>
Overrides CommunicationClient.unsubscribeFromEncryptedMessage
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:515

unsubscribeFromEncryptedMessages

unsubscribeFromEncryptedMessages(): Promise<void>
Returns Promise<void>
Overrides CommunicationClient.unsubscribeFromEncryptedMessages
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:526

updatePeerRoom

updatePeerRoom(sender, roomId): Promise<void>
Parameters
- sender: string
- roomId: string
Returns Promise<void>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:567

updateRelayServer

updateRelayServer(sender): Promise<void>
Parameters
- sender: string
Returns Promise<void>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:739

waitForJoin

waitForJoin(roomId, retry?): Promise<void>
Parameters
- roomId: string
- retry: number = 0
Returns Promise<void>
- Defined in beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts:661

Class P2PCommunicationClient

Internalapi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

keyPair: KeyPair

replicationCount: number

storage: Storage

Optional matrixNodes: NodeDistributions

Optional iconUrl: string

Optional appUrl: string

Returns P2PCommunicationClient

Properties

Private Readonly ENABLED_RELAY_SERVERS

Private Readonly activeListeners

Type declaration

Parameters

event: MatrixClientEvent<any>

Returns void

Private Optional Readonly appUrl

Private client

eventHandlers

Private Optional Readonly iconUrl

Private Readonly ignoredRooms

Private initialEvent

Private initialListener

Type declaration

Parameters

event: MatrixClientEvent<MESSAGE>

Returns void

Protected isMobileOS

Type declaration

Returns boolean

Protected Optional Readonly keyPair

Private loginCounter

Private Readonly name

relayServer

Readonly replicationCount

Private Optional selectedRegion

Private Readonly storage

Methods

Protected createCryptoBoxClient

Parameters

otherPublicKey: string

selfKeypair: KeyPair

Returns Promise<SessionKeys>

Protected createCryptoBoxServer

Parameters

otherPublicKey: string

selfKeypair: KeyPair

Returns Promise<SessionKeys>

deleteRoomIdFromRooms

Parameters

roomId: string

Returns Promise<void>

Protected encryptMessageAsymmetric

Parameters

recipientPublicKey: string

message: string

Returns Promise<string>

findBestRegionAndGetServer

Returns Promise<undefined | { server: string; timestamp: number; }>

getBeaconInfo

Parameters

server: string

Returns Promise<BeaconInfoResponse>

getPairingRequestInfo

Returns Promise<P2PPairingRequest>

getPairingResponseInfo

Parameters

request: P2PPairingRequest

Returns Promise<P2PPairingResponse>

getPublicKey

Returns Promise<string>

`Optional` matrixNodes: NodeDistributions

`Optional` iconUrl: string

`Optional` appUrl: string

`Private` `Readonly` ENABLED_RELAY_SERVERS

`Private` `Readonly` activeListeners

`Private` `Optional` `Readonly` appUrl

`Private` client

`Private` `Optional` `Readonly` iconUrl

`Private` `Readonly` ignoredRooms

`Private` initialEvent

`Private` initialListener

`Protected` isMobileOS

`Protected` `Optional` `Readonly` keyPair

`Private` loginCounter

`Private` `Readonly` name

`Readonly` replicationCount

`Private` `Optional` selectedRegion

`Private` `Readonly` storage

`Protected` createCryptoBoxClient

`Protected` createCryptoBoxServer

`Protected` encryptMessageAsymmetric

Returns Promise<undefined | {
server: string;
timestamp: number;
}>

Returns Promise<{
server: string;
timestamp: number;
}>

`Private` getRelevantJoinedRoom

`Private` getRelevantRoom