Class ServerSocket

Hierarchy

SocketHandler
- ServerSocket

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ServerSocket(server: Server, socket: Socket): ServerSocket

Overrides SocketHandler.constructor
- Defined in src/lib/ServerSocket.ts:33
Parameters
- server: Server
- socket: Socket
Returns ServerSocket

Properties

name

name: null | string

The name of this socket.

since: 0.0.1

queue

queue: Queue = ...

The incoming message queue for this handler.

since: 0.1.0

Readonly server

server: Server

socket

socket: Socket

The internal socket that connects Veza to the network.

since: 0.0.1

status

status: ServerSocketStatus = ServerSocketStatus.Disconnected

Methods

Protected _handleMessage

_handleMessage(message: RawMessage): null | Readonly<NodeMessage>

Inherited from SocketHandler._handleMessage
- Defined in src/lib/Structures/Base/SocketHandler.ts:92
Parameters
- message: RawMessage
Returns null | Readonly<NodeMessage>

Private _onClose

_onClose(): void

- Defined in src/lib/ServerSocket.ts:112
Returns void

Protected _onData

_onData(data: Uint8Array): void

Overrides SocketHandler._onData
- Defined in src/lib/ServerSocket.ts:91
Parameters
- data: Uint8Array
Returns void

Private _onError

_onError(error: NetworkError): void

- Defined in src/lib/ServerSocket.ts:108
Parameters
- error: NetworkError
Returns void

disconnect

disconnect(close?: boolean): boolean

- Defined in src/lib/ServerSocket.ts:70
Disconnect from the socket, this will also reject all messages

Parameters
- Optional close: boolean
Returns boolean

send

send(data: any, options?: SendOptions): Promise<unknown>

Inherited from SocketHandler.send
- Defined in src/lib/Structures/Base/SocketHandler.ts:47
Send a message to a connected socket.

Parameters
- data: any
  
  The data to send to the socket
- options: SendOptions = {}
  
  The options for this message
Returns Promise<unknown>

setup

setup(): Promise<boolean>

- Defined in src/lib/ServerSocket.ts:38
Returns Promise<boolean>

Generated using TypeDoc