Class RpcClientTransporter

Hierarchy

RpcClientTransporter

Constructors

constructor

new RpcClientTransporter(transport: ClientTransportAdapter): RpcClientTransporter
Parameters
- transport: ClientTransportAdapter
Returns RpcClientTransporter
- Defined in packages/rpc/src/client/client.ts:125

Properties

`Protected` connected

connected: boolean = false

`Readonly` connection

connection: BehaviorSubject<boolean> = ...

true when the connection fully established (after authentication)

connectionId

connectionId: number = 0

`Protected` `Optional` connectionPromise

connectionPromise?: Promise<void>

`Protected` connectionTries

connectionTries: number = 0

`Readonly` disconnected

disconnected: Subject<number> = ...

`Optional` id

id?: Uint8Array

reader

reader: RpcMessageReader = ...

`Readonly` reconnected

reconnected: Subject<number> = ...

transport

transport: ClientTransportAdapter

`Protected` `Optional` transportConnection

transportConnection?: TransportConnection

`Protected` `Optional` writer

writer?: RpcMessageWriter

writerOptions

writerOptions: RpcMessageWriterOptions = ...

Methods

bufferedAmount

bufferedAmount(): number
Returns number
- Defined in packages/rpc/src/client/client.ts:130

clientAddress

clientAddress(): string
Returns string
- Defined in packages/rpc/src/client/client.ts:135

connect

connect(): Promise<void>
Simply connect with login using the token, without auto re-connect.

Returns Promise<void>
- Defined in packages/rpc/src/client/client.ts:257

disconnect

disconnect(): void
Returns void
- Defined in packages/rpc/src/client/client.ts:185

`Protected` doConnect

doConnect(): Promise<void>
Returns Promise<void>
- Defined in packages/rpc/src/client/client.ts:193

isConnected

isConnected(): boolean
True when fully connected (after successful handshake and authentication)

Returns boolean
- Defined in packages/rpc/src/client/client.ts:143

onAuthenticate

onAuthenticate(): Promise<void>
Returns Promise<void>
- Defined in packages/rpc/src/client/client.ts:179

`Protected` onConnect

onConnect(): void
Returns void
- Defined in packages/rpc/src/client/client.ts:164

`Protected` onDisconnect

onDisconnect(): void
Returns void
- Defined in packages/rpc/src/client/client.ts:151

`Protected` onError

onError(): void
Returns void
- Defined in packages/rpc/src/client/client.ts:147

onHandshake

onHandshake(): Promise<undefined | Uint8Array>
Optional handshake. When peer messages are allowed, this needs to request the client id and returns id.

Returns Promise<undefined | Uint8Array>
- Defined in packages/rpc/src/client/client.ts:175

onMessage

onMessage(message: RpcMessage): void
Parameters
- message: RpcMessage
Returns void
- Defined in packages/rpc/src/client/client.ts:182

send

send(message: Uint8Array, progress?: SingleProgress): void
Parameters
- message: Uint8Array
- Optional progress: SingleProgress
Returns void
- Defined in packages/rpc/src/client/client.ts:276

Generated using TypeDoc