2.2 TcpService

说明

TcpService是TCP系服务器基类，但是不参与实际的数据交互，实际的数据交互由SocketClient完成，所以TcpService的功能只是配置、激活、管理、注销、重建SocketClient类实例，所以在TcpService中，须指定其SocketClient派生的泛型类型，然后通过SocketClient实现HandleReceivedData方法，该方法指示如何处理已接收数据或经过适配器转换的对象。

可配置项

支持插件接口客户端、服务器均支持

声明自定义实例类，然后实现ITcpPlugin接口，即可实现下列事务的触发。
或者继承自TcpPluginBase类，重写相应方法即可。

|

ITcpPlugin

非泛型创建TcpService

非泛型创建TcpService时，实际上是使用了默认的SocketClient，此时会将收到的数据从Received事件中直接抛出。创建过程如下：

TcpService service = new TcpService();
service.Connecting += (client, e) => { };//有客户端正在连接
service.Connected += (client, e) => { };//有客户端连接
service.Disconnected += (client, e) => { };//有客户端断开连接
service.Received += (client, byteBlock, requestInfo) =>
{
    //从客户端收到信息
    string mes = Encoding.UTF8.GetString(byteBlock.Buffer, 0, byteBlock.Len);
    Console.WriteLine($"已从{client.ID}接收到信息：{mes}");
    client.Send(mes);//将收到的信息直接返回给发送方
    //client.Send("id",mes);//将收到的信息返回给特定ID的客户端
    var clients = service.GetClients();
    foreach (var targetClient in clients)//将收到的信息返回给在线的所有客户端。
    {
        if (targetClient.ID != client.ID)
        {
            targetClient.Send(mes);
        }
    }
};
service.Setup(new TouchSocketConfig()//载入配置     
    .SetListenIPHosts(new IPHost[] { new IPHost("127.0.0.1:7789"), new IPHost(7790) })//同时监听两个地址
    .SetMaxCount(10000)
    .SetThreadCount(10)
    .ConfigurePlugins(a =>
    {
        //a.Add();//此处可以添加插件
    })
    .ConfigureContainer(a =>
    {
        a.SetSingletonLogger<ConsoleLogger>();//添加一个日志注入
    }))
    .Start();//启动

泛型创建TcpService

通过泛型创建服务器，可以实现很多有意思，且能重写一些有用的功能。下面就演示，如何通过泛型创建服务器。

建立TcpService继承类

public class MyService : TcpService<MySocketClient>
{
    protected override void LoadConfig(TouchSocketConfig config)
    {
        //此处加载配置，用户可以从配置中获取配置项。
        base.LoadConfig(config);
    }
    protected override void OnConnecting(MySocketClient socketClient, ClientOperationEventArgs e)
    {
        //此处逻辑会多线程处理。
        //e.ID:对新连接的客户端进行ID初始化，例如可以设置为其IP地址。
        //e.IsPermitOperation:指示是否允许该客户端链接。
        //对即将连接的客户端做初始化配置
        socketClient.Protocol = new Protocol("MyProtocol");
        base.OnConnecting(socketClient, e);
    }
}

建立SocketClient继承类

public class MySocketClient : SocketClient
{
    protected override void HandleReceivedData(ByteBlock byteBlock, IRequestInfo requestInfo)
    {
        //此处逻辑单线程处理。
        //此处处理数据，功能相当于Received事件。
        string mes = Encoding.UTF8.GetString(byteBlock.Buffer, 0, byteBlock.Len);
        Console.WriteLine($"已接收到信息：{mes}");
    }
}

主要方法简介

发送数据

每个客户端成功连接后，都会创建一个派生自SocketClient的实例，通过该实例即可将数据发送至客户端。

如何获取SocketClient？

（1）直接调用
通过service.GetClients方法，获取当前在线的所有客户端。由于SocketClient的生命周期是由框架控制的，所以最好尽量不要直接引用该实例

SocketClient[] socketClients = service.GetClients();

（2）通过ID获取
先调用service.GetIDs方法，获取当前在线的所有客户端的ID，然后选择需要的ID，通过TryGetSocketClient方法，获取到想要的客户端。

string[] ids = service.GetIDs();
if (service.TryGetSocketClient(ids[0], out SocketClient socketClient))
{
}

同步发送

SocketClient已经内置了三种同步发送方法，直接调用就可以发送，但需要注意的是，通过该方法发送的数据，会经过适配器，如果想要直接发送，请使用DefaultSend。如果发送失败，则会立即抛出异常。

public virtual void Send(byte[] buffer);
public virtual void Send(ByteBlock byteBlock);
public virtual void Send(byte[] buffer, int offset, int length);

调用顺序

1. TcpClient.Send；
   ⇓
2. DataHandlingAdapter.PreviewSend；(进入数据处理适配器)
   ⇓
3. DataHandlingAdapter.GoSend；(通过数据处理适配器封装数据)
   ⇓

4. Socket.Send；(通过Socket发送数据)

   非独立线程异步发送（服务器不允许独立线程发送）

   使用方法
   TcpClient已经内置了三种异步发送方法，直接调用就可以发送。如果发送失败，会触发异常。

   public virtual void SendAsync(byte[] buffer);
   public virtual void SendAsync(ByteBlock byteBlock);
   public virtual void SendAsync(byte[] buffer, int offset, int length);

   调用顺序

5. TcpClient.Send；
   ⇓

6. DataHandlingAdapter.PreviewSend；(进入数据处理适配器)
   ⇓
7. DataHandlingAdapter.GoSend；(通过数据处理适配器封装数据)
   ⇓
8. Socket.SendAsync；(通过Socket IOCP发送数据)

   通过TcpService发送

   通过ID发送数据。

   public virtual void Send(string id, ByteBlock byteBlock);
   public virtual void Send(string id, byte[] buffer, int offset, int length);
   public virtual void Send(string id, byte[] buffer);
   public virtual void SendAsync(string id, ByteBlock byteBlock);
   public virtual void SendAsync(string id, byte[] buffer, int offset, int length);
   public virtual void SendAsync(string id, byte[] buffer);

视频介绍