@sora-soft/framework

---

@sora-soft/framework / TCPConnector

Class: TCPConnector

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

Extends

• Connector

Constructors

Constructor

new TCPConnector(socket?): TCPConnector;

Defined in: packages/framework/src/lib/tcp/TCPConnector.ts:27

Parameters

Parameter	Type
socket?	Socket

Returns

TCPConnector

Overrides

Connector.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
codec_?	protected	Codec<any>	Connector.codec_	packages/framework/src/lib/rpc/Connector.ts:276
lifeCycle_	protected	LifeCycle<ConnectorState>	Connector.lifeCycle_	packages/framework/src/lib/rpc/Connector.ts:274
session_	protected	string | undefined	Connector.session_	packages/framework/src/lib/rpc/Connector.ts:277
target_?	protected	IListenerInfo	Connector.target_	packages/framework/src/lib/rpc/Connector.ts:275

Accessors

dataSubject

Get Signature

get dataSubject(): Subject<IRawNetPacket>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:266

Returns

Subject<IRawNetPacket>

Inherited from

Connector.dataSubject

---

protocol

Get Signature

get protocol(): string;

Defined in: packages/framework/src/lib/tcp/TCPConnector.ts:216

Returns

string

Overrides

Connector.protocol

---

scope

Get Signature

get scope(): Scope<unknown>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:270

Returns

Scope<unknown>

Inherited from

Connector.scope

---

session

Get Signature

get session(): string | undefined;

Defined in: packages/framework/src/lib/rpc/Connector.ts:254

Returns

string | undefined

Set Signature

set session(value): void;

Defined in: packages/framework/src/lib/rpc/Connector.ts:258

Parameters

Parameter	Type
value	string | undefined

Returns

void

Inherited from

Connector.session

---

state

Get Signature

get state(): ConnectorState;

Defined in: packages/framework/src/lib/rpc/Connector.ts:246

Returns

ConnectorState

Inherited from

Connector.state

---

stateSubject

Get Signature

get stateSubject(): BehaviorSubject<ConnectorState>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:250

Returns

BehaviorSubject<ConnectorState>

Inherited from

Connector.stateSubject

---

target

Get Signature

get target(): IListenerInfo | undefined;

Defined in: packages/framework/src/lib/rpc/Connector.ts:262

Returns

IListenerInfo | undefined

Inherited from

Connector.target

Methods

connect()

protected connect(listenInfo): Promise<void>;

Defined in: packages/framework/src/lib/tcp/TCPConnector.ts:55

Parameters

Parameter	Type
listenInfo	IListenerInfo

Returns

Promise<void>

Overrides

Connector.connect

---

disablePingPong()

protected disablePingPong(): void;

Defined in: packages/framework/src/lib/rpc/Connector.ts:178

Returns

void

Inherited from

Connector.disablePingPong

---

disconnect()

protected disconnect(): Promise<void>;

Defined in: packages/framework/src/lib/tcp/TCPConnector.ts:142

Returns

Promise<void>

Overrides

Connector.disconnect

---

enablePingPong()

protected enablePingPong(): void;

Defined in: packages/framework/src/lib/rpc/Connector.ts:147

Returns

void

Inherited from

Connector.enablePingPong

---

handleCommand()

protected handleCommand(command, args): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:214

Parameters

Parameter	Type
command	ConnectorCommand
args	unknown

Returns

Promise<void>

Inherited from

Connector.handleCommand

---

handleIncomeMessage()

protected handleIncomeMessage(data): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:187

Parameters

Parameter	Type
data	IRawNetPacket

Returns

Promise<void>

Inherited from

Connector.handleIncomeMessage

---

isAvailable()

isAvailable(): boolean;

Defined in: packages/framework/src/lib/tcp/TCPConnector.ts:51

Returns

boolean

Overrides

Connector.isAvailable

---

off()

off(): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:96

Returns

Promise<void>

Inherited from

Connector.off

---

onCodecSelected()

onCodecSelected(code): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:80

Parameters

Parameter	Type
code	string

Returns

Promise<void>

Inherited from

Connector.onCodecSelected

---

onPingError()

protected onPingError(err): void;

Defined in: packages/framework/src/lib/rpc/Connector.ts:171

Parameters

Parameter	Type
err	ExError

Returns

void

Inherited from

Connector.onPingError

---

selectCodec()

selectCodec(code): Promise<void>;

Defined in: packages/framework/src/lib/tcp/TCPConnector.ts:170

Parameters

Parameter	Type
code	string

Returns

Promise<void>

Overrides

Connector.selectCodec

---

send()

send(packet): Promise<void>;

Defined in: packages/framework/src/lib/tcp/TCPConnector.ts:150

Parameters

Parameter	Type
packet	IRawNetPacket

Returns

Promise<void>

Overrides

Connector.send

---

sendCommand()

sendCommand(command, args?): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:131

Parameters

Parameter	Type
command	ConnectorCommand
args?	unknown

Returns

Promise<void>

Inherited from

Connector.sendCommand

---

sendNotify()

sendNotify(notify, fromId?): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:125

Parameters

Parameter	Type
notify	Notify
fromId?	string | null

Returns

Promise<void>

Inherited from

Connector.sendNotify

---

sendPing()

protected sendPing(id): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:139

Parameters

Parameter	Type
id	number

Returns

Promise<void>

Inherited from

Connector.sendPing

---

sendPong()

protected sendPong(id): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:143

Parameters

Parameter	Type
id	number

Returns

Promise<void>

Inherited from

Connector.sendPong

---

sendRaw()

sendRaw(payload): Promise<void>;

Defined in: packages/framework/src/lib/tcp/TCPConnector.ts:158

Parameters

Parameter	Type
payload	Buffer

Returns

Promise<void>

Overrides

Connector.sendRaw

---

start()

start(target, codec): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Connector.ts:62

Parameters

Parameter	Type
target	IListenerInfo
codec	Codec<any>

Returns

Promise<void>

Inherited from

Connector.start

---

waitForReady()

waitForReady(ttlMs): Promise<void>;

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

Parameters

Parameter	Type
ttlMs	number

Returns

Promise<void>

Inherited from

Connector.waitForReady

---

register()

static register(manager?): void;

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

Parameters

Parameter	Type
manager?	ProviderManager

Returns

void