MqttSyncClient 类

public class MqttSyncClient : TcpNetCommunication

Public Class MqttSyncClient
	Inherits TcpNetCommunication

public ref class MqttSyncClient : public TcpNetCommunication

type MqttSyncClient =  
    class
        inherit TcpNetCommunication
    end

// 简单的实例化例子
MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
} );

// 如果有密码的情况
MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                                            // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",                                     // 服务器的地址
    Credentials = new MqttCredential( "admin", "123456" )        // 设置了用户名和密码
} );

// 连接服务器
MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
} );
HslCommunication.OperateResult connect = mqttSyncClient.ConnectServer( );
if (connect.IsSuccess)
{
    // 连接成功
}
else
{
    // 连接失败，过会就需要重新连接了
}

// 关闭的话
mqttSyncClient.ConnectClose( );

MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
} );

// 设置长连接
// mqttSyncClient.SetPersistentConnection( );

// 读取服务器的数据示例
HslCommunication.OperateResult<string, byte[]> read = mqttSyncClient.Read( topic: "A", payload: Encoding.UTF8.GetBytes( "测试数据" ) );
if (read.IsSuccess)
{
    // 读取成功
    string topic = read.Content1;
    byte[] payload = read.Content2;
}
else
{
    // 读取失败
}

// 你只需要负责不停的读取就好了，单次读取数据限制为200多M，如果网络异常，会自动重新连接的。
// 如果你的服务器都是按照字符串来处理的话，那么客户端可以简便代码，客户端默认采用UTF8编码，当然也可以自己指定
HslCommunication.OperateResult<string, string> read2 = mqttSyncClient.ReadString( "A", "测试数据" );
if (read2.IsSuccess)
{
    // 读取成功
    string topic = read2.Content1;
    string payload = read2.Content2;
}
else
{
    // 读取失败
}

MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
} );

// 设置长连接
// mqttSyncClient.SetPersistentConnection( );

// 读取服务器的时候进行进度报告，主要分为上传进度和下载进度，此处就简单的显示下而已
Action<long, long> uploadProgress = new Action<long, long>( ( already, total ) =>
 {
     Console.WriteLine( $"已发送：{(already * 100 / total)}%    已发送/总字节：{already}/{total}" );
 } );
Action<long, long> downloadProgress = new Action<long, long>( ( already, total ) =>
{
    Console.WriteLine( $"已下载：{(already * 100 / total)}%    已下载/总字节：{already}/{total}" );
} );
HslCommunication.OperateResult<string, byte[]> read = mqttSyncClient.Read( topic: "A", payload: Encoding.UTF8.GetBytes( "测试数据" ), uploadProgress, null, downloadProgress );
if (read.IsSuccess)
{
    // 读取成功
    string topic = read.Content1;
    byte[] payload = read.Content2;
}
else
{
    // 读取失败
}

// 你只需要负责不停的读取就好了，单次读取数据限制为200多M，如果网络异常，会自动重新连接的。

// 还有一种更复杂的情况，需要配合服务器侧来完成，现在假设一种情况，客户端向服务器发送一个命令，
// 然后服务器执行相关的操作，这个操作分为5个小操作，时间1-5秒不等，然后处理好后将结果发送给客户端
Action<string, string> handleProgress = new Action<string, string>( ( topic, msg ) =>
{
    // topic服务器可以存放处理进度
    Console.WriteLine( $"已完成：{topic}%    当前正在执行：{msg}" );
} );
HslCommunication.OperateResult<string, byte[]> read2 = mqttSyncClient.Read( topic: "B", payload: Encoding.UTF8.GetBytes( "测试数据" ), null, handleProgress, null );
if (read2.IsSuccess)
{
    // 读取成功
    string topic = read.Content1;
    byte[] payload = read.Content2;
}
else
{
    // 读取失败
}

MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
} );

// 设置长连接
// mqttSyncClient.SetPersistentConnection( );

// 最原始的读取，假设服务器注册了一个PLC的读写接口
OperateResult<string, string> read1 = mqttSyncClient.ReadString( "MainPLC/ReadBool", "{ \"address\": \"M300.1\" }" );
if (read1.IsSuccess)
{
    // read1.Content2 就是内容，bool值的json格式，true/false
}

