Class ClientSocket

Hierarchy

SocketHandler
- ClientSocket

Index

Constructors

constructor

Properties

Accessors

canReconnect

Methods

Constructors

constructor

new ClientSocket(client: Client): ClientSocket

Overrides SocketHandler.constructor
- Defined in src/lib/ClientSocket.ts:55
Parameters
- client: Client
Returns ClientSocket

Properties

Private _expectClosing

_expectClosing: boolean = false

Private _reconnectionTimeout

_reconnectionTimeout: null | Timer

Readonly client

client: Client

The socket's client

since: 0.7.0

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

retriesRemaining

retriesRemaining: number

How many reconnection attempts this socket has remaining.

since: 0.7.0

socket

socket: Socket

The internal socket that connects Veza to the network.

since: 0.0.1

status

status: ClientSocketStatus = ClientSocketStatus.Disconnected

The socket's status

since: 0.7.0

Accessors

Private canReconnect

get canReconnect(): boolean

- Defined in src/lib/ClientSocket.ts:65
Returns boolean

Methods

Private _attemptConnection

_attemptConnection(...options: [any, any?, any?]): void

- Defined in src/lib/ClientSocket.ts:252
Parameters
- Rest ...options: [any, any?, any?]
Returns void

Private _connect

_connect(...options: [any, any?, any?]): Promise<void>

- Defined in src/lib/ClientSocket.ts:185
Parameters
- Rest ...options: [any, any?, any?]
Returns Promise<void>

Private _emitConnect

_emitConnect(): void

- Defined in src/lib/ClientSocket.ts:258
Returns void

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 _handshake

_handshake(): Promise<void>

- Defined in src/lib/ClientSocket.ts:206
Returns Promise<void>

Private _onClose

_onClose(...options: [any, any?, any?]): void

- Defined in src/lib/ClientSocket.ts:145
Parameters
- Rest ...options: [any, any?, any?]
Returns void

Private _onConnect

_onConnect(): void

- Defined in src/lib/ClientSocket.ts:134
Returns void

Protected _onData

_onData(data: Uint8Array): void

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

Private _onError

_onError(error: any): void

- Defined in src/lib/ClientSocket.ts:174
Parameters
- error: any
Returns void

Private _reconnect

_reconnect(...options: [any, any?, any?]): void

- Defined in src/lib/ClientSocket.ts:155
Parameters
- Rest ...options: [any, any?, any?]
Returns void

connect

connect(options: SocketConnectOpts, connectionListener?: () => void): Promise<ClientSocket>
connect(port: number, host: string, connectionListener?: () => void): Promise<ClientSocket>
connect(port: number, connectionListener?: () => void): Promise<ClientSocket>
connect(path: string, connectionListener?: () => void): Promise<ClientSocket>

- Defined in src/lib/ClientSocket.ts:75
Connect to the socket.

since
0.0.1

see
https://nodejs.org/dist/latest/docs/api/net.html#net_socket_connect

Parameters
- options: SocketConnectOpts
  
  The options to pass to connect.
- Optional connectionListener: () => void
  - - (): void
    - Returns void
Returns Promise<ClientSocket>
- Defined in src/lib/ClientSocket.ts:76
Parameters
- port: number
- host: string
- Optional connectionListener: () => void
  - - (): void
    - Returns void
Returns Promise<ClientSocket>
- Defined in src/lib/ClientSocket.ts:77
Parameters
- port: number
- Optional connectionListener: () => void
  - - (): void
    - Returns void
Returns Promise<ClientSocket>
- Defined in src/lib/ClientSocket.ts:78
Parameters
- path: string
- Optional connectionListener: () => void
  - - (): void
    - Returns void
Returns Promise<ClientSocket>

disconnect

disconnect(): boolean

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

since
0.0.1

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>

Generated using TypeDoc