Socket.IO API Server

new Server(httpServer[, options])

  • httpServer 参数表示要绑定到的服务器
  • options 表示可选的选项

create

const io = require('socket.io')();

// or
const Server = require('socket.io');
const io = new Server();

options

可以设置当前选项和底层Engine.IO的选项

pingTimeout

在未收到pong包多少ms后关闭连接

pingInterval

平均间隔多少ms发送一个ping包

transports

允许建立的连接方式。默认值为['polling', 'websocket'],传输方式数组的顺序十分重要,当只提供了['websocket']的情况下,如果websocket无法提供服务,那意味着无法应用别的连接


new Server(port[, options])

  • port 端口
  • options 表示可选的选项

new Server(options)

  • options 表示可选的选项

server.sockets

  • 命名空间

命名空间(/)的别名

io.sockets.emit('hi','everyone'); 
//相当于
 io.of('/')。emit('hi','everyone');

server.serveClient([value])

  • value Boolean

等同于设置options选项中的serveClient选项,默认true


server.path([value])

  • value String

等同于设置options选项中的path,默认/socket.io


server.adapter([value])

  • value Adapter对象

等同于设置options选项中的adapter


server.origins([value])

  • value

设置允许访问的源,默认*


server.origins(fn)

  • fn

function(origin:String, callback(error:String, success:Boolean))

orgin 源
success origin 是否允许
error 若不允许,error必须被提供且返回相应的信息

io.origins((origin, callback) => {
  if (origin !== 'https://foo.example.com') {
    return callback('origin not allowed', false);
  }
  callback(null, true);
});

server.attach(httpServer[, options]) server.listen(httpServer[, options])

Server使用提供的options(可选)将http.Server 附加到engine.io实例。相当于附加到已创建好的server上


server.attach(port[, options]) server.listen(port[, options])

Server使用提供的options(可选)将新的http.Server 附加到engine.io实例。相当于自己创建了server并监听对应的端口


server.of(nsp)

  • nsp (String|RegExp|Function)
  • Returns Namespace

返回对应nsp的server实例


server.close([callback])

关闭socket.io服务器。callback将在关闭所有的连接时调用。

原文地址:https://www.cnblogs.com/goOtter/p/10114432.html