Welshman Docs / @welshman/net / Socket

Class: Socket

Defined in: packages/net/src/Socket.ts:18

Constructors

new Socket()

new Socket(cxn): Socket

Defined in: packages/net/src/Socket.ts:24

Parameters

cxn

Connection

Returns

Socket

Properties

cxn

readonly cxn: Connection

Defined in: packages/net/src/Socket.ts:24

---

lastError

lastError: number = 0

Defined in: packages/net/src/Socket.ts:19

---

status

status: SocketStatus = SocketStatus.New

Defined in: packages/net/src/Socket.ts:20

---

worker

worker: Worker<Message>

Defined in: packages/net/src/Socket.ts:21

---

ws?

optional ws: WebSocket

Defined in: packages/net/src/Socket.ts:22

Methods

close()

close(): Promise<void>

Defined in: packages/net/src/Socket.ts:66

Returns

Promise<void>

---

open()

open(): Promise<void>

Defined in: packages/net/src/Socket.ts:41

Returns

Promise<void>

---

send()

send(message): Promise<void>

Defined in: packages/net/src/Socket.ts:78

Parameters

message

Message

Returns

Promise<void>

---

wait()

wait(timeout): Promise<void>

Defined in: packages/net/src/Socket.ts:31

Parameters

timeout

number = 300

Returns

Promise<void>