_socket_events_modules_socket_events_index_.md

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

Module: "socket-events/modules/socket-events/index"

Index

Classes

• ActiveSockets
• NumberSet
• Socket
• SocketLookupMap

Interfaces

• BufferEntry
• Esp32JsSocket

Type aliases

• OnAcceptCB
• OnCloseCB
• OnConnectCB
• OnDataCB
• OnErrorCB
• OnWritableCB

Variables

• sockets
• sslClientCtx

Functions

• afterSuspend
• beforeSuspend
• closeSocket
• getOrCreateNewSocket
• performOnClose
• resetSocket
• sockConnect
• sockListen

Type aliases

OnAcceptCB

Ƭ OnAcceptCB: function

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

Type declaration:

▸ (): void

---

OnCloseCB

Ƭ OnCloseCB: function

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

Type declaration:

▸ (sockfd: number): void

Parameters:

Name	Type
sockfd	number

---

OnConnectCB

Ƭ OnConnectCB: function

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

Type declaration:

▸ (socket: Esp32JsSocket): boolean | void

Parameters:

Name	Type
socket	Esp32JsSocket

---

OnDataCB

Ƭ OnDataCB: function

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

Type declaration:

▸ (data: Uint8Array, sockfd: number, length: number): void

Parameters:

Name	Type
data	Uint8Array
sockfd	number
length	number

---

OnErrorCB

Ƭ OnErrorCB: function

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

Type declaration:

▸ (sockfd: number): void

Parameters:

Name	Type
sockfd	number

---

OnWritableCB

Ƭ OnWritableCB: function

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

Type declaration:

▸ (socket: Esp32JsSocket): boolean

Parameters:

Name	Type
socket	Esp32JsSocket

Variables

Const sockets

• sockets: ActiveSockets‹› = new ActiveSockets()

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

---

Let sslClientCtx

• sslClientCtx: any

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

Functions

afterSuspend

▸ afterSuspend(evt: Esp32JsEventloopEvent, collected: function[]): boolean

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

Parameters:

Name	Type
evt	Esp32JsEventloopEvent
collected	function[]

Returns: boolean

---

beforeSuspend

▸ beforeSuspend(): void

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

Returns: void

---

closeSocket

▸ closeSocket(socketOrSockfd: Esp32JsSocket | number): void

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

Flushes buffered writes, shutdowns SSL (if it is a secure socket), close the socket, performs the close callback function, removes socket from {@link module:socket-events.sockets}.

Parameters:

Name	Type
socketOrSockfd	Esp32JsSocket | number

Returns: void

---

getOrCreateNewSocket

▸ getOrCreateNewSocket(): Socket‹›

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

Returns: Socket‹›

---

performOnClose

▸ performOnClose(socket: Esp32JsSocket): void

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

Parameters:

Name	Type
socket	Esp32JsSocket

Returns: void

---

resetSocket

▸ resetSocket(socket: Socket): void

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

Parameters:

Name	Type
socket	Socket

Returns: void

---

sockConnect

▸ sockConnect(ssl: boolean, host: string, port: string, onConnect: OnConnectCB, onData: function, onError: function, onClose: function): Esp32JsSocket

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

Connects to specified host and port.

Parameters:

▪ ssl: boolean

If we want to connect via SSL.

▪ host: string

The remote hostname.

▪ port: string

The remote port.

▪ onConnect: OnConnectCB

A callback which gets called on connect event.

▪ onData: function

A callback which gets called on a data event.

▸ (data: Uint8Array, sockfd: number, length: number): void

Parameters:

Name	Type
data	Uint8Array
sockfd	number
length	number

▪ onError: function

A callback which gets called on an error event.

▸ (sockfd: number): void

Parameters:

Name	Type
sockfd	number

▪ onClose: function

A callback which gets called on a close event.

▸ (): void

Returns: Esp32JsSocket

The socket.

---

sockListen

▸ sockListen(port: string | number, onAccept: function, onError: function, onClose: function, isSSL: boolean): Esp32JsSocket | null

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

Parameters:

▪ port: string | number

▪ onAccept: function

▸ (socket: Esp32JsSocket): void

Parameters:

Name	Type
socket	Esp32JsSocket

▪ onError: function

▸ (sockfd: number): void

Parameters:

Name	Type
sockfd	number

▪ onClose: function

▸ (sockfd: number): void

Parameters:

Name	Type
sockfd	number

▪ isSSL: boolean

Returns: Esp32JsSocket | null