LogoLogo
  • 关于本socket.io中文文档
  • socket.IO website
  • 1 指南(Guide)
    • 1-1 介绍(Introduction)
    • 1-2 web框架(The web framework)
    • 1-3 服务HTML(Serving HTML)
    • 1-4 集成 socket.io(Integrating socket.io)
    • 1-5 发送事件(Emiting events)
    • 1-6 广播(Broadcasting)
    • 1-7 作业(Homework)
    • 1-8 获取示例(Getting this example)
  • 2 文档(Docs)
    • 2.1 概览
      • 2.1.1 啥是Socket.io
      • 2.1.2 Socket.io不是什么
      • 2.1.3 安装
      • 2.1.4 在Node HTTP 服务中使用
      • 2.1.5 在express中使用Socket.io
      • 2.1.6 发送和接收事件
      • 2.1.7 限制自己使用命名空间
      • 2.1.8 发送易失性的消息
      • 2.1.9 发送和获取数据(确认)
      • 2.1.10 广播消息
      • 2.1.111 作为跨浏览器使用websocket
    • 2.2 房间和命名空间
      • 2.2.1 命名空间
      • 2.2.2 房间
      • 2.2.3 给外部发送消息
    • 2.3 从0.9迁移版本 migrating_from_0.9
      • 2.3.1 身份验证差异
      • 2.3.2 日志差异
      • 2.3.3 快捷方式
      • 2.3.4 配置差异
      • 2.3.5 解析器/协议差异
    • 2.4 多路节点使用
      • 2.4.1 Apache httpd配置
      • 2.4.2 在节点之间传递事件
      • 2.4.3 Haproxy配置
      • 2.4.4 粘性负载均衡
      • 2.4.5 Nginx配置
      • 2.4.6 使用node.js集群
    • 2.5 日志和调试
      • 2.5.1 可用的调试范围
    • 2.6 emit 备忘单
    • 2.7 内部概述
      • 2.7.1 内部概述引擎底层依赖关系图
      • 2.7.2 内部概述关系图
    • 2.8 faq
  • 3 客户端-API(Client-API)
    • 3.1 io
      • 3.1.1 io.protocpl
      • 3.1.2 io([url][,optiosn])
      • 3.1.3 初始化示例-带多路复用
      • 3.1.4 初始化示例-自定义路径
      • 3.1.5 初始化示例-查询参数
      • 3.1.6 初始化示例-查询选项
      • 3.1.7 初始化示例-额外Headers
      • 3.1.8 初始化示例-仅限websocket传输
      • 3.1.9 初始化示例-自定义解析器
      • 3.1.11 初始化示例-自签名证书
    • 3.2 manager
      • 3.2.1 new Manager(url[,options])
      • 3.2.2 manager.reconnection([value])
      • 3.2.3 manager.reconnectionAttempts([value])
      • 3.2.4 manager.reconnectionDelay.([value])
      • 3.2.5 manager.reconnectionDelayMax([value])
      • 3.2.6 manager.timeout(pvalue[])
      • 3.2.7 manager.open([callback])
      • 3.2.8 manager.connect([callback])
      • 3.2.9 manager.socket(nsp,options)
      • 3.2.10 event:connect_error
      • 3.2.11 event:connect_timeout
      • 3.2.12 event:reconnect
      • 3.2.13 event:reconnect_attempt
      • 3.2.14 event:reconnecting
      • 3.2.15 event:reconnect_error
      • 3.2.16 event:reconnect_failed
      • 3.2.17 event:ping
      • 3.2.18 event:pong
    • 3.3 socket
      • 3.3.1 socket.id
      • 3.3.2 socket.connected
      • 3.3.3 socket.disconnected
      • 3.3.4 socket.open()
      • 3.3.5 socket.connect()
      • 3.3.6 socket.send([...args][,ack])
      • 3.3.7 socket.emit(eventName,[...args][,ack])
      • 3.3.8 socket.on(eventName,callback)
      • 3.3.9 socket.compress(value)
      • 3.3.10 socket.binary(value)
      • 3.3.11 socket.close()
      • 3.3.12 socket.disconnect()
      • 3.3.13 event:connect
      • 3.3.14 event:connect_error
      • 3.3.15 event:connect_timeout
      • 3.3.16 event:error
      • 3.3.17 event:disconnect
      • 3.3.18 event:reconnect
      • 3.3.19 event:reconnect_attempt
      • 3.3.20 event:reconnenting
      • 3.3.21 event:reconnect_error
      • 3.3.22 event:reconnect_failed
      • 3.3.23 event:ping
      • 3.3.24 event:pong
  • 4 服务端-API(Server-API)
    • 4.1 server
      • 4.1.1 HTTP服务选项 new_server_httpserver_options
      • 4.1.2 服务器端口选项 new_server_port_options
      • 4.1.3 服务器选项 new_server_options
      • 4.1.4 服务器sockets server_sockets
      • 4.1.5 服务器serverClient值 server_serverClient_value
      • 4.1.6 服务器路径值 server_path_value
      • 4.1.7 服务器适配器值 server_adapter_value
      • 4.1.8 服务器源值 server_origins_value
      • 4.1.9 服务器源函数 server_origins_fn
      • 4.1.10 服务器附加HTTP服务选项 server_attach_httpServer_options
      • 4.1.11 服务器附加端口选项 server_attach_port_options
      • 4.1.12 服务器监听HTTP服务选项 server_listen_httpServer_options
      • 4.1.13 服务器监听端口选项 server_listent_port_options
      • 4.1.14 服务器绑定引擎 server_bind_engine
      • 4.1.15 服务器连接socket server_onconnection_socket
      • 4.1.16 服务器命名空间(nsp) server_of_nsp
      • 4.1.17 服务器关闭回调 server_close_callback
      • 4.1.18 服务器引擎生成socket ID server_engine_generateid
    • 4.2 命名空间(namespace)
      • 4.2.1 命名空间 namespace
      • 4.2.2 命名空间名称 namespace_name
      • 4.2.3 命名空间连接 namespace_connected
      • 4.2.4 命名空间适配器 namespace_adapter
      • 4.2.5 命名空间到房间 namespace_to_room
      • 4.2.6 命名空间在房间 namespace_in_room
      • 4.2.7 命名空间发送事件参数 namespace_emit_eventname_args
      • 4.2.8 命名空间客户端回调 namespace_clients_callback
      • 4.2.9 命名空间中间件函数 namespace_use_fn
      • 4.2.10 连接事件 event_connect
      • 4.2.11 事件连接 event_connection
      • 4.2.12 可见性标志位 flag_volatile
      • 4.2.13 二进制标志位 flag_binary
      • 4.2.14 本地标记位 flag_local
    • 4.3 socket
      • 4.3.1 socket_id
      • 4.3.2 socket_rooms
      • 4.3.3 socket_client
      • 4.3.4 socket_conn
      • 4.3.5 socket_request
      • 4.3.6 socket_handshake
      • 4.3.7 socket_use_fn
      • 4.3.8 socket_send_args_ack
      • 4.3.9 socket_emit_eventName_args_ack
      • 4.3.10 socket_on_eventName_callback
      • 4.3.11 socket_once_eventName_listener
      • 4.3.12 socket_removelistener_eventName_listener
      • 4.3.13 socket_removeAllListeners_eventName
      • 4.3.14 socket_eventNames
      • 4.3.15 socket_join_room_callback
      • 4.3.16 socket_join_rooms_callback
      • 4.3.17 socket_leave_room_callback
      • 4.3.18 socket_to_room
      • 4.3.19 socket_in_room
      • 4.3.20 socket_compress_value
      • 4.3.21 socket_disconnect_close
      • 4.3.22 flag_broadcast
      • 4.3.23 flag_volatile
      • 4.3.24 flag_binary
      • 4.3.25 event_disconnect
      • 4.3.26 event_error
      • 4.3.27 event_disconnecting
    • 4.4 client
      • 4.4.1 client
      • 4.4.2 client_conn
      • 4.4.3 client_request
