Class ManagedPeerJS

ManagedPeer implementation, which uses PeerJS peer.

Hierarchy

ManagedPeerJS

Implements

ManagedPeer

Index

Constructors

Properties

innerConfigBus innerEventBus innerPeer innerPeerBusSubscriptionCanceler innerStateBus

Accessors

eventBus stateBus

Methods

close connect innerHandleEvent setConfig setPeerJsConfig updateConfig

Constructors

constructor

new ManagedPeerJS(): ManagedPeerJS
Returns ManagedPeerJS
- Defined in src/peerAl/peer/impl.ts:25

Properties

`Private` `Readonly` innerConfigBus

innerConfigBus: DefaultStickyEventBus<ManagedPeerConfig> = ...

`Private` `Readonly` innerEventBus

innerEventBus: DefaultEventBus<ManagedPeerEvent> = ...

`Private` innerPeer

innerPeer: null | Peer = null

`Private` innerPeerBusSubscriptionCanceler

innerPeerBusSubscriptionCanceler: null | SubscriptionCanceler = null

`Private` `Readonly` innerStateBus

innerStateBus: DefaultStickyEventBus<ManagedPeerState> = ...

Accessors

eventBus

get eventBus(): Subscribable<ManagedPeerEvent>
Returns Subscribable<ManagedPeerEvent>
Implementation of ManagedPeer.eventBus
- Defined in src/peerAl/peer/impl.ts:34

stateBus

get stateBus(): StickySubscribable<ManagedPeerState>
Returns StickySubscribable<ManagedPeerState>
Implementation of ManagedPeer.stateBus
- Defined in src/peerAl/peer/impl.ts:37

Methods

close

close(): void
Shortcut for setting null config. Releases all peer's resources.

Returns void
Implementation of ManagedPeer.close
- Defined in src/peerAl/peer/impl.ts:252

connect

connect(remoteId): Promise<ManagedPeerDataConnection>
Parameters
- remoteId: string
Returns Promise<ManagedPeerDataConnection>
Implementation of ManagedPeer.connect
- Defined in src/peerAl/peer/impl.ts:211

`Private` innerHandleEvent

innerHandleEvent(event): void
Parameters
- event: ManagedPeerEvent
Returns void
- Defined in src/peerAl/peer/impl.ts:41

setConfig

setConfig(config): void
Parameters
- config: ManagedPeerConfig
Returns void
Implementation of ManagedPeer.setConfig
- Defined in src/peerAl/peer/impl.ts:201

setPeerJsConfig

setPeerJsConfig(config, id?): void
Inner PeerJS config to use. If null, then internally peer is not created and IPeer is not active and can't be used.

Please note that each call to this function causes peer to restart.
Parameters
- config: null | PeerJSOption
- Optional id: string
Returns void
- Defined in src/peerAl/peer/impl.ts:94

updateConfig

updateConfig(callback): void
Parameters
- callback: ((oldConfig) => ManagedPeerConfig)
  - - (oldConfig): ManagedPeerConfig
    - Parameters
      
      oldConfig: Readonly<ManagedPeerConfig>
      
      Returns ManagedPeerConfig
Returns void
Implementation of ManagedPeer.updateConfig
- Defined in src/peerAl/peer/impl.ts:205

Generated using TypeDoc