C#完成端口IOCP：（01）SocketAsyncEventArgs封装

不管是HTTP还是WebSocket，我们在前面文章（HTTP服务器专栏）读写都是同步的，后续我们将独立一个项目出将所有操作改成异步。

我们的程序读写数据都是基于NetworkStream的。
NetworkStream的ReadAsync和WriteAsync本质上是一个使用BeginRead和BeginWrite封装Task的操作，内部还是调用Socket的BeginReceive和BeginSend方法，并没有用到IOCP。
我们的目的是重写NetworkStream，实现IOCP操作。

这篇文章我们先重写SocketAsyncEventArgs，实现ReadAsync和WriteAsync以及SocketAsyncEventArgs的复用。
重写的SocketAsyncEventArgs没有太多逻辑，就是把SocketAsyncEventArgs的事件改成了回调，内部还是调用Socket的对应方法。
尽管事件和委托本质上没太大区别，个人还是不喜欢写一堆+=、-=去操作事件。

0、定义委托

数据读取和写入的回调，没啥好讲的。

/// <summary>
/// 异步读取的委托
/// </summary>
/// <param name="bytesReceived">接收到的字节数</param>
/// <param name="errorCode">错误代码</param>
/// <param name="state">用户状态</param>
public delegate void AsyncReadCallback(int bytesReceived, int errorCode, object state);

/// <summary>
/// 异步写入的委托
/// </summary>
/// <param name="errorCode">错误代码</param>
/// <param name="state">用户状态</param>
public delegate void AsyncWriteCallback(int errorCode, object state);

1、实现ReadAsync和WriteAsync

使用ReadAsync和WriteAsync从基础Socket中读取数据，SetBuffer和UserToken都密封在方法中。

/// <summary>
/// 异步读取数据
/// </summary>
/// <param name="socket">基础Socket</param>
/// <param name="buffer">缓冲区</param>
/// <param name="offset">数据在缓冲区中的索引</param>
/// <param name="size">准备读取的数据大小</param>
/// <param name="callback">回调</param>
/// <param name="state">状态</param>
/// <returns></returns>
public void ReadAsync(Socket socket, byte[] buffer, int offset, int size, AsyncReadCallback callback, object state)
{
    _asyncReadCallback = callback;
    UserToken = state;
    SetBuffer(buffer, offset, size);
    if (!socket.ReceiveAsync(this))
    {
        OnCompleted(this);
    }
}

/// <summary>
/// 异步发送数据
/// </summary>
/// <param name="socket">基础Socket</param>
/// <param name="buffer">缓冲区</param>
/// <param name="offset">数据在缓冲区中的索引</param>
/// <param name="size">准备读取的数据大小</param>
/// <param name="callback">回调</param>
/// <param name="state">状态</param>
/// <returns></returns>
public void WriteAsync(Socket socket, byte[] buffer, int offset, int size, AsyncWriteCallback callback, object state)
{
    _asyncWriteCallback = callback;
    UserToken = state;
    SetBuffer(buffer, offset, size);
    if (!socket.SendAsync(this))
    {
        OnCompleted(this);
    }
}

数据读取和写入操作完成后，调用对应的回调方法。
重写OnCompleted方法来处理回调，如果没有回调继续走OnCompleted的逻辑。

/// <summary>
/// 重写SocketAsyncEventArgs的OnCompleted方法
/// 实现我们自己的逻辑
/// </summary>
/// <param name="e"></param>
protected override void OnCompleted(SocketAsyncEventArgs e)
{
    if(e.LastOperation == SocketAsyncOperation.Receive && _asyncReadCallback != null)
    {
        _asyncReadCallback(e.BytesTransferred, (int)e.SocketError, UserToken);
        return;
    }
    if (e.LastOperation == SocketAsyncOperation.Send && _asyncWriteCallback != null)
    {
        _asyncWriteCallback((int)e.SocketError, UserToken);
        return;
    }
    base.OnCompleted(e);
}

2、SocketAsyncEventArgs复用

使用了线程安全的ConcurrentStack来保存TcpSocketAsyncEventArgs。

private static ConcurrentStack<TcpSocketAsyncEventArgs> _stacks = new ConcurrentStack<TcpSocketAsyncEventArgs>();
/// <summary>
/// 从栈中获取一个TcpSocketAsyncEventArgs实例
/// 对TcpSocketAsyncEventArgs实例的重复使用
/// </summary>
/// <returns></returns>
public static TcpSocketAsyncEventArgs Pop()
{
    if (_stacks.TryPop(out TcpSocketAsyncEventArgs e)) return e;

    return new TcpSocketAsyncEventArgs();
}

/// <summary>
/// 将TcpSocketAsyncEventArgs实例清理下，放入栈中
/// </summary>
/// <param name="e"></param>
public static void Push(TcpSocketAsyncEventArgs e)
{
    e._asyncReadCallback = null;
    e._asyncWriteCallback = null;
    e.SetBuffer(null, 0, 0);
    e.UserToken = null;
    _stacks.Push(e);
}

3、总结

本文章看起来更多是为了实现IOCP而IOCP的，我们目前主要用于学习，暂且不纠结这些问题。
下篇文章基于我们封装的TcpSocketAsyncEventArgs实现NetworkStream的IOCP操作。