Class RpcKernelConnection

Hierarchy

RpcKernelBaseConnection
- RpcKernelConnection

Constructors

constructor

new RpcKernelConnection(writer: RpcConnectionWriter, connections: RpcKernelConnections, controllers: Map<string, {
controller: ClassType<any>;
module?: InjectorModule<any, InjectorModule<any, any>>;
}>, security?: RpcKernelSecurity, injector: InjectorContext, peerExchange: RpcPeerExchange, logger?: LoggerInterface): RpcKernelConnection
Parameters
- writer: RpcConnectionWriter
- connections: RpcKernelConnections
- controllers: Map<string, {
  controller: ClassType<any>;
  module?: InjectorModule<any, InjectorModule<any, any>>;
  }>
- security: RpcKernelSecurity = ...
- injector: InjectorContext
- peerExchange: RpcPeerExchange
- logger: LoggerInterface = ...
Returns RpcKernelConnection
Overrides RpcKernelBaseConnection.constructor
- Defined in packages/rpc/src/server/kernel.ts:311

Properties

`Protected` actionClient

actionClient: RpcActionClient = ...

`Protected` actionHandler

actionHandler: RpcServerAction = ...

`Protected` connections

connections: RpcKernelConnections

`Protected` controllers

controllers: Map<string, {
controller: ClassType<any>;
module?: InjectorModule<any, InjectorModule<any, any>>;
}>

`Protected` id

id: Uint8Array = ...

`Protected` injector

injector: InjectorContext

`Protected` logger

logger: LoggerInterface = ...

`Protected` messageId

messageId: number = 0

`Optional` myPeerId

myPeerId?: string

`Readonly` onClose

onClose: Promise<void>

`Protected` `Optional` onCloseResolve

onCloseResolve?: Function

`Protected` peerExchange

peerExchange: RpcPeerExchange

`Protected` reader

reader: RpcMessageReader = ...

`Protected` replies

replies: Map<number, ((message: RpcMessage) => void)> = ...

routeType

routeType: client | server = RpcMessageRouteType.client

`Protected` security

security: RpcKernelSecurity = ...

sessionState

sessionState: SessionState = ...

`Protected` timeoutTimers

timeoutTimers: any[] = []

Methods

`Protected` authenticate

authenticate(message: RpcMessage, response: RpcMessageBuilder): Promise<void>
Parameters
- message: RpcMessage
- response: RpcMessageBuilder
Returns Promise<void>
- Defined in packages/rpc/src/server/kernel.ts:386

clientAddress

clientAddress(): undefined | string
Returns undefined | string
Inherited from RpcKernelBaseConnection.clientAddress
- Defined in packages/rpc/src/server/kernel.ts:210

close

close(): void
Returns void
Inherited from RpcKernelBaseConnection.close
- Defined in packages/rpc/src/server/kernel.ts:230

controller

controller<T>(nameOrDefinition: string | ControllerDefinition<T>, timeoutInSeconds?: number): RemoteController<T>
Type Parameters
- T
Parameters
- nameOrDefinition: string | ControllerDefinition<T>
- timeoutInSeconds: number = 60
Returns RemoteController<T>
Inherited from RpcKernelBaseConnection.controller
- Defined in packages/rpc/src/server/kernel.ts:257

createMessageBuilder

createMessageBuilder(): RpcMessageBuilder
Returns RpcMessageBuilder
Inherited from RpcKernelBaseConnection.createMessageBuilder
- Defined in packages/rpc/src/server/kernel.ts:214

`Protected` deregisterAsPeer

deregisterAsPeer(message: RpcMessage, response: RpcMessageBuilder): Promise<void>
Parameters
- message: RpcMessage
- response: RpcMessageBuilder
Returns Promise<void>
- Defined in packages/rpc/src/server/kernel.ts:399

feed

feed(buffer: Uint8Array, bytes?: number): void
Parameters
- buffer: Uint8Array
- Optional bytes: number
Returns void
Inherited from RpcKernelBaseConnection.feed
- Defined in packages/rpc/src/server/kernel.ts:237

