Fleck 说明文档翻译

Fleck

Fleck 是一个在 C# 中的 WebSocket 服务器端的一个实现.。分支自 Nugget 项目，Fleck 不需要任何的继承、容器亦或是需要增加的引用就可以使用。

实例

下面是一个把客户端网页发来的消息回发到客户端的服务器程序。

var server = new WebSocketServer("ws://0.0.0.0:8181");
server.Start(socket =>
{
　　socket.OnOpen = () => Console.WriteLine("Open!");
　　socket.OnClose = () => Console.WriteLine("Close!");
　　socket.OnMessage = message => socket.Send(message);
});

支持WebSocket的网页版本

Fleck 支持多种现代的具有 WebSocket 功能版本的浏览器。

Hixie-Draft-76/Hybi-00 （Safari 5，Chrome < 14， Firefox 4 （when enabled））
Hybi-07 （Firefox 6）
Hybi-10 （Chrome 14-16, Firefox 7）
Hybi-13 （Chrome 17+）

支持使用安全的网络通讯协议（wss://）

启用安全的网络连接需要如下两件事：

1. 使用 " wss " 代替原来的 " ws "；

2..将 Fleck 指定一个包含一个共钥和私钥的 x509 证书；

var server = new WebSocketServer("wss://0.0.0.0:8431");
server.Certificate = new X509Certificate2("MyCert.pfx");
server.Start(socket =>
{
　　//...use as normal
});

子协议协商系统

为了启用子协议协商，在 WebSocketServer.SupportedSubProtocols属性上进行指定声明。协商的子协议将在套接字的 ConnectionInfo.NegotiatedSubProtocol 上可用。如果在客户端请求（在用于 WebSocket 打开阶段握手的头字段 ①）上没有找到支持的子协议，则连接将被关闭。

（译者注：①这个地方我也不是很懂，要是有大神懂欢迎指正！）

var server = new WebSocketServer("ws://0.0.0.0:8181");
server.SupportedSubProtocols = new []{ "superchat", "chat" };
server.Start(socket =>
{
　　//socket.ConnectionInfo.NegotiatedSubProtocol is populated
});

自定义日志系统

Fleck 可以讲日志注入 Log4Net 等的一些第三方的日志系统中。仅仅需要用目标的日志行为方法注入一下 FleckLog.LogAction 属性即可使用。

ILog logger = LogManager.GetLogger(typeof(FleckLog));

FleckLog.LogAction = (level, message, ex) => {
　　switch(level) {
　　　　case LogLevel.Debug:
　　　　　　logger.Debug(message, ex);
　　　　　　break;
　　　　case LogLevel.Error:
　　　　　　logger.Error(message, ex);
　　　　　　break;
　　　　case LogLevel.Warn:
　　　　　　logger.Warn(message, ex);
　　　　　　break;
　　　　default:
　　　　　　logger.Info(message, ex);
　　　　　　break;
　　}
};

禁用Nagle的缓冲器算法

将 WebSocketConnection.ListenerSocket 中的 NoDelay 设置为 true。

var server = new WebSocketServer("ws://0.0.0.0:8181");
server.ListenerSocket.NoDelay = true;
server.Start(socket =>
{
　　//Child connections will not use Nagle\'s Algorithm
});

监听过程中出现错误自动重启

设置 WebSocketConnection 的 RestartAfterListenError 属性为 true。

var server = new WebSocketServer("ws://0.0.0.0:8181");
server.RestartAfterListenError = true;
server.Start(socket =>
{
　　//...use as normal
});

Fleck原文

Buidl Status

Nuget

Fleck is a WebSocket server implementation in C#. Branched from the Nugget project, Fleck requires no inheritance, container, or additional references.

Example

The following is an example that will echo to a client.

var server = new WebSocketServer("ws://0.0.0.0:8181");
server.Start(socket =>
{
　　socket.OnOpen = () => Console.WriteLine("Open!");
　　socket.OnClose = () => Console.WriteLine("Close!");
　　socket.OnMessage = message => socket.Send(message);
});

Supported WebSocket Versions

Fleck supports several WebSocket versions of modern web browsers

Hixie-Draft-76/Hybi-00 (Safari 5, Chrome < 14, Firefox 4 (when enabled))
Hybi-07 (Firefox 6)
Hybi-10 (Chrome 14-16, Firefox 7)
Hybi-13 (Chrome 17+)

Secure WebSockets (wss://)

Enabling secure connections requires two things: using the scheme wss instead of ws, and pointing Fleck to an x509 certificate containing a public and private key

var server = new WebSocketServer("wss://0.0.0.0:8431");
server.Certificate = new X509Certificate2("MyCert.pfx");
server.Start(socket =>
{
　　//...use as normal
});

SubProtocol Negotiation

To enable negotiation of subprotocols, specify the supported protocols on theWebSocketServer.SupportedSubProtocolsproperty. The negotiated subprotocol will be available on the socket\'s ConnectionInfo.NegotiatedSubProtocol.

If no supported subprotocols are found on the client request (the Sec-WebSocket-Protocol header), the connection will be closed.

var server = new WebSocketServer("ws://0.0.0.0:8181");
server.SupportedSubProtocols = new []{ "superchat", "chat" };
server.Start(socket =>
{
　　//socket.ConnectionInfo.NegotiatedSubProtocol is populated
});

Custom Logging

Fleck can log into Log4Net or any other third party logging system. Just override the FleckLog.LogAction property with the desired behavior.

ILog logger = LogManager.GetLogger(typeof(FleckLog));

FleckLog.LogAction = (level, message, ex) => {
　　switch(level) {
　　　　case LogLevel.Debug:
　　　　　　logger.Debug(message, ex);
　　　　　　break;
　　　　case LogLevel.Error:
　　　　　　logger.Error(message, ex);
　　　　　　break;
　　　　case LogLevel.Warn:
　　　　　　logger.Warn(message, ex);
　　　　　　break;
　　　　default:
　　　　　　logger.Info(message, ex);
　　　　　　break;
　　}
};

Disable Nagle\'s Algorithm

Set NoDelay to true on the WebSocketConnection.ListenerSocket

var server = new WebSocketServer("ws://0.0.0.0:8181");
server.ListenerSocket.NoDelay = true;
server.Start(socket =>
{
　　//Child connections will not use Nagle\'s Algorithm
});

Auto Restart After Listen Error

Set RestartAfterListenError to true on the WebSocketConnection

var server = new WebSocketServer("ws://0.0.0.0:8181");
server.RestartAfterListenError = true;
server.Start(socket =>
{
　　//...use as normal
});