Powered by GitBook
On this page

Was this helpful?

  1. 3 客户端-API(Client-API)
  2. 3.2 manager

3.2.1 new Manager(url[,options])

  • url (String)

  • options (Object)

  • Returns Manager

可用的选项:

选项

默认值

描述

path

/socket.io

在服务器端捕获的路径的名称

reconection

true

是否自动重新连接

reconnectionAttempts

Infinity

放弃前重新连接尝试的次数

reconnectionDelay

1000

在尝试重新连接之前,最初等待多长时间(1000)。受+/- randomizationFactor的影响,例如,默认初始延迟将在500到1500毫秒之间。

reconnectionDelayMax

5000

重新连接之间等待的最长时间(5000)。每次尝试都会增加2倍的重新连接延迟,并随机分组,如上所述。

randomizationFactor

0.5

0 <= randomizationFactor <= 1

timeout

20000

在发出connect_error和connect_timeout事件之前的连接超时

authConnect

true

如果设置为false,则必须在确定合适时调用manager.open

query

{}

连接命名空间时发送的其他查询参数(然后在服务器端的socket.handshake.query对象中找到)

parser

-

要使用的解析器。默认为socket.io附带的解析器实例。请参见socket.io-parser。

基础engine.io客户端的可用选项:

选项

默认值

