异步客户端套接字在等待网络操作完成时不挂起应用程序。相反,它使用标准 .NET Framework 异步编程模型在一个线程上处理网络连接,而应用程序继续在原始线程上运行。异步套接字适用于大量使用网络或不能等待网络操作完成才能继续的应用程序。
Socket 类遵循异步方法的 .NET Framework 命名模式;例如,同步 Receive 方法对应异步 BeginReceive 和 EndReceive 方法。
异步操作要求回调方法返回操作结果。如果应用程序不需要知道结果,则不需要任何回调方法。本节中的代码示例阐释如何使用某个方法开始与网络设备的连接并使用回调方法结束连接,如何使用某个方法开始发送数据并使用回调方法完成发送,以及如何使用某个方法开始接收数据并使用回调方法结束接收数据。
异步套接字使用多个系统线程池中的线程处理网络连接。一个线程负责初始化数据的发送或接收;其他线程完成与网络设备的连接并发送或接收数据。在程序源码中,System.Threading.ManualResetEvent 类的实例用于挂起主线程的执行并在执行可以继续时发出信号。
在客户端源码中,为了将异步套接字连接到网络设备,Socket 方法初始化一个 Socket,然后调用 BeginConnect 方法,传递表示网络设备的远程终结点、连接回调方法以及状态对象(即客户端 Socket,用于在异步调用之间传递状态信息)。该示例实现 Connect 方法以将指定的 Socket 连接到指定的终结点。它采用一个名为 connectDone 的全局 ManualResetEvent: public IAsyncResult BeginConnect(
EndPoint remoteEP,
AsyncCallback callback,
object state
);
连接回调方法 ConnectCallback 实现 AsyncCallback 委托。它在远程设备可用时连接到远程设备,然后通过设置 ManualResetEvent connectDone 向应用程序线程发出连接完成的信号。下面的客户端源码中实现了 ConnectCallback 方法。
Send 示例方法以 ASCII 格式对指定的字符串数据进行编码,并将其异步发送到指定的套接字所表示的网络设备。
发送回调方法 SendCallback 实现 AsyncCallback 委托。它在网络设备准备接收时发送数据。下面的源码中实现了 SendCallback 方法。它采用一个名为 sendDone 的全局 ManualResetEvent。
从客户端套接字读取数据需要一个在异步调用之间传递值的状态对象。下面的类是用于从客户端套接字接收数据的示例状态对象。它包含以下各项的字段:客户端套接字,用于接收数据的缓冲区,以及用于保存传入数据字符串的 StringBuilder。将这些字段放在该状态对象中,使这些字段的值在多个调用之间得以保留,以便从客户端套接字读取数据。
public class StateObject {
// Client socket.
public Socket workSocket = null;
// Size of receive buffer.
public const int BufferSize = 256;
// Receive buffer.
public byte[] buffer = new byte[BufferSize];
// Received data string.
public StringBuilder sb = new StringBuilder();
} //为简单起见,客户端源码中并未创建此类
Receive 方法示例设置状态对象,然后调用 BeginReceive 方法从客户端套接字异步读取数据。
接收回调方法 ReceiveCallback 实现 AsyncCallback 委托。它接收来自网络设备的数据并生成消息字符串。它将来自网络的一个或多个数据字节读入数据缓冲区,然后再次调用 BeginReceive 方法,直到客户端发送的数据完成为止。从客户端读取所有数据后,ReceiveCallback 通过设置 ManualResetEvent sendDone 向应用程序线程发出数据完成的信号。
//以下是客户端详细实现代码
using System;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Windows.Forms;
using System.Data;
using System.Net;
using System.Net.Sockets;
using System.Threading;
using System.Text;
namespace 聊天_socket_client
{
/// <summary>
/// Form1 的摘要说明。
/// </summary>
public class Form1 : System.Windows.Forms.Form
{
private System.Windows.Forms.Label label4;
private System.Windows.Forms.Label label3;
private System.Windows.Forms.Label label2;
private System.Windows.Forms.Label label1;
private System.Windows.Forms.Button btnStop;
private System.Windows.Forms.Button btnSend;
private System.Windows.Forms.TextBox txtPort;
private System.Windows.Forms.TextBox txtServer;
private System.Windows.Forms.RichTextBox rtbSend;
private System.Windows.Forms.RichTextBox rtbReceive;
private System.Windows.Forms.StatusBar statusBar1;
private System.Windows.Forms.Button btnConnect;
private IPAddress hostIPAddress;
private IPEndPoint Server;
private Socket sock;
private const int BufferSize=256;
private byte[] buffer=new byte[BufferSize];
private static ManualResetEvent connectDone=new ManualResetEvent(false);
private static ManualResetEvent sendDone=new ManualResetEvent(false);
/// <summary>
/// 必需的设计器变量。
/// </summary>
private System.ComponentModel.Container components = null;
public Form1()
{
//
// Windows 窗体设计器支持所必需的
//
InitializeComponent();
//
// TODO: 在 InitializeComponent 调用后添加任何构造函数代码
//
}
/// <summary>
/// 清理所有正在使用的资源。
/// </summary>
protected override void Dispose( bool disposing )
{
if( disposing )
{
if (components != null)
{
components.Dispose();
}
}
base.Dispose( disposing );
}
#region Windows 窗体设计器生成的代码
/// <summary>
/// 设计器支持所需的方法 - 不要使用代码编辑器修改
/// 此方法的内容。
/// </summary>
private void InitializeComponent()
{
this.label4 = new System.Windows.Forms.Label();
this.label3 = new System.Windows.Forms.Label();
this.label2 = new System.Windows.Forms.Label();
this.label1 = new System.Windows.Forms.Label();
this.btnStop = new System.Windows.Forms.Button();
this.btnSend = new System.Windows.Forms.Button();
this.btnConnect = new System.Windows.Forms.Button();
this.txtPort = new System.Windows.Forms.TextBox();
this.txtServer = new System.Windows.Forms.TextBox();
this.rtbSend = new System.Windows.Forms.RichTextBox();
this.rtbReceive = new System.Windows.Forms.RichTextBox();
this.statusBar1 = new System.Windows.Forms.StatusBar();
this.SuspendLayout();
//
// label4
//
this.label4.Location = new System.Drawing.Point(16, 152);
this.label4.Name = "label4";
this.label4.Size = new System.Drawing.Size(64, 23);
this.label4.TabIndex = 22;
this.label4.Text = "发送信息:";
//
// label3
//
this.label3.Location = new System.Drawing.Point(16, 64);
this.label3.Name = "label3";
this.label3.Size = new System.Drawing.Size(64, 23);
this.label3.TabIndex = 21;
this.label3.Text = "接收信息:";
//
// label2
//
this.label2.Location = new System.Drawing.Point(216, 16);
this.label2.Name = "label2";
this.label2.Size = new System.Drawing.Size(64, 23);
this.label2.TabIndex = 20;
this.label2.Text = "监听端口:";
//
// label1
//
this.label1.Location = new System.Drawing.Point(16, 16);
this.label1.Name = "label1";
this.label1.Size = new System.Drawing.Size(56, 23);
this.label1.TabIndex = 19;
this.label1.Text = "服务器:";
//
// btnStop
//
this.btnStop.Location = new System.Drawing.Point(256, 256);
this.btnStop.Name = "btnStop";
this.btnStop.TabIndex = 18;
this.btnStop.Text = "关闭连接";
this.btnStop.Click += new System.EventHandler(this.btnStop_Click);
//
// btnSend
//
this.btnSend.Location = new System.Drawing.Point(144, 256);
this.btnSend.Name = "btnSend";
this.btnSend.TabIndex = 17;
this.btnSend.Text = "发送信息";
this.btnSend.Click += new System.EventHandler(this.btnSend_Click);
//
// btnConnect
//
this.btnConnect.Location = new System.Drawing.Point(32, 256);
this.btnConnect.Name = "btnConnect";
this.btnConnect.TabIndex = 16;
this.btnConnect.Text = "请求连接";
this.btnConnect.Click += new System.EventHandler(this.btnConnect_Click);
//
// txtPort
//
this.txtPort.Location = new System.Drawing.Point(288, 16);
this.txtPort.Name = "txtPort";
this.txtPort.Size = new System.Drawing.Size(48, 21);
this.txtPort.TabIndex = 15;
this.txtPort.Text = "19811";
//
// txtServer
//
this.txtServer.Location = new System.Drawing.Point(72, 16);
this.txtServer.Name = "txtServer";
this.txtServer.TabIndex = 14;
this.txtServer.Text = "127.0.0.1";
//
// rtbSend
//
this.rtbSend.Location = new System.Drawing.Point(80, 152);
this.rtbSend.Name = "rtbSend";
this.rtbSend.Size = new System.Drawing.Size(264, 96);
this.rtbSend.TabIndex = 13;
this.rtbSend.Text = "";
//
// rtbReceive
//
this.rtbReceive.Location = new System.Drawing.Point(80, 56);
this.rtbReceive.Name = "rtbReceive";
this.rtbReceive.Size = new System.Drawing.Size(264, 96);
this.rtbReceive.TabIndex = 12;
this.rtbReceive.Text = "";
//
// statusBar1
//
this.statusBar1.Location = new System.Drawing.Point(0, 287);
this.statusBar1.Name = "statusBar1";
this.statusBar1.ShowPanels = true;
this.statusBar1.Size = new System.Drawing.Size(360, 22);
this.statusBar1.TabIndex = 23;
this.statusBar1.Text = "statusBar1";
//
// Form1
//
this.AutoScaleBaseSize = new System.Drawing.Size(6, 14);
this.ClientSize = new System.Drawing.Size(360, 309);
this.Controls.Add(this.statusBar1);
this.Controls.Add(this.label4);
this.Controls.Add(this.label3);
this.Controls.Add(this.label2);
this.Controls.Add(this.label1);
this.Controls.Add(this.btnStop);
this.Controls.Add(this.btnSend);
this.Controls.Add(this.btnConnect);
this.Controls.Add(this.txtPort);
this.Controls.Add(this.txtServer);
this.Controls.Add(this.rtbSend);
this.Controls.Add(this.rtbReceive);
this.Name = "Form1";
this.Text = "聊天程序-客户端";
this.Closing += new System.ComponentModel.CancelEventHandler(this.Form1_Closing);
this.ResumeLayout(false);
}
#endregion
/// <summary>
/// 应用程序的主入口点。
/// </summary>
[STAThread]
static void Main()
{
Application.Run(new Form1());
}
private void btnConnect_Click(object sender, System.EventArgs e)
{
try
{
hostIPAddress=IPAddress.Parse(txtServer.Text);
}
catch{MessageBox.Show("请输入正确的IP地址格式。");}
try
{
Server=new IPEndPoint(hostIPAddress,Int32.Parse(txtPort.Text));
sock=new Socket(AddressFamily.InterNetwork,SocketType.Stream,ProtocolType.Tcp);
sock.BeginConnect(Server,new AsyncCallback(ConnectCallBack),sock);
}
catch(Exception ee){MessageBox.Show(ee.Message);}
}
private void ConnectCallBack(IAsyncResult ar)
{
try
{
Socket client=(Socket)ar.AsyncState; //获取状态
client.EndConnect(ar);
try
{
byte[] byteData=Encoding.BigEndianUnicode.GetBytes("准备完毕,可以通话"+"\r\n");
sock.BeginSend(byteData,0,byteData.Length,0,new AsyncCallback(SendCallBack),sock);
}
catch(Exception ee){MessageBox.Show(ee.Message);}
statusBar1.Text="与主机"+txtServer.Text+"端口"+txtPort.Text+"连接成功";
Thread thread=new Thread(new ThreadStart(ThreadProc));
thread.Start(); //开始接收数据线程
connectDone.Set(); //将指定事件的状态设置为终止。
}
catch{}
}
private void SendCallBack(IAsyncResult ar)
{
try{
Socket client=(Socket)ar.AsyncState;
sendDone.Set();
}
catch(Exception ee){MessageBox.Show(ee.Message);}
}
private void ThreadProc()
{
try
{
sock.BeginReceive(buffer,0,BufferSize,0,new AsyncCallback(ReceiveCallBack),sock);
}
catch(Exception ee){MessageBox.Show(ee.Message);}
}
private void ReceiveCallBack(IAsyncResult ar)
{
try
{
Socket client=(Socket)ar.AsyncState;
int bytesRead=client.EndReceive(ar);//结束挂起的异步读取。返回接收到的字节数。
StringBuilder sb=new StringBuilder();
sb.Append(Encoding.BigEndianUnicode.GetString(buffer,0,bytesRead));//储存数据
string content=sb.ToString(); //转换为字符串
sb.Remove(0,content.Length); //清除sb内容
rtbReceive.AppendText(content+"\r\n");
client.BeginReceive(buffer,0,BufferSize,0,new AsyncCallback(ReceiveCallBack),client);
}
catch{}
}
private void btnSend_Click(object sender, System.EventArgs e)
{
try
{
string strSend ="Client--->"+rtbSend.Text+"\r\n";
Byte[] ByteSend = Encoding.BigEndianUnicode.GetBytes(strSend);
sock.BeginSend(ByteSend,0,ByteSend.Length,0,new AsyncCallback(SendCallBack),sock);
}
catch{MessageBox.Show("连接尚未建立,无法发送.");}
}
private void btnStop_Click(object sender, System.EventArgs e)
{
try
{
sock.Close();
statusBar1.Text="与主机"+txtServer.Text+"端口"+txtPort.Text+"断开连接";
}
catch{MessageBox.Show("连接尚未建立,关闭无效");}
}
private void Form1_Closing(object sender, System.ComponentModel.CancelEventArgs e)
{
try
{
sock.Close();
}
catch{}
}
}
}