supersockets接收过滤器(ReceiveFilter)

接收过滤器(ReceiveFilter)用于将接收到的二进制数据转化成请求实例(RequestInfo)。

实现一个接收过滤器(ReceiveFilter), 你需要实现接口 IReceiveFilter：

public interface IReceiveFilter<TRequestInfo>

where TRequestInfo : IRequestInfo

{

/// <summary>

/// Filters received data of the specific session into request info.

/// </summary>

/// <param name="readBuffer">待读取的缓冲数据.</param>

/// <param name="offset">这个待读取缓冲中当前接收数据的偏移量</param>

/// <param name="length">当前接收数据的长度</param>

/// <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>

/// <param name="rest">没有被解析的数据的长度</param>

/// <returns></returns>

TRequestInfo Filter(byte[] readBuffer, int offset, int length, bool toBeCopied, out int rest);

/// <summary>

/// Gets the size of the left buffer.

/// </summary>

/// <value>

/// 接收过滤器已缓存数据的长度

/// </value>

int LeftBufferSize { get; }

/// <summary>

/// Gets the next receive filter.

/// </summary>

IReceiveFilter<TRequestInfo> NextReceiveFilter { get; }

/// <summary>

/// Resets this instance to initial state.重置这个实例到初始化状态

/// </summary>

void Reset();

}

TRequestInfo: 类型参数 "TRequestInfo" 是你要在程序中使用的请求类型(RequestInfo);

LeftBufferSize: 该接收过滤器已缓存数据的长度;

NextReceiveFilter: 当下一块数据收到时，用于处理数据的接收过滤器实例;

Reset(): 重设接收过滤器实例到初始状态;

Filter(....): 该方法将会在 SuperSocket 收到一块二进制数据时被执行，接收到的数据在 readBuffer 中从 offset 开始， 长度为 length 的部分。

TRequestInfo Filter(byte[] readBuffer, int offset, int length, bool toBeCopied, out int rest);

readBuffer: 接收缓冲区, 接收到的数据存放在此数组里

offset: 接收到的数据在接收缓冲区的起始位置

length: 本轮接收到的数据的长度

toBeCopied: 表示当你想缓存接收到的数据时，是否需要为接收到的数据重新创建一个备份而不是直接使用接收缓冲区

rest: 这是一个输出参数, 它应该被设置为当解析到一个为正的请求后，接收缓冲区还剩余多少数据未被解析

这儿有很多种情况需要你处理:

当你在接收缓冲区中找到一条完整的请求时，你必须返回一个你的请求类型的实例.

当你在接收缓冲区中没有找到一个完整的请求时, 你需要返回 NULL.

当你在接收缓冲区中找到一条完整的请求, 但接收到的数据并不仅仅包含一个请求时，设置剩余数据的长度到输出变量 "rest". SuperSocket 将会检查这个输出参数 "rest", 如果它大于 0, 此 Filter 方法 将会被再次执行, 参数 "offset" 和 "length" 会被调整为合适的值.