Class: Node

Defined in: packages/framework/src/lib/Node.ts:12

Extends

Service

Constructors

Constructor

new Node(options, listeners): Node;

Defined in: packages/framework/src/lib/Node.ts:38

Parameters

Parameter	Type
`options`	`INodeOptions`
`listeners`	`Listener`[]

Returns

Node

Overrides

Service.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
`executor_`	`protected`	`Executor`	`Service`.`executor_`	packages/framework/src/lib/Worker.ts:207
`intervalJobTimer_`	`protected`	`Timer`	`Service`.`intervalJobTimer_`	packages/framework/src/lib/Worker.ts:208
`lifeCycle_`	`protected`	`LifeCycle`<`WorkerState`>	`SingletonService`.`lifeCycle_`	packages/framework/src/lib/Worker.ts:206
`options_`	`protected`	`IServiceOptions`	`Service`.`options_`	packages/framework/src/lib/Service.ts:174
`scope_`	`protected`	`WorkerScope`	`Service`.`scope_`	packages/framework/src/lib/Worker.ts:211
`startTime_`	`protected`	`number`	`Service`.`startTime_`	packages/framework/src/lib/Worker.ts:209

Accessors

executor

Get Signature

get executor(): Executor<Scope<unknown>>;

Defined in: packages/framework/src/lib/Worker.ts:187

Returns

Executor<Scope<unknown>>

Inherited from

SingletonService.executor

id

Get Signature

get id(): string;

Defined in: packages/framework/src/lib/Worker.ts:183

Returns

string

Inherited from

SingletonService.id

isIdle

Get Signature

get isIdle(): boolean;

Defined in: packages/framework/src/lib/Worker.ts:171

Returns

boolean

Inherited from

SingletonService.isIdle

lifeCycle

Get Signature

get lifeCycle(): LifeCycle<WorkerState>;

Defined in: packages/framework/src/lib/Worker.ts:179

Returns

LifeCycle<WorkerState>

Inherited from

SingletonService.lifeCycle

listenerPool

Get Signature

get protected listenerPool(): Map<string, Listener>;

Defined in: packages/framework/src/lib/Service.ts:170

Returns

Map<string, Listener>

Inherited from

SingletonService.listenerPool

metaData

Get Signature

get metaData(): IServiceMetaData;

Defined in: packages/framework/src/lib/Service.ts:144

Returns

IServiceMetaData

Inherited from

Service.metaData

name

Get Signature

get name(): string;

Defined in: packages/framework/src/lib/Worker.ts:163

Returns

string

Inherited from

SingletonService.name

nodeRunData

Get Signature

get nodeRunData(): INodeRunData;

Defined in: packages/framework/src/lib/Node.ts:53

Returns

INodeRunData

nodeStateData

Get Signature

get nodeStateData(): INodeMetaData;

Defined in: packages/framework/src/lib/Node.ts:63

Returns

INodeMetaData

runData

Get Signature

get runData(): IServiceRunData;

Defined in: packages/framework/src/lib/Service.ts:156

Returns

IServiceRunData

Inherited from

Service.runData

scope

Get Signature

get scope(): WorkerScope;

Defined in: packages/framework/src/lib/Worker.ts:191

Returns

WorkerScope

Inherited from

SingletonService.scope

state

Get Signature

get state(): WorkerState;

Defined in: packages/framework/src/lib/Worker.ts:167

Returns

WorkerState

Inherited from

SingletonService.state

stateSubject

Get Signature

get stateSubject(): BehaviorSubject<WorkerState>;

Defined in: packages/framework/src/lib/Worker.ts:175

Returns

BehaviorSubject<WorkerState>

Inherited from

SingletonService.stateSubject

Methods

connectComponent()

connectComponent(component): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:126

Parameters

Parameter	Type
`component`	`Component`

Returns

Promise<void>

Inherited from

Service.connectComponent

connectComponents()

connectComponents(components): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:120

Parameters

Parameter	Type
`components`	`Component`[]

Returns

Promise<void>

Inherited from

Service.connectComponents

disconnectComponent()

disconnectComponent(name): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:136

Parameters

Parameter	Type
`name`	`string`

Returns

Promise<void>

Inherited from

Service.disconnectComponent

doJob()

protected doJob<T>(executor): Promise<T | undefined>;

