WebSocket

提示

hyperlane 框架支持 websocket 协议，服务端自动处理协议升级，支持请求中间件，路由处理，响应中间件。

服务端代码

提示

hyperlane 框架发送 websocket 响应使用send_body，与 sse 相同。 由于 websocket协议基于http，所以可以像使用 http 一样处理请求。 如果开发者尝试调用 send 会导致客户端处理错误， （服务端发送响应前需要处理成符合websocket 规范的响应，客户端才能正确解析）。所以对于 websocket， 请统一使用 send_body 方法。

单点发送

pub async fn handle(ctx: Context) {
    let request_body: Vec<u8> = ctx.get_request_body().await;
    let _ = ctx.set_response_body(request_body).await.send_body().await;
}

广播发送

提示

需要阻塞住当前处理函数，将后续所有请求在处理函数中处理。 这里使用 tokio 的 select 来处理多个请求，使用 hyperlane-broadcast 来实现广播。 需要特别注意，如果 server 没有配置 disable_ws_hook ，群发消息必须要求客户端连接后主动向服务端发送一条消息（空消息即可），否则不会接收到广播的信息， 因为服务端在框架内部会先完成握手，然后等待读取一次客户端请求，才会执行到用户代码。 如果配置了则连接后即可接收到广播的信息。

提示

完整代码参考 GroupChat 。

客户端代码

const ws = new WebSocket('ws://localhost:60000/websocket');

ws.onopen = () => {
  console.log('WebSocket opened');
  setInterval(() => {
    ws.send(`Now time: ${new Date().toISOString()}`);
  }, 1000);
};

ws.onmessage = (event) => {
  console.log('Receive: ', event.data);
};

ws.onerror = (error) => {
  console.error('WebSocket error: ', error);
};

ws.onclose = () => {
  console.log('WebSocket closed');
};