mirror of
https://github.com/fumiama/simple-dict.git
synced 2026-06-11 21:50:58 +08:00
update README
This commit is contained in:
115
README.md
115
README.md
@@ -28,13 +28,124 @@ Start server on localhost using the commands below.
|
||||
chmod +x simple-dict-server simple-dict-client
|
||||
./simple-dict-server -d 7777 1 ./dict.sp ./cfg.sp # use -d to start as daemon
|
||||
```
|
||||
`cfg.sp`is generated by `cfgwriter`.
|
||||
|
||||
Open another shell to connect to it.
|
||||
```bash
|
||||
./simple-dict-client 127.0.0.1 7777
|
||||
```
|
||||
Now you have connected to the server. Type `fumiama` and press enter in `10` seconds to get the read/write access. You can modify the password in source code as you like. Please note that the server will only wait `10` seconds for a response after the last communication. The box below shows how to control the server to accompilsh basic add/del/find/edit operations.
|
||||
Now you have connected to the server. The default access passwords is in `client.c` and you can modify the password in source code as you like. Please note that the server will only wait `10` seconds for a response after the last communication. The box below shows how to control the server to accompilsh basic add/del/find/edit operations.
|
||||
|
||||
The raw data starts with an integer showing its size, then a char `$` follows, finally following all binary data in `./dict.sp`.
|
||||
| cmd | data | description |
|
||||
| ---- | ---- | ---- |
|
||||
| get: | key | get key value |
|
||||
| cat: | filename | save raw dict.sp into filename |
|
||||
| md5: | md5 str | compare whether md5 of dict.sp is what given in data |
|
||||
| end | no data | end conversation |
|
||||
| set: | key | set key |
|
||||
| dat: | value to set | give value to the key |
|
||||
| del: | key | del key |
|
||||
|
||||
The raw data starts with an integer showing its size, then a char `$` follows, finally following all binary data in `./dict.sp` encoded by `TEA`.
|
||||
|
||||
A cmd sequence example is as below
|
||||
```bash
|
||||
get:test
|
||||
set:test
|
||||
dat:测试
|
||||
get:test
|
||||
del:test
|
||||
get:test
|
||||
end
|
||||
```
|
||||
The client output is
|
||||
```bash
|
||||
break!
|
||||
Get sockfd
|
||||
Connected to server
|
||||
Thread create succeeded
|
||||
Enter command:get:test
|
||||
Send data succeed.
|
||||
recv ack: null
|
||||
Enter command:set:test
|
||||
Send data succeed.
|
||||
recv ack: data
|
||||
Enter command:dat:测试
|
||||
Send data succeed.
|
||||
recv ack: succ
|
||||
Enter command:get:test
|
||||
Send data succeed.
|
||||
recv ack: 测试
|
||||
Enter command:del:test
|
||||
Send data succeed.
|
||||
recv ack: succ
|
||||
Enter command:get:test
|
||||
Send data succeed.
|
||||
recv ack: null
|
||||
Enter command:end
|
||||
Send data succeed.
|
||||
```
|
||||
The server output meanwhile is
|
||||
```bash
|
||||
Bind server success!
|
||||
Listening....
|
||||
Ready for accept, waitting...
|
||||
Next thread is No.0
|
||||
Accept client ::ffff:127.0.0.1:51296
|
||||
Creating thread succeeded
|
||||
Ready for accept, waitting...
|
||||
|
||||
Connected to the client.
|
||||
Next thread is No.1
|
||||
Creating timer thread succeeded
|
||||
Wait sec: 2, max: 10
|
||||
[normal] Get 34 bytes packet with cmd: 0, data: test
|
||||
Close dict
|
||||
Send data: null
|
||||
Wait sec: 0, max: 10
|
||||
Wait sec: 2, max: 10
|
||||
Wait sec: 4, max: 10
|
||||
[super] Get 34 bytes packet with data: test
|
||||
Send data: data
|
||||
Wait sec: 1, max: 10
|
||||
Wait sec: 3, max: 10
|
||||
[super] Get 34 bytes packet with data: 测试
|
||||
Data copy to dict succ
|
||||
Set data: dict[test]=测试
|
||||
Close dict
|
||||
Send data: succ
|
||||
Wait sec: 0, max: 10
|
||||
Wait sec: 2, max: 10
|
||||
[normal] Get 34 bytes packet with cmd: 0, data: test
|
||||
Close dict
|
||||
Send data: 测试
|
||||
Wait sec: 0, max: 10
|
||||
Wait sec: 2, max: 10
|
||||
[super] Get 34 bytes packet with data: test
|
||||
Close dict
|
||||
Send data: succ
|
||||
Wait sec: 0, max: 10
|
||||
Wait sec: 2, max: 10
|
||||
[normal] Get 34 bytes packet with cmd: 0, data: test
|
||||
Close dict
|
||||
Send data: null
|
||||
Wait sec: 0, max: 10
|
||||
[normal] Get 34 bytes packet with cmd: 4, data: fill
|
||||
Conversation end
|
||||
|
||||
Start killing.
|
||||
Close accept.
|
||||
Free data.
|
||||
Close dict
|
||||
Finish killing.
|
||||
Wait sec: 0, max: 10
|
||||
Call kill thread
|
||||
Start killing.
|
||||
Close dict
|
||||
Finish killing.
|
||||
Free timer
|
||||
Finish calling kill thread
|
||||
```
|
||||
|
||||
# Android Client for simple-dict-server
|
||||
There is also an [Android Client](https://github.com/fumiama/simple-dict-android) for simple-dict-server. Just install the apk file downloaded from release page and click `config` icon to set your server address using the format
|
||||
|
||||
Reference in New Issue
Block a user