simple-dict-server

database["key"]="value"

Compile

You should first clone this project into a system with cmake & libpthread installed. If you plan to compile it on Windows, you should edit the source code and transform socket/thread/file libraries into Windows version.

git clone https://github.com/fumiama/simple-dict-server.git

Now create a build folder.

cd simple-dict-server
mkdir build

Then use cmake command to generate files for make automatically.

cd build
cmake ../

Use make to generate executable binary files named simple-dict-server and simple-dict-client in ./build directory.

make

Execute

Now we will show you how to start the server on localhost. You can try the command below.

chmod +x simple-dict-server simple-dict-client
./simple-dict-server -d 7777 1 ./dict.bin    # use -d to start as daemon

Then you can open another shell to connect to it.

./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 the source code as you like. Please note that the server will only wait 10 seconds for a response after the last communication. The communication below shows how to control the server to accompilsh basic add/del/find/edit operations.

break!
Get sockfd
Connected to server
Welcome to simple dict server.
Thread create succeeded
Enter command:fumiama
Enter command:set     #set a key-value pair
Recv 3 bytes: set
Enter command:test    #key
Recv 4 bytes: data
Enter command:测试    #value
Recv 4 bytes: succ
Enter command:get     #get a value using key
Recv 3 bytes: get
Enter command:test
Recv 6 bytes: 测试
Enter command:del     #delete a key
Recv 3 bytes: del
Enter command:test
Recv 4 bytes: succ
Enter command:get
Recv 3 bytes: get
Enter command:test
Recv 4 bytes: null
Enter command:set
Recv 3 bytes: set
Enter command:test
Recv 4 bytes: data
Enter command:测试
Recv 4 bytes: succ
Enter command:lst   #list all keys match pattern
Recv 3 bytes: lst
Enter command:t     #pattern
Recv 5 bytes: test

Enter command:quit
Enter command:^C

You can also use cat command to get the raw data directly.

break!
Get sockfd
Connected to server
Welcome to simple dict server.
Thread create succeeded
Enter command:fumiama
Enter command:cat
Recv 131 bytes: 128test测试
Enter command:quit
Enter command:^C

The raw data starts with a integer showing the size of data, then send all data in ./dict.bin to the client.

Android Client for simple-dict-server

There is also a Android Client for simple-dict-server. Just install it from release page and click the config icon to set your server address using the format like

127.0.0.1:7777_password

Note that this APP is designed for a new language called Tenenja, so the font of this APP is abnormal. What's more, there is no English translation for this APP because its users are Chinese. If you want to get an APP in your language, just edit the source code for free.