描述

upgrade

true

客户端是否应该尝试将传输从长轮询升级到更好的传输。

forceJSONP

false

强制JSONP进行轮询传输。

jsonp

true

确定在需要轮询时是否使用JSONP。如果禁用(通过设置为false),如果没有其他传输可用,将发出错误(说“没有可用的传输”)。如果另一个传输可用于打开连接(例如WebSocket),则将使用该传输。

froceBase64

false

强制对轮询传输进行base 64编码,即使xhr2 responseType可用且websocket支持二进制。

enablesXDR

false

启用IE8的xdomainRequest以避免加载条闪烁并发出咔嗒声。默认为false,因为xdomainRequest存在不发送cookie的缺陷。

timestampRequests

-

是否在每个传输请求中添加时间戳。注意:除非此选项显式设置为false,否则轮询请求总是被标记。

timestampParam

t

timestamp参数

policyPort

843

服务器侦听的端口策略

transports

['polling','websocket']

要尝试的传输列表(按顺序)。Enigine总是尝试直接与第一个连接,前提是它通过了特性检测测试。

transportOptions

{}

按传输名称索引的选项哈希,覆盖给定传输的公用选项

rememberUpgrade

false

如果为true,并且先前与服务器的WebSocket连接成功,则连接尝试将绕过正常的升级过程,并最初尝试WebSocket。传输错误之后的连接尝试将使用正常升级过程。建议仅在使用SSL/TLS连接或知道网络不会阻止WebSockets时启用此选项。

onlyBinaryUpgrades

falsee

传输升级是否应限于支持二进制数据的传输

requestTimeout

0

XHR轮询请求超时(毫秒)(0)(仅限轮询传输)

protocols

-

底层engine.io客户端的node.js-only选项:

选项

默认值

描述

agent

false

要使用的http.agent

pfx

-

用于SSL的证书、私钥和CA证书。

key

-

用于SSL的私钥。

passphrase

-

私钥或pfx的密码短语字符串。

cert

-

要使用的公用X509证书。

ca

-

用于检查远程主机的颁发机构证书或颁发机构证书数组。

ciphers

-

rejectUnauthorized

false

如果为true,则根据提供的CA列表验证服务器证书。如果验证失败,将发出“错误”事件。在发送HTTP请求之前,在连接级别进行验证。

perMessageDeflate

true

extraHeaders

{}

将为每个请求传递给服务器的头(通过XHR轮询和WebSockets)。这些值可以在握手过程中使用,也可以用于特殊代理。

forceNode

false

对websockets使用nodejs实现-即使有可用的本地浏览器websocket,默认情况下这比nodejs实现更可取。(这在使用混合平台(如nw.js或electron)时很有用)

localAddress

-

要连接到的本地IP地址

Previous3.2 managerNext3.2.2 manager.reconnection([value])

Last updated 5 years ago

Was this helpful?

子协议列表(参见)(仅适用于WebSocket传输)

描述要使用或排除的密码的字符串。有关格式的详细信息,请参阅。

websocket permessage deflate扩展的参数(请参阅 API文档)。设置为false以禁用。

MDN参考
密码格式列表
ws module