@sora-soft/framework

---

@sora-soft/framework / Service

Abstract Class: Service

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

Extends

• Worker

Extended by

• Node
• SingletonService

Constructors

Constructor

new Service(name, options): Service;

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

Parameters

Parameter	Type
name	string
options	IServiceOptions

Returns

Service

Overrides

Worker.constructor

Properties

Property	Modifier	Type	Overrides	Inherited from	Defined in
executor_	protected	Executor	-	Worker.executor_	packages/framework/src/lib/Worker.ts:207
intervalJobTimer_	protected	Timer	-	Worker.intervalJobTimer_	packages/framework/src/lib/Worker.ts:208
lifeCycle_	protected	LifeCycle<WorkerState>	-	Worker.lifeCycle_	packages/framework/src/lib/Worker.ts:206
options_	protected	IServiceOptions	Worker.options_	-	packages/framework/src/lib/Service.ts:174
scope_	protected	WorkerScope	-	Worker.scope_	packages/framework/src/lib/Worker.ts:211
startTime_	protected	number	-	Worker.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

Worker.executor

---

id

Get Signature

get id(): string;

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

Returns

string

Inherited from

Worker.id

---

isIdle

Get Signature

get isIdle(): boolean;

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

Returns

boolean

Inherited from

Worker.isIdle

---

lifeCycle

Get Signature

get lifeCycle(): LifeCycle<WorkerState>;

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

Returns

LifeCycle<WorkerState>

Inherited from

Worker.lifeCycle

---

listenerPool

Get Signature

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

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

Returns

Map<string, Listener>

---

metaData

Get Signature

get metaData(): IServiceMetaData;

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

Returns

IServiceMetaData

Overrides

Worker.metaData

---

name

Get Signature

get name(): string;

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

Returns

string

Inherited from

Worker.name

---

runData

Get Signature

get runData(): IServiceRunData;

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

Returns

IServiceRunData

---

scope

Get Signature

get scope(): WorkerScope;

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

Returns

WorkerScope

Inherited from

Worker.scope

---

state

Get Signature

get state(): WorkerState;

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

Returns

WorkerState

Inherited from

Worker.state

---

stateSubject

Get Signature

get stateSubject(): BehaviorSubject<WorkerState>;

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

Returns

BehaviorSubject<WorkerState>

Inherited from

Worker.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

Worker.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

Worker.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

Worker.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

Worker.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

Worker.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

---

hasComponent()

hasComponent(id): boolean;

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

Parameters

Parameter	Type
id	string

Returns

boolean

Inherited from

Worker.hasComponent

---

hasProvider()

hasProvider(id): boolean;

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

Parameters

Parameter	Type
id	string

Returns

boolean

Inherited from

Worker.hasProvider

---

installListener()

installListener(listener): Promise<void>;

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

Parameters

Parameter	Type
listener	Listener

Returns

Promise<void>

---

onError()

protected onError(err): void;

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

Parameters

Parameter	Type
err	Error

Returns

void

Inherited from

Worker.onError

---

registerEndpoint()

registerEndpoint(listener): Promise<void>;

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

Parameters

Parameter	Type
listener	Listener

Returns

Promise<void>

---

registerEndpoints()

registerEndpoints(): Promise<void>;

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

Returns

Promise<void>

---

registerProvider()

registerProvider(provider): Promise<void>;

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

Parameters

Parameter	Type
provider	Provider

Returns

Promise<void>

Inherited from

Worker.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

Worker.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

Worker.runCommand

---

shutdown()

abstract protected shutdown(reason): Promise<void>;

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

Parameters

Parameter	Type
reason	string

Returns

Promise<void>

Inherited from

Worker.shutdown

---

start()

start(): Promise<void>;

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

Returns

Promise<void>

Inherited from

Worker.start

---

startup()

abstract protected startup(): Promise<void>;

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

Returns

Promise<void>

Inherited from

Worker.startup

---

stop()

stop(reason): Promise<void>;

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

Parameters

Parameter	Type
reason	string

Returns

Promise<void>

Overrides

Worker.stop

---

uninstallListener()

uninstallListener(id): Promise<void>;

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

Parameters

Parameter	Type
id	string

Returns

Promise<void>

---

unregisterProvider()

unregisterProvider(name): Promise<void>;

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

Parameters

Parameter	Type
name	string

Returns

Promise<void>

Inherited from

Worker.unregisterProvider