Class P2PCommunicationClient

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

relayServer

Readonly replicationCount

deleteRoomIdFromRooms

• deleteRoomIdFromRooms(roomId): Promise<void>

• Parameters

  • roomId: string

  Returns Promise<void>

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

getBeaconInfo

• getBeaconInfo(server): Promise<BeaconInfoResponse>

• Parameters

  • server: string

  Returns Promise<BeaconInfoResponse>

getPairingRequestInfo

• getPairingRequestInfo(): Promise<P2PPairingRequest>

• Returns Promise<P2PPairingRequest>

getPairingResponseInfo

• getPairingResponseInfo(request): Promise<P2PPairingResponse>

• Parameters

  • request: P2PPairingRequest

  Returns Promise<P2PPairingResponse>

getRelayServer

• getRelayServer(): Promise<{
      server: string;
      timestamp: number;
  }>

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

isChannelOpenMessage

• isChannelOpenMessage(content): Promise<boolean>

• Parameters

  • content: MatrixClientEventMessageContent<string>

  Returns Promise<boolean>

isSender

• isSender(event, senderPublicKey): Promise<boolean>

• Parameters

  • event: MatrixClientEvent<MESSAGE>

  • senderPublicKey: string

  Returns Promise<boolean>

isTextMessage

• isTextMessage(content): content is MatrixClientEventMessageContent<string>

• Parameters

  • content: MatrixClientEventMessageContent<any>

  Returns content is MatrixClientEventMessageContent<string>

listenForChannelOpening

• listenForChannelOpening(messageCallback): Promise<void>

• Parameters

  • messageCallback: ((pairingResponse) => void)

    • • (pairingResponse): void

      • Parameters

        • pairingResponse: ExtendedP2PPairingResponse

        Returns void

  Returns Promise<void>

listenForEncryptedMessage

• listenForEncryptedMessage(senderPublicKey, messageCallback): Promise<void>

• Parameters

  • senderPublicKey: string

  • messageCallback: ((message) => void)

    • • (message): void

      • Parameters

        • message: string

        Returns void

  Returns Promise<void>

reset

• reset(): Promise<void>

• Returns Promise<void>

sendMessage

• sendMessage(message, peer): Promise<void>

• Parameters

  • message: string

  • peer: ExtendedP2PPairingResponse | P2PPairingRequest

  Returns Promise<void>

sendPairingResponse

• sendPairingResponse(pairingRequest): Promise<void>

• Parameters

  • pairingRequest: P2PPairingRequest

  Returns Promise<void>

start

• start(): Promise<void>

• Returns Promise<void>

stop

• stop(): Promise<void>

• Returns Promise<void>

tryJoinRooms

• tryJoinRooms(roomId, retry?): Promise<void>

• Parameters

  • roomId: string

  • Optional retry: number

  Returns Promise<void>

unsubscribeFromEncryptedMessage

• unsubscribeFromEncryptedMessage(senderPublicKey): Promise<void>

• Parameters

  • senderPublicKey: string

  Returns Promise<void>

unsubscribeFromEncryptedMessages

• unsubscribeFromEncryptedMessages(): Promise<void>

• Returns Promise<void>

updatePeerRoom

• updatePeerRoom(sender, roomId): Promise<void>

• Parameters

  • sender: string

  • roomId: string

  Returns Promise<void>

updateRelayServer

• updateRelayServer(sender): Promise<void>

• Parameters

  • sender: string

  Returns Promise<void>

waitForJoin

• waitForJoin(roomId, retry?): Promise<void>

• Parameters

  • roomId: string

  • Optional retry: number

  Returns Promise<void>