Quark #

Modules #

Quark v1.3.0 Documentation

Table of Contents

quark/net #

SocketEvent #

WSocketEvent #

Class: NativeSocket #

NativeSocket #

nativesocket.hostname #

  • @get hostname: string Hostname of the WebSocket server

nativesocket.port #

  • @get port: Uint Port of the WebSocket server

nativesocket.ip #

  • @get ip: string IP address for the remote server

nativesocket.ipv6 #

  • @get ipv6: string IPv6 address for the remote server

nativesocket.isOpen #

  • @get isOpen: boolean true means connection is open

nativesocket.isConnecting #

  • @get isConnecting: boolean true means socket is connecting

nativesocket.isPause #

  • @get isPause: boolean true means socket is paused

nativesocket.setKeepAlive(keep_alive,keep_idle?) #

nativesocket.setNoDelay(noDelay?) #

nativesocket.setTimeout(time) #

nativesocket.connect() #

nativesocket.close() #

nativesocket.pause() #

nativesocket.resume() #

nativesocket.disableSslVerify(disable?) #

nativesocket.constructor(hostname,port,isSSL?) #

Class: Socket #

Socket #

socket.onOpen #

Trigger when opened connection

socket.onClose #

Trigger when closed connection

socket.onError #

Trigger when an error occurs

socket.onData #

Trigger when accept part of body data, and will be continuous

socket.onTimeout #

Trigger when a timeout of connection

socket.write(data) #

socket.error(reason) #

Handles an error

  • @param reason: any

Interface: Signer #

Signer #

Signer interface for signing data.

Class: WebSocket #

WebSocket #

WebSocket client conversation.

For example:

import {WebSocket} from 'quark/net';
let ws = new WebSocket('wss://example.com/path');
ws.onOpen.on(()=>{
  console.log('WebSocket opened');
  ws.write('Hello, WebSocket!');
});
ws.onData.on(e=>{
  console.log('Received data:', e.data);
});
ws.onError.on(e=>{
  console.error('WebSocket error:', e.data);
});
ws.onClose.on(()=>{
  console.log('WebSocket closed');
});
ws.connect();

websocket.url #

  • @get url: URL URL of the WebSocket server

websocket.hostname #

  • @get hostname: string Hostname of the WebSocket server

websocket.port #

  • @get port: Uint Port number

websocket.isSSL #

  • @get isSSL: boolean true means wss, false means ws

websocket.socket #

  • @get socket: Socket Socket connection implementation

websocket.headers #

  • @get headers: Dict<string> request headers

websocket.responseHeaders #

  • @get responseHeaders: Dict<string> Response headers

websocket.signer #

A signer, use to sign the request

websocket.ip #

  • @get ip: string ip address for the remote server

websocket.ipv6 #

  • @get ipv6: string ipv6 address for the remote server

websocket.isOpen #

  • @get isOpen: boolean true means connection is open

websocket.isPause #

  • @get isPause: boolean true means socket is paused

websocket.isConnecting #

  • @get isConnecting: boolean true means socket is connecting

websocket.onOpen #

Trigger when opened connection

websocket.onClose #

Trigger when closed connection

websocket.onError #

Trigger when an error occurs

websocket.onPing #

Trigger when accept ping message

websocket.onPong #

Trigger when accept pong message

websocket.onData #

Trigger when accept buffer data

websocket.onText #

Trigger when accept text data

websocket.onTimeout #

Trigger when a timeout of connection

websocket.constructor(url) #

  • @param url: string wss://xxxx.xx/path

websocket.setKeepAlive(keep_alive,keep_idle?) #

Setting keep alive for the socket connection

  • @param keep_alive: boolean enable keep alive
  • @param keep_idle?: Uint Default is 0 means 7200 seconds,
    the time in milliseconds to wait before sending keep alive packets

websocket.setTimeout(time) #

Setting timeout time for the socket connection

websocket.connect() #

Connect to the WebSocket server

websocket.close() #

Close the WebSocket connection

websocket.pause() #

Pause receiving data from the socket

websocket.resume() #

Resuming receiving data from the socket

websocket.write(data) #

Sending the data message.
Frame client-to-server output as a text packet or buffer packet.

websocket.send(data) #

alias for write

websocket.ping() #

Sending the ping message

websocket.test(timeoutMs?) #

First send the ping message to the remote client then wait for the pong message

  • @param timeoutMs?: Uint wait for the pong message, default not timeout
  • @return Promise<void>

websocket.disableSslVerify(disable) #

Setting if is disable ssl verify

  • @param disable: boolean True means disable ssl verify

websocket.triggerOpen() #

websocket.triggerClose() #

websocket.triggerError(err) #

websocket.triggerPing() #

websocket.triggerPong() #

websocket.triggerData(data) #

  • @param data: Buffer

websocket.triggerText(text) #

websocket.triggerTimeout() #