@sora-soft/framework

---

@sora-soft/framework / Listener

Abstract Class: Listener

Defined in: packages/framework/src/lib/rpc/Listener.ts:32

Extended by

• TCPListener

Constructors

Constructor

new Listener(
   callback, 
   codecs, 
   labels?): Listener;

Defined in: packages/framework/src/lib/rpc/Listener.ts:33

Parameters

Parameter	Type
callback	ListenerCallback
codecs	Codec<any>[]
labels	ILabels

Returns

Listener

Properties

Property	Modifier	Type	Defined in
callback_	protected	ListenerCallback	packages/framework/src/lib/rpc/Listener.ts:186
codecs_	protected	Codec<any>[]	packages/framework/src/lib/rpc/Listener.ts:182
connectionSubject_	protected	Subject<IListenerConnectionEvent>	packages/framework/src/lib/rpc/Listener.ts:181
connectors_	protected	Map<string, Connector>	packages/framework/src/lib/rpc/Listener.ts:185
lifeCycle_	protected	LifeCycle<ListenerState>	packages/framework/src/lib/rpc/Listener.ts:183
weightSubject_	protected	BehaviorSubject<number>	packages/framework/src/lib/rpc/Listener.ts:184

Accessors

connectionSubject

Get Signature

get connectionSubject(): Subject<IListenerConnectionEvent>;

Defined in: packages/framework/src/lib/rpc/Listener.ts:165

Returns

Subject<IListenerConnectionEvent>

---

connectors

Get Signature

get connectors(): Map<string, Connector>;

Defined in: packages/framework/src/lib/rpc/Listener.ts:169

Returns

Map<string, Connector>

---

id

Get Signature

get id(): string;

Defined in: packages/framework/src/lib/rpc/Listener.ts:150

Returns

string

---

info

Get Signature

get info(): IListenerInfo | undefined;

Defined in: packages/framework/src/lib/rpc/Listener.ts:130

Returns

IListenerInfo | undefined

---

labels

Get Signature

get labels(): ILabels;

Defined in: packages/framework/src/lib/rpc/Listener.ts:154

Returns

ILabels

---

metaData

Get Signature

get abstract metaData(): IListenerInfo;

Defined in: packages/framework/src/lib/rpc/Listener.ts:179

Returns

IListenerInfo

---

scope

Get Signature

get scope(): Scope<unknown> | undefined;

Defined in: packages/framework/src/lib/rpc/Listener.ts:173

Returns

Scope<unknown> | undefined

---

state

Get Signature

get state(): ListenerState;

Defined in: packages/framework/src/lib/rpc/Listener.ts:142

Returns

ListenerState

---

stateSubject

Get Signature

get stateSubject(): BehaviorSubject<ListenerState>;

Defined in: packages/framework/src/lib/rpc/Listener.ts:134

Returns

BehaviorSubject<ListenerState>

---

version

Get Signature

get abstract version(): string;

Defined in: packages/framework/src/lib/rpc/Listener.ts:177

Returns

string

---

weight

Get Signature

get weight(): number;

Defined in: packages/framework/src/lib/rpc/Listener.ts:146

Returns

number

---

weightSubject

Get Signature

get weightSubject(): BehaviorSubject<number>;

Defined in: packages/framework/src/lib/rpc/Listener.ts:138

Returns

BehaviorSubject<number>

Methods

closeAllConnector()

protected closeAllConnector(): void;

Defined in: packages/framework/src/lib/rpc/Listener.ts:108

Returns

void

---

getConnector()

getConnector(session): Connector | undefined;

Defined in: packages/framework/src/lib/rpc/Listener.ts:114

Parameters

Parameter	Type
session	string

Returns

Connector | undefined

---

listen()

abstract protected listen(): Promise<IListenerInfo>;

Defined in: packages/framework/src/lib/rpc/Listener.ts:43

Returns

Promise<IListenerInfo>

---

newConnector()

protected newConnector(session, connector): void;

Defined in: packages/framework/src/lib/rpc/Listener.ts:66

Parameters

Parameter	Type
session	string
connector	Connector

Returns

void

---

setWeight()

setWeight(weight): void;

Defined in: packages/framework/src/lib/rpc/Listener.ts:118

Parameters

Parameter	Type
weight	number

Returns

void

---

shutdown()

abstract protected shutdown(): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Listener.ts:55

Returns

Promise<void>

---

startListen()

startListen(): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Listener.ts:45

Returns

Promise<void>

---

stopListen()

stopListen(): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Listener.ts:57

Returns

Promise<void>