Defined in: packages/framework/src/lib/Worker.ts:68

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type
`executor`	`JobExecutor`<`T`>

Returns

Promise<T | undefined>

Inherited from

Service.doJob

doJobInterval()

protected doJobInterval(executor, timeMS): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:72

Parameters

Parameter	Type
`executor`	`JobExecutor`
`timeMS`	`number`

Returns

Promise<void>

Inherited from

Service.doJobInterval

getListenerMetaData()

protected getListenerMetaData(listener): {
  codecs: string[];
  endpoint: string;
  id: string;
  labels: {
   [key: string]: string;
  };
  protocol: string;
  state: ListenerState;
  targetId: string;
  targetName: string;
  version: string;
  weight: number;
};

Defined in: packages/framework/src/lib/Service.ts:126

Parameters

Parameter	Type
`listener`	`Listener`

Returns

{
  codecs: string[];
  endpoint: string;
  id: string;
  labels: {
   [key: string]: string;
  };
  protocol: string;
  state: ListenerState;
  targetId: string;
  targetName: string;
  version: string;
  weight: number;
}

Name	Type	Default value	Defined in
`codecs`	`string`[]	-	packages/framework/src/interface/rpc.ts:11
`endpoint`	`string`	-	packages/framework/src/interface/rpc.ts:10
`id`	`string`	`listener.id`	packages/framework/src/lib/Service.ts:134
`labels`	{ [`key`: `string`]: `string`; }	-	packages/framework/src/lib/Service.ts:140
`protocol`	`string`	-	packages/framework/src/interface/rpc.ts:9
`state`	`ListenerState`	`listener.state`	packages/framework/src/lib/Service.ts:135
`targetId`	`string`	-	packages/framework/src/lib/Service.ts:136
`targetName`	`string`	-	packages/framework/src/lib/Service.ts:137
`version`	`string`	`listener.version`	packages/framework/src/lib/Service.ts:139
`weight`	`number`	`listener.weight`	packages/framework/src/lib/Service.ts:138

Inherited from

Service.getListenerMetaData

hasComponent()

hasComponent(id): boolean;

Defined in: packages/framework/src/lib/Worker.ts:153

Parameters

Parameter	Type
`id`	`string`

Returns

boolean

Inherited from

Service.hasComponent

hasProvider()

hasProvider(id): boolean;

Defined in: packages/framework/src/lib/Worker.ts:149

Parameters

Parameter	Type
`id`	`string`

Returns

boolean

Inherited from

Service.hasProvider

installListener()

installListener(listener): Promise<void>;

Defined in: packages/framework/src/lib/Service.ts:58

Parameters

Parameter	Type
`listener`	`Listener`

Returns

Promise<void>

Inherited from

Service.installListener

onError()

protected onError(err): void;

Defined in: packages/framework/src/lib/Worker.ts:157

Parameters

Parameter	Type
`err`	`Error`

Returns

void

Inherited from

Service.onError

registerEndpoint()

registerEndpoint(listener): Promise<void>;

Defined in: packages/framework/src/lib/Service.ts:98

Parameters

Parameter	Type
`listener`	`Listener`

Returns

Promise<void>

Inherited from

Service.registerEndpoint

registerEndpoints()

registerEndpoints(): Promise<void>;

Defined in: packages/framework/src/lib/Service.ts:107

Returns

Promise<void>

Inherited from

Service.registerEndpoints

registerProvider()

registerProvider(provider): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:98

Parameters

Parameter	Type
`provider`	`Provider`

Returns

Promise<void>

Inherited from

Service.registerProvider

registerProviders()

registerProviders(providers): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:92

Parameters

Parameter	Type
`providers`	`Provider`<`Route`>[]

Returns

Promise<void>

Inherited from

Service.registerProviders

runCommand()

runCommand(...args): Promise<boolean>;

Defined in: packages/framework/src/lib/Worker.ts:64

Parameters

Parameter	Type
...`args`	`unknown`[]

Returns

Promise<boolean>

Inherited from

Service.runCommand

shutdown()

shutdown(): Promise<void>;

Defined in: packages/framework/src/lib/Node.ts:51

Returns

Promise<void>

Overrides

Service.shutdown

start()

start(): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:34

Returns

Promise<void>

