1. module uws
   1. function uws (uri)
   2. function uws.Server (options, callback)
   3. function uws.http ()
   4. number uws.CLIENT_NO_CONTEXT_TAKEOVER
   5. number uws.CLOSED
   6. number uws.OPCODE_BINARY
   7. number uws.OPCODE_PING
   8. number uws.OPCODE_TEXT
   9. number uws.OPEN
   10. number uws.PERMESSAGE_DEFLATE
   11. number uws.SERVER_NO_CONTEXT_TAKEOVER
   12. object uws.http.prototype
   13. object uws.native
   14. object uws.native.client
   15. object uws.native.server
2. module uws.http
   1. function uws.http ()
   2. function uws.http.createServer ()
   3. function uws.http.getExpressApp ()
   4. function uws.http.getRequestPrototype ()
   5. function uws.http.getResponsePrototype ()
3. module uws.http.prototype
   1. function uws.http.prototype.listen ()
   2. function uws.http.prototype.on ()
4. module uws.native
   1. function uws.native.clearUserData ()
   2. function uws.native.connect ()
   3. function uws.native.getAddress ()
   4. function uws.native.getUserData ()
   5. function uws.native.httpServer ()
   6. function uws.native.setNoop ()
   7. function uws.native.setUserData ()
   8. function uws.native.transfer ()
   9. function uws.native.upgrade ()
   10. object uws.native.client
   11. object uws.native.server
5. module uws.native.client
   1. function uws.native.client.close ()
   2. function uws.native.client.finalizeMessage ()
   3. function uws.native.client.prepareMessage ()
   4. function uws.native.client.send ()
   5. function uws.native.client.sendPrepared ()
   6. function uws.native.client.terminate ()
   7. object uws.native.client.group
6. module uws.native.server
   1. function uws.native.server.close ()
   2. function uws.native.server.finalizeMessage ()
   3. function uws.native.server.prepareMessage ()
   4. function uws.native.server.send ()
   5. function uws.native.server.sendPrepared ()
   6. function uws.native.server.terminate ()
   7. object uws.native.server.group

module uws

function uws (uri)

• description and source-code

  class WebSocketClient extends WebSocket {
      constructor(uri) {
          super(null);
          this.internalOnOpen = noop;
          this.internalOnError = noop;
          native.connect(clientGroup, uri, this);
      }
  
      ping(message, options, dontFailWhenClosed) {
          if (this.external) {
              native.client.send(this.external, message, WebSocketClient.OPCODE_PING);
          }
      }
  
      terminate() {
          if (this.external) {
              native.client.terminate(this.external);
              this.external = null;
          }
      }
  
      send(message, options, cb) {
          if (this.external) {
              if (typeof options === 'function') {
                  cb = options;
                  options = null;
              }
  
              const binary = options && options.binary || typeof message !== 'string';
  
              native.client.send(this.external, message, binary ? WebSocketClient.OPCODE_BINARY : WebSocketClient.OPCODE_TEXT, cb ? (() => {
                  process.nextTick(cb);
              }) : undefined);
          } else if (cb) {
              cb(new Error('not opened'));
          }
      }
  
      close(code, data) {
          if (this.external) {
              native.client.close(this.external, code, data);
              this.external = null;
          }
      }
  }

• example usage

  n/a

function uws.Server (options, callback)

