HslProtocol (com.github.dathlin:HslCommunication 3.4.0 API)

java.lang.Object
- HslCommunication.Core.Net.HslProtocol

```
public class HslProtocol
extends Object
```

字段概要

字段
限定符和类型	字段和说明
`static int`	`HeadByteLength` 规定所有的网络传输的指令头长度
`static int`	`ProtocolAccountLogin` 客户端登录的暗号信息
`static int`	`ProtocolAccountRejectLogin` 客户端拒绝登录的暗号信息
`static int`	`ProtocolBufferSize` 所有网络通信中的缓冲池的数据信息
`static int`	`ProtocolCheckSecends` 用于心跳程序的暗号信息
`static int`	`ProtocolClientAllowLogin` 允许客户端登录到服务器
`static int`	`ProtocolClientQuit` 客户端退出的消息
`static int`	`ProtocolClientRefuseLogin` 因为客户端达到上限而拒绝登录
`static int`	`ProtocolErrorMsg` 返回的错误信息
`static int`	`ProtocolFileCheckError` 文件校验失败
`static int`	`ProtocolFileCheckRight` 文件校验成功
`static int`	`ProtocolFileDelete` 请求删除文件的暗号
`static int`	`ProtocolFileDirectories` 请求子文件的列表暗号
`static int`	`ProtocolFileDirectoryFiles` 请求文件的列表的暗号
`static int`	`ProtocolFileDownload` 请求文件下载的暗号
`static int`	`ProtocolFileSaveError` 文件保存失败
`static int`	`ProtocolFileUpload` 请求文件上传的暗号
`static int`	`ProtocolNoZipped` 不压缩字节数据
`static int`	`ProtocolProgressReport` 进度返回暗号
`static int`	`ProtocolUserBitmap` 发送的数据是普通的图片数据
`static int`	`ProtocolUserBytes` 说明发送的信息是字节数组数据
`static int`	`ProtocolUserException` 发送的数据是一条异常的数据，字符串为异常消息
`static int`	`ProtocolUserString` 说明发送的信息是文本数据
`static int`	`ProtocolUserStringArray` 说明发送的数据是字符串的数组
`static int`	`ProtocolZipped` 压缩字节数据

构造器概要

构造器
构造器和说明

HslProtocol()

构造器
构造器和说明
`HslProtocol()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static byte[]`	`CommandAnalysis(byte[] head, byte[] content)` 解析接收到数据，先解压缩后进行解密
`static byte[]`	`CommandBytes(int command, int customer, UUID token, byte[] data)` 生成终极传送指令的方法，所有的数据均通过该方法出来
`static byte[]`	`CommandBytes(int customer, UUID token, byte[] data)` 获取发送字节数据的实际数据，带指令头
`static byte[]`	`CommandBytes(int customer, UUID token, String data)` 获取发送字节数据的实际数据，带指令头
`static byte[]`	`CommandBytes(int customer, UUID token, String[] data)` 获取发送字节数据的实际数据，带指令头
`static OperateResultExTwo<NetHandle,byte[]>`	`ExtractHslData(byte[] content)` 从接收的数据内容提取出用户的暗号和数据内容
`static byte[]`	`PackStringArrayToByte(String[] data)` 将字符串打包成字节数组内容
`static String[]`	`UnPackStringArrayFromByte(byte[] content)` 将字节数组还原成真实的字符串数组

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - HeadByteLength
```
public static final int HeadByteLength
```
    规定所有的网络传输的指令头长度
    
    另请参阅:
    
    常量字段值
  - ProtocolBufferSize
```
public static final int ProtocolBufferSize
```
    所有网络通信中的缓冲池的数据信息
    
    另请参阅:
    
    常量字段值
  - ProtocolCheckSecends
```
public static final int ProtocolCheckSecends
```
    用于心跳程序的暗号信息
    
    另请参阅:
    
    常量字段值
  - ProtocolClientQuit
```
public static final int ProtocolClientQuit
```
    客户端退出的消息
    
    另请参阅:
    
    常量字段值
  - ProtocolClientRefuseLogin
```
public static final int ProtocolClientRefuseLogin
```
    因为客户端达到上限而拒绝登录
    
    另请参阅:
    
    常量字段值
  - ProtocolClientAllowLogin
```
public static final int ProtocolClientAllowLogin
```
    允许客户端登录到服务器
    
    另请参阅:
    
    常量字段值
  - ProtocolAccountLogin
```
public static final int ProtocolAccountLogin
```
    客户端登录的暗号信息
    
    另请参阅:
    
    常量字段值
  - ProtocolAccountRejectLogin
```
public static final int ProtocolAccountRejectLogin
```
    客户端拒绝登录的暗号信息
    
    另请参阅:
    
    常量字段值
  - ProtocolUserString
```
public static final int ProtocolUserString
```
    说明发送的信息是文本数据
    
    另请参阅:
    
    常量字段值
  - ProtocolUserBytes
```
public static final int ProtocolUserBytes
```
    说明发送的信息是字节数组数据
    
    另请参阅:
    
    常量字段值
  - ProtocolUserBitmap
```
public static final int ProtocolUserBitmap
```
    发送的数据是普通的图片数据
    
    另请参阅:
    
    常量字段值
  - ProtocolUserException
```
public static final int ProtocolUserException
```
    发送的数据是一条异常的数据，字符串为异常消息
    
    另请参阅:
    
    常量字段值
  - ProtocolUserStringArray
