@sora-soft/framework

---

@sora-soft/framework / TCPListener

Class: TCPListener

Defined in: packages/framework/src/lib/tcp/TCPListener.ts:20

Extends

• Listener

Constructors

Constructor

new TCPListener(
   options, 
   callback, 
   codecs, 
   labels?): TCPListener;

Defined in: packages/framework/src/lib/tcp/TCPListener.ts:21

Parameters

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

Returns

TCPListener

Overrides

Listener.constructor

Properties

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

Inherited from

Listener.connectionSubject

---

connectors

Get Signature

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

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

Returns

Map<string, Connector>

Inherited from

Listener.connectors

---

exposeHost

Get Signature

get exposeHost(): string;

Defined in: packages/framework/src/lib/tcp/TCPListener.ts:102

Returns

string

---

id

Get Signature

get id(): string;

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

Returns

string

Inherited from

Listener.id

---

info

Get Signature

get info(): IListenerInfo | undefined;

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

Returns

IListenerInfo | undefined

Inherited from

Listener.info

---

labels

Get Signature

get labels(): ILabels;

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

Returns

ILabels

Inherited from

Listener.labels

---

metaData

Get Signature

get metaData(): {
  codecs: string[];
  endpoint: string;
  id: string;
  labels: ILabels;
  protocol: string;
  state: ListenerState;
};

Defined in: packages/framework/src/lib/tcp/TCPListener.ts:106

Returns

{
  codecs: string[];
  endpoint: string;
  id: string;
  labels: ILabels;
  protocol: string;
  state: ListenerState;
}

Name	Type	Default value	Defined in
codecs	string[]	-	packages/framework/src/lib/tcp/TCPListener.ts:113
endpoint	string	-	packages/framework/src/lib/tcp/TCPListener.ts:110
id	string	-	packages/framework/src/lib/tcp/TCPListener.ts:108
labels	ILabels	-	packages/framework/src/lib/tcp/TCPListener.ts:112
protocol	string	'tcp'	packages/framework/src/lib/tcp/TCPListener.ts:109
state	ListenerState	-	packages/framework/src/lib/tcp/TCPListener.ts:111

Overrides

Listener.metaData

---

scope

Get Signature

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

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

Returns

Scope<unknown> | undefined

Inherited from

Listener.scope

---

state

Get Signature

get state(): ListenerState;

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

Returns

ListenerState

Inherited from

Listener.state

---

stateSubject

Get Signature

get stateSubject(): BehaviorSubject<ListenerState>;

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

Returns

BehaviorSubject<ListenerState>

Inherited from

Listener.stateSubject

---

version

Get Signature

get version(): string;

Defined in: packages/framework/src/lib/tcp/TCPListener.ts:117

Returns

string

Overrides

Listener.version

---

weight

Get Signature

get weight(): number;

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

Returns

number

Inherited from

Listener.weight

---

weightSubject

Get Signature

get weightSubject(): BehaviorSubject<number>;

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

Returns

BehaviorSubject<number>

Inherited from

Listener.weightSubject

Methods

closeAllConnector()

protected closeAllConnector(): void;

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

Returns

void

Inherited from

Listener.closeAllConnector

---

getConnector()

getConnector(session): Connector | undefined;

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

Parameters

Parameter	Type
session	string

Returns

Connector | undefined

Inherited from

Listener.getConnector

---

listen()

protected listen(): Promise<IListenerInfo>;

Defined in: packages/framework/src/lib/tcp/TCPListener.ts:36

Returns

Promise<IListenerInfo>

Overrides

Listener.listen

---

listenRange()

protected listenRange(min, max): Promise<IListenerInfo>;

Defined in: packages/framework/src/lib/tcp/TCPListener.ts:50

Parameters

Parameter	Type
min	number
max	number

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

Inherited from

Listener.newConnector

---

setWeight()

setWeight(weight): void;

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

Parameters

Parameter	Type
weight	number

Returns

void

Inherited from

Listener.setWeight

---

shutdown()

protected shutdown(): Promise<void>;

Defined in: packages/framework/src/lib/tcp/TCPListener.ts:86

Returns

Promise<void>

Overrides

Listener.shutdown

---

startListen()

startListen(): Promise<void>;

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

Returns

Promise<void>

Inherited from

Listener.startListen

---

stopListen()

stopListen(): Promise<void>;

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

Returns

Promise<void>

Inherited from

Listener.stopListen