// 下面是精简的读法
OperateResult<bool> read2 = mqttSyncClient.ReadRpc<bool>( "MainPLC/ReadBool", new { address = "M300.1" } );
if (read2.IsSuccess)
{
    // read2.Content 就是值，自动转换好bool值
}

// 读取的类型和服务器注册RPC接口的返回类型需要一致

MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
} );

// 设置长连接
// mqttSyncClient.SetPersistentConnection( );

// 读取服务器的已经注册的API信息列表，将返回API的主题路径，注释信息，示例的传入的数据信息。
OperateResult<MqttRpcApiInfo[]> read1 = mqttSyncClient.ReadRpcApis( );
if (read1.IsSuccess)
{
    foreach (MqttRpcApiInfo rpcInfo in read1.Content)
    {
        Console.WriteLine( "Api: " + rpcInfo.ApiTopic );
        Console.WriteLine( "Description: " + rpcInfo.Description );
        Console.WriteLine( "" );
    }
}

// 使用完之后
mqttSyncClient.ConnectClose( );

MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
    UseRSAProvider = true,                // 使用加密访问，上下传文件时也通用适用加密
} );

// 设置长连接
// mqttSyncClient.SetPersistentConnection( );

OperateResult<bool> read2 = mqttSyncClient.ReadRpc<bool>( "MainPLC/ReadBool", new { address = "M300.1" } );
if (read2.IsSuccess)
{
    // read2.Content 就是值，自动转换好bool值
}

// 使用完之后
mqttSyncClient.ConnectClose( );

MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
} );

// 下载文件的进度报告，此处就简单的打印出来而已
Action<long, long> downloadProgress = new Action<long, long>( ( already, total ) =>
{
    Console.WriteLine( $"已下载：{already * 100 / total}%    已下载/总字节：{already}/{total}" );
} );

// 此处演示下载服务器的一个文件，需要这个文件在服务器存在，并且，账户密码，文件操作在服务器验证通过，最终才会下载成功
// groups 参数是文件的分类目录信息，同一目录不允许存在同名文件
HslCommunication.OperateResult download = mqttSyncClient.DownloadFile( "Files/Group/Admin", "123.txt", downloadProgress, "D:\\123.txt" );
if (download.IsSuccess)
{
    // 下载成功，在D盘目录查看
}
else
{
    // 下载失败
    Console.WriteLine( "Download failed, reason:" + download.Message );
}

// mqttSyncClient 即为通信对象

private HslCancelToken downloadCacel = null;

private async void button_download_Click( object sender, EventArgs e )
{
    // 点击开始下载，此处按照实际项目需求放到了后台线程处理，事实上这种耗时的操作就应该放到后台线程
    // click this button to start a backgroud thread for downloading file
    downloadCacel = new HslCancelToken( );
    await DownloadFileExample( );
    downloadCacel = null;
}

/*************************************************************************************************
 * 
 *   一条指令即可完成文件的下载操作，下载模式有三种
 *   1. 指定需要下载的文件名（带后缀）
 *   2. 将服务器上的数据下载到流（stream）中
 *   3. 将服务器上的数据下载到bitmap图片中
 * 
 ********************************************************************************************/

private async Task DownloadFileExample( )
{
    progressBar2.Value = 0;                                       // 下载的进度条复位
    button_download.Enabled = false;                              // 下载按钮禁止，打开取消下载按钮
    button_download_cancel.Enabled = true;
    label15.Text = "Start downloading...";

    string fileName = textBox_download_fileName.Text;
    DateTime downloadStartTime = DateTime.Now;
    OperateResult result = await mqttSyncClient.DownloadFileAsync(
            textBox5.Text,                                         // 类别信息，例如 Files/Personal/Admin
            fileName,                                              // 文件在服务器上保存的名称，举例123.txt
            DownloadReportProgress,                                // 文件下载的时候的进度报告，友好的提示下载进度信息
            Application.StartupPath + @"\Files\" + fileName,       // 下载后在文本保存的路径，也可以直接下载到 MemoryStream 的数据流中，或是bitmap中，或是手动选择存储路径
            downloadCacel                                          // 取消下载操作的令牌，如果不需要取消，使用NULL即可
            );

    button_download.Enabled = true;
    button_download_cancel.Enabled = false;
    if (result.IsSuccess)
    {
        // message: file download success
        label15.Text = "文件下载成功！耗时：" + (DateTime.Now - downloadStartTime).TotalSeconds.ToString( "F1" ) + " 秒";
    }
    else
    {
        // 失败原因多半来自网络异常，还有文件不存在，分类名称填写异常
        // mostly failed by network exception, like offline, and file not exsist,
        label15.Text = "文件下载失败：" + result.Message;
    }
}