```
public static final int ProtocolUserStringArray
```
    说明发送的数据是字符串的数组
    
    另请参阅:
    
    常量字段值
  - ProtocolFileDownload
```
public static final int ProtocolFileDownload
```
    请求文件下载的暗号
    
    另请参阅:
    
    常量字段值
  - ProtocolFileUpload
```
public static final int ProtocolFileUpload
```
    请求文件上传的暗号
    
    另请参阅:
    
    常量字段值
  - ProtocolFileDelete
```
public static final int ProtocolFileDelete
```
    请求删除文件的暗号
    
    另请参阅:
    
    常量字段值
  - ProtocolFileCheckRight
```
public static final int ProtocolFileCheckRight
```
    文件校验成功
    
    另请参阅:
    
    常量字段值
  - ProtocolFileCheckError
```
public static final int ProtocolFileCheckError
```
    文件校验失败
    
    另请参阅:
    
    常量字段值
  - ProtocolFileSaveError
```
public static final int ProtocolFileSaveError
```
    文件保存失败
    
    另请参阅:
    
    常量字段值
  - ProtocolFileDirectoryFiles
```
public static final int ProtocolFileDirectoryFiles
```
    请求文件的列表的暗号
    
    另请参阅:
    
    常量字段值
  - ProtocolFileDirectories
```
public static final int ProtocolFileDirectories
```
    请求子文件的列表暗号
    
    另请参阅:
    
    常量字段值
  - ProtocolProgressReport
```
public static final int ProtocolProgressReport
```
    进度返回暗号
    
    另请参阅:
    
    常量字段值
  - ProtocolErrorMsg
```
public static final int ProtocolErrorMsg
```
    返回的错误信息
    
    另请参阅:
    
    常量字段值
  - ProtocolNoZipped
```
public static final int ProtocolNoZipped
```
    不压缩字节数据
    
    另请参阅:
    
    常量字段值
  - ProtocolZipped
```
public static final int ProtocolZipped
```
    压缩字节数据
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - HslProtocol
```
public HslProtocol()
```
- 方法详细资料
  - CommandBytes
```
public static byte[] CommandBytes(int command,
                                  int customer,
                                  UUID token,
                                  byte[] data)
```
    生成终极传送指令的方法，所有的数据均通过该方法出来
    
    参数:
    
    command - 命令头
    
    customer - 自用自定义
    
    token - 令牌
    
    data - 字节数据
    
    返回:
    
    发送的消息数据
  - CommandAnalysis
```
public static byte[] CommandAnalysis(byte[] head,
                                     byte[] content)
```
    解析接收到数据，先解压缩后进行解密
    
    参数:
    
    head - 指令头
    
    content - 内容字节
    
    返回:
    
    真实的数据内容
  - CommandBytes
```
public static byte[] CommandBytes(int customer,
                                  UUID token,
                                  byte[] data)
```
    获取发送字节数据的实际数据，带指令头
    
    参数:
    
    customer - 用户数据
    
    token - 令牌
    
    data - 字节数据
    
    返回:
    
    包装后的指令信息
  - CommandBytes
```
public static byte[] CommandBytes(int customer,
                                  UUID token,
                                  String data)
```
    获取发送字节数据的实际数据，带指令头
    
    参数:
    
    customer - 用户数据
    
    token - 令牌
    
    data - 字符串数据信息
    
    返回:
    
    包装后的指令信息
  - CommandBytes
```
public static byte[] CommandBytes(int customer,
                                  UUID token,
                                  String[] data)
```
    获取发送字节数据的实际数据，带指令头
    
    参数:
    
    customer - 用户数据
    
    token - 令牌
    
    data - 字符串数据信息
    
    返回:
    
    包装后的指令信息
  - PackStringArrayToByte
```
public static byte[] PackStringArrayToByte(String[] data)
```
    将字符串打包成字节数组内容
    
    参数:
    
    data - 字符串数组
    
    返回:
    
    打包后的原始数据内容
  - UnPackStringArrayFromByte
```
public static String[] UnPackStringArrayFromByte(byte[] content)
```
    将字节数组还原成真实的字符串数组
    
    参数:
    
    content - 原始字节数组
    
    返回:
    
    解析后的字符串内容
  - ExtractHslData
```
public static OperateResultExTwo<NetHandle,byte[]> ExtractHslData(byte[] content)
```
    从接收的数据内容提取出用户的暗号和数据内容
    
    参数:
    
    content - 数据内容
    
    返回:
    
    包含结果对象的信息

类 HslProtocol

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

HeadByteLength

ProtocolBufferSize

ProtocolCheckSecends

ProtocolClientQuit

ProtocolClientRefuseLogin

ProtocolClientAllowLogin

ProtocolAccountLogin

ProtocolAccountRejectLogin

ProtocolUserString

ProtocolUserBytes

ProtocolUserBitmap

ProtocolUserException

ProtocolUserStringArray

ProtocolFileDownload

ProtocolFileUpload

ProtocolFileDelete

ProtocolFileCheckRight

ProtocolFileCheckError

ProtocolFileSaveError

ProtocolFileDirectoryFiles

ProtocolFileDirectories

ProtocolProgressReport

ProtocolErrorMsg

ProtocolNoZipped

ProtocolZipped

构造器详细资料

HslProtocol

方法详细资料

CommandBytes

CommandAnalysis

CommandBytes

CommandBytes

CommandBytes

PackStringArrayToByte

UnPackStringArrayFromByte

ExtractHslData