@sora-soft/framework

---

@sora-soft/framework / Connector

Abstract Class: Connector

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

Extended by

• TCPConnector

Constructors

Constructor

new Connector(options): Connector;

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

Parameters

Parameter	Type
options	IConnectorOptions

Returns

Connector

Properties

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

---

protocol

Get Signature

get abstract protocol(): string;

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

Returns

string

---

scope

Get Signature

get scope(): Scope<unknown>;

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

Returns

Scope<unknown>

---

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

---

state

Get Signature

get state(): ConnectorState;

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

Returns

ConnectorState

---

stateSubject

Get Signature

get stateSubject(): BehaviorSubject<ConnectorState>;

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

Returns

BehaviorSubject<ConnectorState>

---

target

Get Signature

get target(): IListenerInfo | undefined;

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

Returns

IListenerInfo | undefined

Methods

connect()

abstract protected connect(target): Promise<void>;

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

Parameters

Parameter	Type
target	IListenerInfo

Returns

Promise<void>

---

disablePingPong()

protected disablePingPong(): void;

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

Returns

void

---

disconnect()

abstract protected disconnect(): Promise<void>;

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

Returns

Promise<void>

---

enablePingPong()

protected enablePingPong(): void;

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

Returns

void

---

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>

---

handleIncomeMessage()

protected handleIncomeMessage(data): Promise<void>;

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

Parameters

Parameter	Type
data	IRawNetPacket

Returns

Promise<void>

---

isAvailable()

abstract isAvailable(): boolean;

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

Returns

boolean

---

off()

off(): Promise<void>;

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

Returns

Promise<void>

---

onCodecSelected()

onCodecSelected(code): Promise<void>;

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

Parameters

Parameter	Type
code	string

Returns

Promise<void>

---

onPingError()

protected onPingError(err): void;

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

Parameters

Parameter	Type
err	ExError

Returns

void

---

selectCodec()

abstract selectCodec(code): Promise<void>;

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

Parameters

Parameter	Type
code	string

Returns

Promise<void>

---

send()

abstract send<RequestPayload>(request): Promise<void>;

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

Type Parameters

Type Parameter
RequestPayload

Parameters

Parameter	Type
request	IRawNetPacket<RequestPayload>

Returns

Promise<void>

---

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>

---

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>

---

sendPing()

protected sendPing(id): Promise<void>;

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

Parameters

Parameter	Type
id	number

Returns

Promise<void>

---

sendPong()

protected sendPong(id): Promise<void>;

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

Parameters

Parameter	Type
id	number

Returns

Promise<void>

---

sendRaw()

abstract sendRaw(request): Promise<void>;

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

Parameters

Parameter	Type
request	object

Returns

Promise<void>

---

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>

---

waitForReady()

waitForReady(ttlMs): Promise<void>;

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

Parameters

Parameter	Type
ttlMs	number

Returns

Promise<void>