// 点击下载取消的按钮，取消的令牌设置为 True
private void button_download_cancel_Click( object sender, EventArgs e )
{
    if (downloadCacel != null) downloadCacel.IsCancelled = true;
}

/// <summary>
/// 用于更新文件下载进度的方法，该方法是线程安全的，主要作用是将下载文件的进度在进度条上显示
/// </summary>
/// <param name="receive">已经接收的字节数</param>
/// <param name="totle">总字节数</param>
private void DownloadReportProgress( long receive, long totle )
{
    if (progressBar2.InvokeRequired)
    {
        progressBar2.Invoke( new Action<long, long>( DownloadReportProgress ), receive, totle );
        return;
    }

    // 此处代码是线程安全的
    // thread-safe code
    int value = (int)(receive * 100L / totle);
    progressBar2.Value = value;
    label9.Text = SoftBasic.GetSizeDescription( receive ) + "/" + SoftBasic.GetSizeDescription( totle );
}

MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
} );

// 下载文件的进度报告，此处就简单的打印出来而已
Action<long, long> uploadProgress = new Action<long, long>( ( already, total ) =>
{
    Console.WriteLine( $"已上传：{already * 100 / total}%    已下载/总字节：{already}/{total}" );
} );

// 此处演示上传服务器的一个文件，需要这个文件在本地存在，并且，账户密码，文件操作在服务器验证通过，最终才会上传成功
// groups 参数是文件的分类目录信息，同一目录不允许存在同名文件
HslCommunication.OperateResult upload = mqttSyncClient.UploadFile( "D:\\123.txt", "Files/Group/Admin", "这是一个文件的注释，可由可无", uploadProgress );
if (upload.IsSuccess)
{
    // 上传成功，就可以下载了
}
else
{
    // 下载失败
    Console.WriteLine( "Upload failed, reason:" + upload.Message );
}

/*************************************************************************************************
 * 
 *   一条指令即可完成文件的上传操作，上传模式有三种
 *   1. 指定本地的完整路径的文件名
 *   2. 将流（stream）中的数据上传到服务器
 *   3. 将bitmap图片数据上传到服务器
 * 
 ********************************************************************************************/

// 取消上传的令牌
private HslCancelToken uploadCacel = null;
// mqttSyncClient 即为通信对象

private async void button_upload_Click( object sender, EventArgs e )
{
    // 开始上传
    uploadCacel = new HslCancelToken( );
    if (!string.IsNullOrEmpty( textBox3.Text ))
    {
        if (!System.IO.File.Exists( textBox3.Text ))
        {
            MessageBox.Show( "选择的文件不存在，退出！" );
            return;
        }

        DateTime uploadStartTime = DateTime.Now;
        OperateResult result = await UploadFlieExample( string.Empty );

        if (result.IsSuccess)
        {
            // file upload success
            MessageBox.Show( "文件上传成功！耗时：" + (DateTime.Now - uploadStartTime).TotalSeconds.ToString( "F1" ) + " 秒" );
        }
        else
        {
            // 失败原因多半来自网络异常，还有文件不存在，分类名称填写异常
            // mostly failed by network exception, like offline
            MessageBox.Show( "文件上传失败：" + result.ToMessageShowString( ) );
        }
    }
    else
    {
        MessageBox.Show( "Please Select a File" );
    }
    uploadCacel = null;
}