Inherited from

Service.start

startup()

startup(): Promise<void>;

Defined in: packages/framework/src/lib/Node.ts:45

Returns

Promise<void>

Overrides

Service.startup

stop()

stop(reason): Promise<void>;

Defined in: packages/framework/src/lib/Service.ts:42

Parameters

Parameter	Type
`reason`	`string`

Returns

Promise<void>

Inherited from

Service.stop

uninstallListener()

uninstallListener(id): Promise<void>;

Defined in: packages/framework/src/lib/Service.ts:113

Parameters

Parameter	Type
`id`	`string`

Returns

Promise<void>

Inherited from

Service.uninstallListener

unregisterProvider()

unregisterProvider(name): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:108

Parameters

Parameter	Type
`name`	`string`

Returns

Promise<void>

Inherited from

Service.unregisterProvider

registerService()

static registerService<T>(name, builder): void;

Defined in: packages/framework/src/lib/Node.ts:24

Type Parameters

Type Parameter
`T` extends `IServiceOptions`

Parameters

Parameter	Type
`name`	`string`
`builder`	`ServiceBuilder`<`T`>

Returns

void

registerWorker()

static registerWorker<T>(name, builder): void;

Defined in: packages/framework/src/lib/Node.ts:13

Type Parameters

Type Parameter
`T` extends `IWorkerOptions`

Parameters

Parameter	Type
`name`	`string`
`builder`	`WorkerBuilder`<`T`>

Returns

void

serviceFactory()

static serviceFactory(name, options): Service | null;

Defined in: packages/framework/src/lib/Node.ts:28

Parameters

Parameter	Type
`name`	`string`
`options`	`IServiceOptions`

Returns

Service | null

workerFactory()

static workerFactory(name, options): Worker | null;

Defined in: packages/framework/src/lib/Node.ts:17

Parameters

Parameter	Type
`name`	`string`
`options`	`IWorkerOptions`

Returns

Worker | null

Class: Node ​

Extends ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Overrides ​

Properties ​

Accessors ​

executor ​

Get Signature ​

Returns ​

Inherited from ​

id ​

Get Signature ​

Returns ​

Inherited from ​

isIdle ​

Get Signature ​

Returns ​

Inherited from ​

lifeCycle ​

Get Signature ​

Returns ​

Inherited from ​

listenerPool ​

Get Signature ​

Returns ​

Inherited from ​

metaData ​

Get Signature ​

Returns ​

Inherited from ​

name ​

Get Signature ​

Returns ​

Inherited from ​

nodeRunData ​

Get Signature ​

Returns ​

nodeStateData ​

Get Signature ​

Returns ​

runData ​

Get Signature ​

Returns ​

Inherited from ​

scope ​

Get Signature ​

Returns ​

Inherited from ​

state ​

Get Signature ​

Returns ​

Inherited from ​

stateSubject ​

Get Signature ​

Returns ​

Inherited from ​

Methods ​

connectComponent() ​

Parameters ​

Returns ​

Inherited from ​

connectComponents() ​

Parameters ​

Returns ​

Inherited from ​

disconnectComponent() ​

Parameters ​

Returns ​

Inherited from ​

doJob() ​

Type Parameters ​

Parameters ​

Returns ​

Inherited from ​

doJobInterval() ​

Parameters ​

Returns ​

Class: Node

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

Accessors

executor

Get Signature

Returns

Inherited from

id

Get Signature

Returns

Inherited from

isIdle

Get Signature

Returns

Inherited from

lifeCycle

Get Signature

Returns

Inherited from

listenerPool

Get Signature

Returns

Inherited from

metaData

Get Signature

Returns

Inherited from

name

Get Signature

Returns

Inherited from

nodeRunData

Get Signature

Returns

nodeStateData

Get Signature

Returns

runData

Get Signature

Returns

Inherited from

scope

Get Signature

Returns

Inherited from

state

Get Signature

Returns

Inherited from

stateSubject

Get Signature

Returns

Inherited from

Methods

connectComponent()

Parameters

Returns

Inherited from

connectComponents()

Parameters

Returns

Inherited from

disconnectComponent()

Parameters

Returns

Inherited from

doJob()

Type Parameters

Parameters

Returns

Inherited from

doJobInterval()

Parameters

Returns