handleMessage

handleMessage(message: RpcMessage): void
Parameters
- message: RpcMessage
Returns void
Inherited from RpcKernelBaseConnection.handleMessage
- Defined in packages/rpc/src/server/kernel.ts:241

onMessage

onMessage(message: RpcMessage): Promise<void>
Parameters
- message: RpcMessage
Returns Promise<void>
Overrides RpcKernelBaseConnection.onMessage
- Defined in packages/rpc/src/server/kernel.ts:333

`Protected` registerAsPeer

registerAsPeer(message: RpcMessage, response: RpcMessageBuilder): Promise<void>
Parameters
- message: RpcMessage
- response: RpcMessageBuilder
Returns Promise<void>
- Defined in packages/rpc/src/server/kernel.ts:415

sendMessage

sendMessage<T>(type: number, body?: T, receiveType?: ReceiveType<T>): RpcMessageSubject
Type Parameters
- T
Parameters
- type: number
- Optional body: T
- Optional receiveType: ReceiveType<T>
Returns RpcMessageSubject
Inherited from RpcKernelBaseConnection.sendMessage
- Defined in packages/rpc/src/server/kernel.ts:269

setTimeout

setTimeout(cb: (() => void), timeout: number): any
Creates a regular timer using setTimeout() and automatically cancel it once the connection breaks or server stops.
Parameters
- cb: (() => void)
  - - (): void
    - Returns void
- timeout: number
Returns any
Inherited from RpcKernelBaseConnection.setTimeout
- Defined in packages/rpc/src/server/kernel.ts:221

Class RpcKernelConnection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

writer: RpcConnectionWriter

connections: RpcKernelConnections

controllers: Map<string, { controller: ClassType<any>; module?: InjectorModule<any, InjectorModule<any, any>>; }>

security: RpcKernelSecurity = ...

injector: InjectorContext

peerExchange: RpcPeerExchange

logger: LoggerInterface = ...

Returns RpcKernelConnection

Properties

Protected actionClient

Protected actionHandler

Protected connections

Protected controllers

Protected id

Protected injector

Protected logger

Protected messageId

Optional myPeerId

Readonly onClose

Protected Optional onCloseResolve

Protected peerExchange

Protected reader

Protected replies

routeType

Protected security

sessionState

Protected timeoutTimers

Protected transportWriter

writer

writerOptions

Methods

Protected authenticate

Parameters

message: RpcMessage

response: RpcMessageBuilder

Returns Promise<void>

clientAddress

Returns undefined | string

close

Returns void

controller

Type Parameters

T

Parameters

nameOrDefinition: string | ControllerDefinition<T>

timeoutInSeconds: number = 60

Returns RemoteController<T>

createMessageBuilder

Returns RpcMessageBuilder

Protected deregisterAsPeer

Parameters

message: RpcMessage

response: RpcMessageBuilder

Returns Promise<void>

feed

Parameters

buffer: Uint8Array

Optional bytes: number

Returns void

handleMessage

Parameters

message: RpcMessage

Returns void

onMessage

Parameters

message: RpcMessage

Returns Promise<void>

Protected registerAsPeer

Parameters

message: RpcMessage

response: RpcMessageBuilder

controllers: Map<string, {
controller: ClassType<any>;
module?: InjectorModule<any, InjectorModule<any, any>>;
}>

`Protected` actionClient

`Protected` actionHandler

`Protected` connections

`Protected` controllers

`Protected` id

`Protected` injector

`Protected` logger

`Protected` messageId

`Optional` myPeerId

`Readonly` onClose

`Protected` `Optional` onCloseResolve

`Protected` peerExchange

`Protected` reader

`Protected` replies

`Protected` security

`Protected` timeoutTimers

`Protected` transportWriter

`Protected` authenticate

`Protected` deregisterAsPeer

`Optional` bytes: number

`Protected` registerAsPeer

`Optional` body: T

`Optional` receiveType: ReceiveType<T>