• description and source-code

  class Server extends EventEmitter {
      constructor(options, callback) {
          super();
  
          if (!options) {
              throw new TypeError('missing options');
          }
  
          if (options.port === undefined && !options.server && !options.noServer) {
              throw new TypeError('invalid options');
          }
  
          var nativeOptions = WebSocketClient.PERMESSAGE_DEFLATE;
  
          if (options.perMessageDeflate !== undefined) {
              if (options.perMessageDeflate === false) {
                  nativeOptions = 0;
              }
          }
  
          this.serverGroup = native.server.group.create(nativeOptions, options.maxPayload === undefined ? 1048576 : options.maxPayload
  );
  
          // can these be made private?
          this._upgradeCallback = noop;
          this._upgradeListener = null;
          this._noDelay = options.noDelay === undefined ? true : options.noDelay;
          this._lastUpgradeListener = true;
          this._passedHttpServer = options.server;
  
          if (!options.noServer) {
              this.httpServer = options.server ? options.server : http.createServer((request, response) => {
                  // todo: default HTTP response
                  response.end();
              });
  
              if (options.path && (!options.path.length || options.path[0] !== '/')) {
                  options.path = '/' + options.path;
              }
  
              this.httpServer.on('upgrade', this._upgradeListener = ((request, socket, head) => {
                  if (!options.path || options.path == request.url.split('?')[0].split('#')[0]) {
                      if (options.verifyClient) {
                          const info = {
                              origin: request.headers.origin,
                              secure: request.connection.authorized !== undefined || request.connection.encrypted !== undefined,
                              req: request
                          };
  
                          if (options.verifyClient.length === 2) {
                              options.verifyClient(info, (result, code, name) => {
                                  if (result) {
                                      this.handleUpgrade(request, socket, head, emitConnection);
                                  } else {
                                      abortConnection(socket, code, name);
                                  }
                              });
                          } else {
                              if (options.verifyClient(info)) {
                                  this.handleUpgrade(request, socket, head, emitConnection);
                              } else {
                                  abortConnection(socket, 400, 'Client verification failed');
                              }
                          }
                      } else {
                          this.handleUpgrade(request, socket, head, emitConnection);
                      }
                  } else {
                      if (this._lastUpgradeListener) {
                          abortConnection(socket, 400, 'URL not supported');
                      }
                  }
              }));
  
              this.httpServer.on('newListener', (eventName, listener) => {
                  if (eventName === 'upgrade') {
                      this._lastUpgradeListener = false;
                  }
              });
          }
  
          native.server.group.onDisconnection(this.serverGroup, (external, code, message, webSocket) => {
              webSocket.external = null;
  
              process.nextTick(() => {
                  webSocket.internalOnClose(code, message);
              });
  
              native.clearUserData(external);
          });
  
          native.server.group.onMessage(this.serverGroup, onServerMessage);
  
          native.server.group.onPing(this.serverGroup, (message, webSocket) => {
              webSocket.onping(message);
          });
  
          native.server.group.onPong(this.serverGroup, (message, webSocket) => {
              webSocket.onpong(message);
          });
  
          native.server.group.onConnection(this.serverGroup, (external) => {
              const webSocket = new WebSocket(external); ...

• example usage

  n/a

function uws.http ()

• description and source-code

  http = function () { [native code] }

• example usage

  n/a

module uws.http

function uws.http ()

• description and source-code

  http = function () { [native code] }

• example usage

  n/a

function uws.http.createServer ()

• description and source-code

  function createServer() { [native code] }

• example usage

  ...
          this._upgradeCallback = noop;
          this._upgradeListener = null;
          this._noDelay = options.noDelay === undefined ? true : options.noDelay;
          this._lastUpgradeListener = true;
          this._passedHttpServer = options.server;
  
          if (!options.noServer) {
  this.httpServer = options.server ? options.server : http.createServer((request, response
  ) => {
      // todo: default HTTP response
      response.end();
  });
  
  if (options.path && (!options.path.length || options.path[0] !== '/')) {
      options.path = '/' + options.path;
  }
  ...

function uws.http.getExpressApp ()

• description and source-code

  function getExpressApp() { [native code] }

• example usage

  n/a

function uws.http.getRequestPrototype ()

• description and source-code

  function getRequestPrototype() { [native code] }

• example usage

  n/a

function uws.http.getResponsePrototype ()

• description and source-code

  function getResponsePrototype() { [native code] }

• example usage

  n/a

module uws.http.prototype

function uws.http.prototype.listen ()

• description and source-code

  function listen() { [native code] }

• example usage

  ...
      native.setUserData(external, webSocket);
      this._upgradeCallback(webSocket);
      _upgradeReq = null;
  });
  
  if (options.port !== undefined) {
      if (options.host) {
          this.httpServer.listen(options.port, options.host, () => {
              this.emit('listening');
              callback && callback();
          });
      } else {
          this.httpServer.listen(options.port, () => {
              this.emit('listening');
              callback && callback();
  ...

function uws.http.prototype.on ()

• description and source-code

  function on() { [native code] }

• example usage

  ...
  var WebSocketServer = require('uws').Server;
  var wss = new WebSocketServer({ port: 3000 });
  
  function onMessage(message) {
      console.log('received: ' + message);
  }
  
  wss.on('connection', function(ws) {
      ws.on('message', onMessage);
      ws.send('something');
  });
  ```
  
  ##### Deviations from ws
  There are some important incompatibilities with `ws` though, we aim to be ~90% compatible but will never implement behavior that
   is deemed too inefficient:
  ...

module uws.native

function uws.native.clearUserData ()

• description and source-code

  function clearUserData() { [native code] }

• example usage

  ...
  native.client.group.onDisconnection(clientGroup, (external, code, message, webSocket) => {
      webSocket.external = null;
  
      process.nextTick(() => {
          webSocket.internalOnClose(code, message);
      });
  
      native.clearUserData(external);
  });
  
  native.client.group.onPing(clientGroup, (message, webSocket) => {
      webSocket.onping(message);
  });
  
  native.client.group.onPong(clientGroup, (message, webSocket) => {
  ...

function uws.native.connect ()

• description and source-code

  function connect() { [native code] }

• example usage

  ...
  }
  
  class WebSocketClient extends WebSocket {
  constructor(uri) {
      super(null);
      this.internalOnOpen = noop;
      this.internalOnError = noop;
      native.connect(clientGroup, uri, this);
  }
  
  ping(message, options, dontFailWhenClosed) {
      if (this.external) {
          native.client.send(this.external, message, WebSocketClient.OPCODE_PING);
      }
  }
  ...

function uws.native.getAddress ()

• description and source-code

  function getAddress() { [native code] }

• example usage

  ...
  }
  
  get readyState() {
      return this.external ? WebSocketClient.OPEN : WebSocketClient.CLOSED;
  }
  
  get _socket() {
      const address = this.external ? native.getAddress(this.external) : new Array(3);
      return {
          remotePort: address[0],
          remoteAddress: address[1],
          remoteFamily: address[2]
      };
  }
  ...

function uws.native.getUserData ()

• description and source-code

  function getUserData() { [native code] }

• example usage

  ...
  native.setNoop(noop);
  
  var _upgradeReq = null;
  
  const clientGroup = native.client.group.create();
  
  native.client.group.onConnection(clientGroup, (external) => {
      const webSocket = native.getUserData(external);
      webSocket.external = external;
      webSocket.internalOnOpen();
  });
  
  native.client.group.onMessage(clientGroup, (message, webSocket) => {
      webSocket.internalOnMessage(message);
  });
  ...

function uws.native.httpServer ()

• description and source-code

  httpServer = function () { [native code] }

• example usage

  n/a

function uws.native.setNoop ()

• description and source-code

  function setNoop() { [native code] }

• example usage

  ...
      } else {
          throw new Error('Compilation of µWebSockets has failed and there is no pre-compiled binary ' +
          'available for your system. Please install a supported C++11 compiler and reinstall the module \'uws\'.&#
  x27;);
      }
  }
  })();
  
  native.setNoop(noop);
  
  var _upgradeReq = null;
  
  const clientGroup = native.client.group.create();
  
  native.client.group.onConnection(clientGroup, (external) => {
  const webSocket = native.getUserData(external);
  ...

function uws.native.setUserData ()

• description and source-code

  function setUserData() { [native code] }

• example usage

  ...
  native.server.group.onPong(this.serverGroup, (message, webSocket) => {
      webSocket.onpong(message);
  });
  
  native.server.group.onConnection(this.serverGroup, (external) => {
      const webSocket = new WebSocket(external);
  
      native.setUserData(external, webSocket);
      this._upgradeCallback(webSocket);
      _upgradeReq = null;
  });
  
  if (options.port !== undefined) {
      if (options.host) {
          this.httpServer.listen(options.port, options.host, () => {
  ...

function uws.native.transfer ()

• description and source-code

  function transfer() { [native code] }

• example usage

  ...
      }
  } else {
      const secKey = request.headers['sec-websocket-key'];
      const socketHandle = socket.ssl ? socket._parent._handle : socket._handle;
      const sslState = socket.ssl ? socket.ssl._external : null;
      if (socketHandle && secKey && secKey.length == 24) {
          socket.setNoDelay(this._noDelay);
          const ticket = native.transfer(socketHandle.fd === -1 ? socketHandle : socketHandle
  .fd, sslState);
          socket.on('close', (error) => {
              if (this.serverGroup) {
                  _upgradeReq = request;
                  this._upgradeCallback = callback ? callback : noop;
                  native.upgrade(this.serverGroup, ticket, secKey, request.headers['sec-websocket-extensions'], request.
  headers['sec-websocket-protocol']);
              }
          });
  ...

function uws.native.upgrade ()

• description and source-code

  function upgrade() { [native code] }

• example usage

  ...
  }
  
  handleUpgrade(request, socket, upgradeHead, callback) {
      if (socket._isNative) {
          if (this.serverGroup) {
              _upgradeReq = request;
              this._upgradeCallback = callback ? callback : noop;
              native.upgrade(this.serverGroup, socket.external, secKey, request.headers
  ['sec-websocket-extensions'], request.headers['sec-websocket-protocol']);
          }
      } else {
          const secKey = request.headers['sec-websocket-key'];
          const socketHandle = socket.ssl ? socket._parent._handle : socket._handle;
          const sslState = socket.ssl ? socket.ssl._external : null;
          if (socketHandle && secKey && secKey.length == 24) {
              socket.setNoDelay(this._noDelay);
  ...

module uws.native.client

function uws.native.client.close ()

• description and source-code

  function close() { [native code] }

• example usage

  ...
      } else if (cb) {
          cb(new Error('not opened'));
      }
  }
  
  close(code, data) {
      if (this.external) {
          native.server.close(this.external, code, data);
          this.external = null;
      }
  }
  }
  
  class WebSocketClient extends WebSocket {
  constructor(uri) {
  ...

function uws.native.client.finalizeMessage ()

• description and source-code

  function finalizeMessage() { [native code] }

• example usage

  n/a

function uws.native.client.prepareMessage ()

• description and source-code

  function prepareMessage() { [native code] }

• example usage

  n/a

function uws.native.client.send ()

• description and source-code

  function send() { [native code] }

• example usage

  ...
  
  function onMessage(message) {
      console.log('received: ' + message);
  }
  
  wss.on('connection', function(ws) {
      ws.on('message', onMessage);
      ws.send('something');
  });
  ```
  
  ##### Deviations from ws
  There are some important incompatibilities with `ws` though, we aim to be ~90% compatible but will never implement behavior that
   is deemed too inefficient:
  
  * Binary data is passed zero-copy as an `ArrayBuffer`. This means you need to copy it to keep it past the callback. It also means
   you need to convert it with `Buffer.from(message)` if you expect a `Node.js Buffer`.
  ...

function uws.native.client.sendPrepared ()

• description and source-code

  function sendPrepared() { [native code] }

• example usage

  n/a

function uws.native.client.terminate ()

• description and source-code

  function terminate() { [native code] }

• example usage

  ...
      if (this.external) {
          native.server.send(this.external, message, WebSocketClient.OPCODE_PING);
      }
  }
  
  terminate() {
      if (this.external) {
          native.server.terminate(this.external);
          this.external = null;
      }
  }
  
  send(message, options, cb) {
      if (this.external) {
          if (typeof options === 'function') {
  ...

module uws.native.server

function uws.native.server.close ()

• description and source-code

  function close() { [native code] }

• example usage

  ...
      } else if (cb) {
          cb(new Error('not opened'));
      }
  }
  
  close(code, data) {
      if (this.external) {
          native.server.close(this.external, code, data);
          this.external = null;
      }
  }
  }
  
  class WebSocketClient extends WebSocket {
  constructor(uri) {
  ...

function uws.native.server.finalizeMessage ()

• description and source-code

  function finalizeMessage() { [native code] }

• example usage

  n/a

function uws.native.server.prepareMessage ()

• description and source-code

  function prepareMessage() { [native code] }

• example usage

  n/a

function uws.native.server.send ()

• description and source-code

  function send() { [native code] }

• example usage

  ...
  
  function onMessage(message) {
      console.log('received: ' + message);
  }
  
  wss.on('connection', function(ws) {
      ws.on('message', onMessage);
      ws.send('something');
  });
  ```
  
  ##### Deviations from ws
  There are some important incompatibilities with `ws` though, we aim to be ~90% compatible but will never implement behavior that
   is deemed too inefficient:
  
  * Binary data is passed zero-copy as an `ArrayBuffer`. This means you need to copy it to keep it past the callback. It also means
   you need to convert it with `Buffer.from(message)` if you expect a `Node.js Buffer`.
  ...

function uws.native.server.sendPrepared ()

• description and source-code

  function sendPrepared() { [native code] }

• example usage

  n/a

function uws.native.server.terminate ()

• description and source-code

  function terminate() { [native code] }

• example usage

  ...
      if (this.external) {
          native.server.send(this.external, message, WebSocketClient.OPCODE_PING);
      }
  }
  
  terminate() {
      if (this.external) {
          native.server.terminate(this.external);
          this.external = null;
      }
  }
  
  send(message, options, cb) {
      if (this.external) {
          if (typeof options === 'function') {
  ...