Skip to content

Commit 04902bf

Browse files
author
Deng
committed
update readme
1 parent 53e2e01 commit 04902bf

2 files changed

Lines changed: 18 additions & 18 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ dependencies {
126126
```java
127127
/**
128128
* 根据连接双方协议设置自动发送的包尾数据
129-
* 每次发送数据包（包括心跳包）都会在发送包内容前自动发送此包尾
129+
* 每次发送数据包（包括心跳包）都会在发送包内容后自动发送此包尾
130130
*
131131
* 例：socketClient.sendData(new byte[]{0x01, 0x02})的步骤为
132132
* 1. socketClient向远程端发送包头（如果设置了包头信息）
@@ -189,7 +189,7 @@ dependencies {
189189

190190
/**
191191
* 根据连接双方协议设置的包头数据
192-
* 每次接收数据包（包括心跳包）都会在先接收此包头
192+
* 每次接收数据包（包括心跳包）都会先接收此包头
193193
*
194194
* 若无需包头可删除此行
195195
*/
@@ -209,7 +209,7 @@ dependencies {
209209
```java
210210
/**
211211
* 设置包长度转换器
212-
* 即每次发送数据时，将包头以外的数据长度转换为特定的byte[]发送个远程端用于解析还需要读取多少长度的数据
212+
* 即每次发送数据时，将包头以外的数据长度转换为特定的byte[]发送到远程端用于解析还需要读取多少长度的数据
213213
*
214214
* 例：socketClient.sendData(new byte[]{0x01, 0x02})的步骤为
215215
* 1. socketClient向远程端发送包头（如果设置了包头信息）
@@ -248,7 +248,7 @@ dependencies {
248248

249249
/**
250250
* 根据连接双方协议设置自动发送的包尾数据
251-
* 每次发送数据包（包括心跳包）都会在发送包内容前自动发送此包尾
251+
* 每次发送数据包（包括心跳包）都会在发送包内容后自动发送此包尾
252252
*
253253
* 若无需包尾可删除此行
254254
* 注意：
@@ -314,18 +314,18 @@ dependencies {
314314

315315
/**
316316
* 根据连接双方协议设置的包头数据
317-
* 每次接收数据包（包括心跳包）都会在先接收此包头
317+
* 每次接收数据包（包括心跳包）都会先接收此包头
318318
*
319319
* 若无需包头可删除此行
320320
*/
321321
socketClient.getSocketPacketHelper().setReceiveHeaderData(CharsetUtil.stringToData("SocketClient:", CharsetUtil.UTF_8));
322322

323323
/**
324324
* 根据连接双方协议设置的包尾数据
325-
* 每次接收数据包（包括心跳包）都会在检测接收到与包尾数据相同的byte[]时回调一个数据包
326325
*
327-
* 使用{@link com.vilyever.socketclient.helper.SocketPacketHelper.ReadStrategy.AutoReadToTrailer}必须设置此项
328-
* 用于分隔多条消息
326+
* 若无需包尾可删除此行
327+
* 注意：
328+
* 使用{@link com.vilyever.socketclient.helper.SocketPacketHelper.ReadStrategy.AutoReadByLength}时不依赖包尾读取数据
329329
*/
330330
socketClient.getSocketPacketHelper().setReceiveTrailerData(new byte[]{0x13, 0x10});
331331

‎app/src/main/java/com/vilyever/androidsocketclient/TestClient.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ public boolean isReceiveHeartBeatPacket(SocketHeartBeatHelper helper, SocketResp
246246
private void __i__setupReadToTrailerForSender(SocketClient socketClient) {
247247
/**
248248
* 根据连接双方协议设置自动发送的包尾数据
249-
* 每次发送数据包（包括心跳包）都会在发送包内容前自动发送此包尾
249+
* 每次发送数据包（包括心跳包）都会在发送包内容后自动发送此包尾
250250
*
251251
* 例：socketClient.sendData(new byte[]{0x01, 0x02})的步骤为
252252
* 1. socketClient向远程端发送包头（如果设置了包头信息）
@@ -269,7 +269,7 @@ private void __i__setupReadToTrailerForSender(SocketClient socketClient) {
269269
/**
270270
* 设置分段发送数据长度
271271
* 即在发送指定长度后通过 {@link SocketClientSendingDelegate#onSendingPacketInProgress(SocketClient, SocketPacket, float, int)}回调当前发送进度
272-
* 注意：无论设置的分段长度为多小，回调的频率最高为1秒30次，防止因此产生主线程的卡顿
272+
* 注意：回调过于频繁可能导致设置UI过于频繁从而导致主线程卡顿
273273
*
274274
* 若无需进度回调可删除此二行，删除后仍有【发送开始】【发送结束】的回调
275275
*/
@@ -309,7 +309,7 @@ private void __i__setupReadToTrailerForReceiver(SocketClient socketClient) {
309309

310310
/**
311311
* 根据连接双方协议设置的包头数据
312-
* 每次接收数据包（包括心跳包）都会在先接收此包头
312+
* 每次接收数据包（包括心跳包）都会先接收此包头
313313
*
314314
* 若无需包头可删除此行
315315
*/
@@ -367,7 +367,7 @@ public byte[] obtainSendPacketLengthDataForPacketLength(SocketPacketHelper helpe
367367

368368
/**
369369
* 根据连接双方协议设置自动发送的包尾数据
370-
* 每次发送数据包（包括心跳包）都会在发送包内容前自动发送此包尾
370+
* 每次发送数据包（包括心跳包）都会在发送包内容后自动发送此包尾
371371
*
372372
* 若无需包尾可删除此行
373373
* 注意：
@@ -378,7 +378,7 @@ public byte[] obtainSendPacketLengthDataForPacketLength(SocketPacketHelper helpe
378378
/**
379379
* 设置分段发送数据长度
380380
* 即在发送指定长度后通过 {@link SocketClientSendingDelegate#onSendingPacketInProgress(SocketClient, SocketPacket, float, int)}回调当前发送进度
381-
* 注意：无论设置的分段长度为多小，回调的频率最高为1秒30次，防止因此产生主线程的卡顿
381+
* 注意：回调过于频繁可能导致设置UI过于频繁从而导致主线程卡顿
382382
*
383383
* 若无需进度回调可删除此二行，删除后仍有【发送开始】【发送结束】的回调
384384
*/
@@ -433,18 +433,18 @@ public int obtainReceivePacketDataLength(SocketPacketHelper helper, byte[] packe
433433

434434
/**
435435
* 根据连接双方协议设置的包头数据
436-
* 每次接收数据包（包括心跳包）都会在先接收此包头
436+
* 每次接收数据包（包括心跳包）都会先接收此包头
437437
*
438438
* 若无需包头可删除此行
439439
*/
440440
socketClient.getSocketPacketHelper().setReceiveHeaderData(CharsetUtil.stringToData("SocketClient:", CharsetUtil.UTF_8));
441441

442442
/**
443443
* 根据连接双方协议设置的包尾数据
444-
* 每次接收数据包（包括心跳包）都会在检测接收到与包尾数据相同的byte[]时回调一个数据包
445444
*
446-
* 使用{@link com.vilyever.socketclient.helper.SocketPacketHelper.ReadStrategy.AutoReadToTrailer}必须设置此项
447-
* 用于分隔多条消息
445+
* 若无需包尾可删除此行
446+
* 注意：
447+
* 使用{@link com.vilyever.socketclient.helper.SocketPacketHelper.ReadStrategy.AutoReadByLength}时不依赖包尾读取数据
448448
*/
449449
socketClient.getSocketPacketHelper().setReceiveTrailerData(new byte[]{0x13, 0x10});
450450

@@ -462,7 +462,7 @@ private void __i__setupReadManuallyForSender(SocketClient socketClient) {
462462
/**
463463
* 设置分段发送数据长度
464464
* 即在发送指定长度后通过 {@link SocketClientSendingDelegate#onSendingPacketInProgress(SocketClient, SocketPacket, float, int)}回调当前发送进度
465-
* 注意：无论设置的分段长度为多小，回调的频率最高为1秒30次，防止因此产生主线程的卡顿
465+
* 注意：回调过于频繁可能导致设置UI过于频繁从而导致主线程卡顿
466466
*
467467
* 若无需进度回调可删除此二行，删除后仍有【发送开始】【发送结束】的回调
468468
*/

0 commit comments

Comments
 (0)