Skip to content

Commit 47b856c

Browse files
committed
Improve docs.
1 parent 04c7be2 commit 47b856c

File tree

3 files changed

+29
-2
lines changed

3 files changed

+29
-2
lines changed

doc/java_manual.zh-CN.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,28 @@ public class MySdk {
8787
## 开启 / 关闭调试日志
8888

8989
```java
90+
public static boolean getDebug();
9091
public static void setDebug(boolean debug);
9192
```
9293

9394
* 可以通过 `setDebug()` 随时开启 / 关闭 ByteHook 的调试日志。
9495
* 调试日志输出到 logcat,tag为:`bytehook_tag`
9596
* 使用默认参数初始化时,ByteHook 默认关闭调试日志。
9697

98+
99+
## 开启 / 关闭操作记录
100+
101+
```java
102+
public static boolean getRecordable();
103+
public static void setRecordable(boolean recordable);
104+
```
105+
106+
* 可以通过 `setRecordable()` 随时开启 / 关闭 ByteHook 的操作记录。
107+
* 操作记录包含 hook 和 unhook 的调用信息,保存在内存中,需要的时候可以通过 API 读取。
108+
* 使用默认参数初始化时,ByteHook 默认关闭操作记录。
109+
* 详见:[操作记录](records.zh-CN.md)
110+
111+
97112
## 增加全局忽略的动态库
98113

99114
```java

doc/native_manual.zh-CN.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,21 @@ int bytehook_init(int mode, bool debug);
2222
## 开启 / 关闭调试日志
2323
2424
```C++
25+
bool bytehook_get_debug(void);
2526
void bytehook_set_debug(bool debug);
2627
```
2728

28-
作用和 Java 层 `setDebug()` 函数相同。
29+
作用和 Java 层 `getDebug()``setDebug()` 函数相同。
30+
31+
32+
## 开启 / 关闭操作记录
33+
34+
```C++
35+
bool bytehook_get_recordable(void);
36+
void bytehook_set_recordable(bool recordable);
37+
```
38+
39+
作用和 Java 层 `getRecordable()`,`setRecordable()` 函数相同。详见:[操作记录](records.zh-CN.md)。
2940
3041
3142
## 增加全局忽略的动态库

doc/records.zh-CN.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# 操作记录
22

33

4-
* ByteHook 会在内存中记录 hook / unhook 的操作信息。
4+
* ByteHook 可以在内存中记录 hook / unhook 的操作信息。
55
* ByteHook 使用了一种比较精简的二进制 + 数据字典格式来记录信息,占用的内存会动态扩展,当操作记录使用的内存达到 1Mbytes 时,就停止继续记录。(1Mbytes估算可以记录 20000 次 hook / unhook 的操作信息)
66
* ByteHook 提供了 dump 这些数据的接口。以字符串形式返回操作信息的内容,或将内容写入指定的 FD(文件描述符)中。(其中写入 FD 的 API 是异步信号安全的,可以在 signal handler 中使用。例如,可以在捕获 app 崩溃的signal handler 中调用)
7+
* 注意:ByteHook 默认关闭操作记录。需要的话,可以在初始化完成后通过 Java 函数 `setRecordable()` 或 Native 函数 `bytehook_set_recordable()` 开启。
78

89
## native 层 API
910

0 commit comments

Comments
 (0)