private async Task<OperateResult> UploadFlieExample( string group )
{
    button_upload.Enabled = false;             // 上传按钮禁用，取消上传按钮使能
    button_upload_cancel.Enabled = true;
    string fileName = textBox3.Text;           // 等待上传的完整文件路径
    System.IO.FileInfo fileInfo = new System.IO.FileInfo( fileName );

    group = string.IsNullOrEmpty( group ) ? textBox_upload_group.Text : group;
    // 开始正式上传，关于三级分类，下面只是举个例子，上传成功后去服务器端寻找文件就能明白
    // start to upload file to server , u shold specify the catgray about the file
    OperateResult result = await mqttSyncClient.UploadFileAsync(
        fileName,                       // 需要上传的原文件的完整路径，上传成功还需要个条件，该文件不能被占用
        group,                          // 类别信息，例如 Files/Personal/Admin
        fileInfo.Name,                  // 在服务器存储的文件名，带后缀，一般设置为原文件的文件名，当然您也可以重新设置名字
        textBox_upload_tag.Text,        // 这个文件的额外描述文本，可以为空（""）
        UpdateReportProgress,           // 文件上传时的进度报告，如果你不需要，指定为NULL就行，一般文件比较大，带宽比较小，都需要进度提示
        uploadCacel                     // 用于取消的令牌，不需要取消的话，传NULL即可
        );
    button_upload.Enabled = true;
    button_upload_cancel.Enabled = false;
    return result;
}

// 点击取消上传按钮
private void button_upload_cancel_Click( object sender, EventArgs e )
{
    if (uploadCacel != null) uploadCacel.IsCancelled = true;
}

/// <summary>
/// 用于更新上传进度的方法，该方法是线程安全的
/// </summary>
/// <param name="sended">已经上传的字节数</param>
/// <param name="totle">总字节数</param>
private void UpdateReportProgress( long sended, long totle )
{
    if (progressBar1.InvokeRequired)
    {
        progressBar1.Invoke( new Action<long, long>( UpdateReportProgress ), sended, totle );
        return;
    }


    // 此处代码是安全的
    // thread-safe code
    int value = (int)(sended * 100L / totle);

    label10.Text = SoftBasic.GetSizeDescription( sended ) + "/" + SoftBasic.GetSizeDescription( totle );
    progressBar1.Value = value;
}

MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
} );

// 此处演示删除服务器的一个文件，需要这个文件在服务器存在，并且，账户密码，文件操作在服务器验证通过，最终才会删除成功
HslCommunication.OperateResult delete = mqttSyncClient.DeleteFile( "Files/Group/Admin", "D:\\123.txt" );
if (delete.IsSuccess)
{
    // 删除成功
}
else
{
    // 删除失败
    Console.WriteLine( "delete failed, reason:" + delete.Message );
}

MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
} );

// 此处演示遍历目录文件集合
HslCommunication.OperateResult<HslCommunication.Core.GroupFileItem[]> files = mqttSyncClient.DownloadPathFileNames( "Files/Group/Admin" );
if (files.IsSuccess)
{
    foreach (var item in files.Content)
    {
        Console.WriteLine( "文件名：" + item.FileName );
        Console.WriteLine( "下载次数：" + item.DownloadTimes );
        Console.WriteLine( "文件大小：" + item.FileSize );
        Console.WriteLine( "上传人：" + item.Owner );
        Console.WriteLine( "上传时间：" + item.UploadTime );
        Console.WriteLine( "文件描述：" + item.Description );
        Console.WriteLine( );
    }
}
else
{
    // 遍历失败
    Console.WriteLine( "read failed, reason:" + files.Message );
}

MqttSyncClient mqttSyncClient = new MqttSyncClient( new MqttConnectionOptions( )
{
    ClientId = "ABC",                     // 客户端的唯一的ID信息
    IpAddress = "127.0.0.1",              // 服务器的地址
} );

// 此处演示遍历目录的子目录
HslCommunication.OperateResult<string[]> files = mqttSyncClient.DownloadPathFolders( "Files" );
if (files.IsSuccess)
{
    foreach (var item in files.Content)
    {
        Console.WriteLine( "目录：" + item );
    }
}
else
{
    // 遍历失败
    Console.WriteLine( "read failed, reason:" + files.Message );
}