_socket_events_modules_socket_events_index_.socket.md

esp32-javascript › "socket-events/modules/socket-events/index" › Socket

Class: Socket

Hierarchy

• Socket

Implements

• Esp32JsSocket

Index

Properties

• _isConnected
• _isError
• _isListening
• _onWritable
• dataBuffer
• dataBufferSize
• defaultBufferSize
• flushAlways
• onAccept
• onClose
• onConnect
• onData
• onError
• readTimeout
• readTimeoutHandle
• sockfd
• ssl
• textEncoder
• writebuffer

Accessors

• isConnected
• isError
• isListening
• onWritable

Methods

• clearReadTimeoutTimer
• extendReadTimeout
• flush
• maintainSocketStatus
• setReadTimeout
• write

Properties

Private _isConnected

• _isConnected: boolean = false

Defined in socket-events/modules/socket-events/index.ts:213

---

_isError

• _isError: boolean = false

Defined in socket-events/modules/socket-events/index.ts:214

---

Private _isListening

• _isListening: boolean = false

Defined in socket-events/modules/socket-events/index.ts:215

---

Private _onWritable

• _onWritable: OnWritableCB | null = null

Defined in socket-events/modules/socket-events/index.ts:212

---

Private dataBuffer

• dataBuffer: Uint8Array‹› = new Uint8Array(this.defaultBufferSize)

Defined in socket-events/modules/socket-events/index.ts:169

---

Private dataBufferSize

• dataBufferSize: number = 0

Defined in socket-events/modules/socket-events/index.ts:170

---

Private defaultBufferSize

• defaultBufferSize: number = 3 * 1024

Defined in socket-events/modules/socket-events/index.ts:168

---

flushAlways

• flushAlways: boolean = true

Defined in socket-events/modules/socket-events/index.ts:217

---

onAccept

• onAccept: OnAcceptCB | null = null

Implementation of Esp32JsSocket.onAccept

Defined in socket-events/modules/socket-events/index.ts:207

The onData callback.

---

onClose

• onClose: OnCloseCB | null = null

Implementation of Esp32JsSocket.onClose

Defined in socket-events/modules/socket-events/index.ts:211

---

onConnect

• onConnect: OnConnectCB | null = null

Implementation of Esp32JsSocket.onConnect

Defined in socket-events/modules/socket-events/index.ts:209

---

onData

• onData: OnDataCB | null = null

Implementation of Esp32JsSocket.onData

Defined in socket-events/modules/socket-events/index.ts:208

---

onError

• onError: OnErrorCB | null = null

Implementation of Esp32JsSocket.onError

Defined in socket-events/modules/socket-events/index.ts:210

---

Private readTimeout

• readTimeout: number = -1

Defined in socket-events/modules/socket-events/index.ts:173

---

Private readTimeoutHandle

• readTimeoutHandle: number = -1

Defined in socket-events/modules/socket-events/index.ts:174

---

sockfd

• sockfd: number = -1

Implementation of Esp32JsSocket.sockfd

Defined in socket-events/modules/socket-events/index.ts:201

The socket file descriptor.

---

ssl

• ssl: any = null

Implementation of Esp32JsSocket.ssl

Defined in socket-events/modules/socket-events/index.ts:216

---

Private textEncoder

• textEncoder: TextEncoder = new TextEncoder()

Defined in socket-events/modules/socket-events/index.ts:171

---

writebuffer

• writebuffer: BufferEntry[] = []

Implementation of Esp32JsSocket.writebuffer

Defined in socket-events/modules/socket-events/index.ts:172

Accessors

isConnected

• get isConnected(): boolean

Defined in socket-events/modules/socket-events/index.ts:234

Returns: boolean

• set isConnected(isConnected: boolean): void

Defined in socket-events/modules/socket-events/index.ts:229

Parameters:

Name	Type
isConnected	boolean

Returns: void

---

isError

• get isError(): boolean

Defined in socket-events/modules/socket-events/index.ts:261

Returns: boolean

• set isError(isError: boolean): void

Defined in socket-events/modules/socket-events/index.ts:256

Parameters:

Name	Type
isError	boolean

Returns: void

---

isListening

• get isListening(): boolean

Defined in socket-events/modules/socket-events/index.ts:243

Returns: boolean

• set isListening(isListening: boolean): void

Defined in socket-events/modules/socket-events/index.ts:238

Parameters:

Name	Type
isListening	boolean

Returns: void

---

onWritable

• get onWritable(): null | function

Defined in socket-events/modules/socket-events/index.ts:252

Returns: null | function

• set onWritable(onWritable: OnWritableCB | null): void

Defined in socket-events/modules/socket-events/index.ts:247

Parameters:

Name	Type
onWritable	OnWritableCB | null

Returns: void

Methods

clearReadTimeoutTimer

▸ clearReadTimeoutTimer(): void

Defined in socket-events/modules/socket-events/index.ts:181

Returns: void

---

extendReadTimeout

▸ extendReadTimeout(): void

Defined in socket-events/modules/socket-events/index.ts:187

Returns: void

---

flush

▸ flush(cb?: undefined | function): void

Defined in socket-events/modules/socket-events/index.ts:294

Parameters:

Name	Type
cb?	undefined | function

Returns: void

---

Private maintainSocketStatus

▸ maintainSocketStatus(): void

Defined in socket-events/modules/socket-events/index.ts:219

Returns: void

---

setReadTimeout

▸ setReadTimeout(readTimeout: number): void

Implementation of Esp32JsSocket

Defined in socket-events/modules/socket-events/index.ts:176

Parameters:

Name	Type
readTimeout	number

Returns: void

---

write

▸ write(data: string | Uint8Array): void

Implementation of Esp32JsSocket

Defined in socket-events/modules/socket-events/index.ts:265

Parameters:

Name	Type
data	string | Uint8Array

Returns: void