rpclibrary/docs/interfaces/_interfaces_.socket.md

rpclibrary › Globals › “Interfaces” › Socket

Interface: Socket

Generic socket interface that can apply to bsock as well as RPCSocket

Hierarchy

• Destroyable

↳ Socket

Implemented by

• RPCSocket

Index

Properties

• call
• fire
• hook
• on
• port
• unhook

Methods

• close
• destroy

Properties

call

• call: function

Defined in Interfaces.ts:19

Type declaration:

▸ (rpcname: T.Name, …args: T.Any[]): Promise‹T.Any›

Parameters:

Name	Type
rpcname	T.Name
...args	T.Any[]

---

fire

• fire: function

Defined in Interfaces.ts:20

Type declaration:

▸ (rpcname: T.Name, …args: T.Any[]): Promise‹T.Any›

Parameters:

Name	Type
rpcname	T.Name
...args	T.Any[]

---

hook

• hook: function

Defined in Interfaces.ts:17

Type declaration:

▸ (rpcname: T.Name, handler: function): Socket

Parameters:

▪ rpcname: T.Name

▪ handler: function

▸ (…args: any[]): any | Promise‹any›

Parameters:

Name	Type
...args	any[]

---

on

• on: T.OnFunction

Defined in Interfaces.ts:21

---

port

• port: number

Defined in Interfaces.ts:16

---

unhook

• unhook: function

Defined in Interfaces.ts:18

Type declaration:

▸ (rpcname: T.Name): Socket

Parameters:

Name	Type
rpcname	T.Name

Methods

close

▸ close(): void

Defined in Interfaces.ts:22

Returns: void

---

destroy

▸ destroy(): void

Inherited from Destroyable.destroy

Defined in Interfaces.ts:26

Returns: void