atsf4g-co

service framework for game server using libatbus, libatapp, libcopp and etc.

Inner Service

• atproxy : proxy for logic server to communicate with each other

  • using etcd for service discovery and online detection.

• atgateway : gateway for client to communicate logic server

  • Using DH/ECDH for key establishment(directly send key or no encryption are also supported)
  • Traffic control and handshake timeout available for each client
  • Support for routing switching

Dependency

1. libuv -- libuv is a multi-platform support library with a focus on asynchronous I/O.
2. fmtlib -- A modern C++ formatting library.
3. libcurl -- libcurl is a free and easy-to-use client-side URL transfer library
4. libcopp -- Cross-platform coroutine library written in c++.
5. rapidjson -- A fast and header only json library.
6. flatbuffer -- A simple pack/unpack library. It's used in atgateway's inner protocol.
7. yaml-cpp -- A library to load YAML configure files.
8. rapidjson -- A library to load JSON string.
9. zlib -- This library is depended by many libraries.
10. openssl/libressl/mbedtls -- Provide SSL and TLS support for many libraries and tools.
11. libwebsockets -- A library used to implement HTTP and Websocket server.
12. lua -- Lua script engine
13. protobuf -- A well known serialization library.
14. python with pip support -- We use python to generate codes.

Prepare

1. Install etcd. (It's used for atproxy to connect to each other.)
2. [opional] Install redis. (DB services.install it if used)

Extern Dependency

1. libuuid-devel(uuid-dev)
2. [opional] hiredis, redis (if using redis, full_sample branch has use redis)

Basic Usage

Build on Windows

You need to prebuilt all dependency libraries such as openssl/mbedtls, libcurl, libuv and so on. Then run

mkdir build_jobs_msvc
cd build_jobs_msvc
# run cmake with vcpkg
cmake [SOURCE PATH] -G "Visual Studio 16 2019" -A x64 "-DCMAKE_TOOLCHAIN_FILE=<VCPKG_INSTALL_DIR>/scripts/buildsystems/vcpkg.cmake" -DPROJECT_ENABLE_UNITTEST=YES -DPROJECT_ENABLE_SAMPLE=YES -DPROJECT_ENABLE_TOOLS=YES ...

cd build_jobs_msvc

cmake --build . --config Debug

Please see third_party to see which libraries is required.

Build on Unix like system

# auto setup cmake
bash cmake_dev.sh [options] ...

# auto setup cmake with openssl, unit test , sample and tools
bash ./cmake_dev.sh -lus -- -DCRYPTO_USE_OPENSSL=YES

# we will generate directory build_jobs_$(basename $(uname -s)) for build and place publish directory
cd build_jobs_*

# just build with make -j4 or ninja -j4
cmake --build . -- -j4

Such as sh cmake_dev.sh -su to enable all unit test and samples, or sh cmake_dev.sh -a to use clang-analysis. You can also directly run cmake [SOURCE PATH] [options...] just like in windows, use your own prebuilt libraries or not. It depends to you.

All resource and file will be put into <BUILD_DIR>/publish after compile completed.

Configure & Run

Configure file is placed on <BUILD_DIR>/publish/tools/script/config.conf just edit it and set your etcd server and DB configure， then run <BUILD_DIR>/publish/tools/script/gen_conf.py to generate all configure files and scripts for servers. restart_all.sh 、 stop_all.sh 、 reload_all.sh script files will also be generated for easy usage.

cd publish/tools/script

vim config.conf # edit configure

python3 gen_conf.py

./restart_all.sh

gen_conf.py also has options for set some configures instead of using it in config.conf, it's useful when integration our server into other management system. Use python3 ./gen_conf.py - --help for more help information.

Developer

Tools

1. cmake 3.7 and above
2. gcc/clang/msvc
3. gdb/lldb/windb
4. git
5. unzip
6. tar
7. autoconf
8. automake
9. p7zip
10. python2/python
11. etc.

Python modules

1. python-mako/python*-mako/mingw-w64-x86_64-python*-mako
2. [optional] python-setuptools/python*-setuptools/mingw-w64-x86_64-python*-mako
3. [optional] python-pip/python*-pip/mingw-w64-x86_64-python*-pip

Framework Code Tree

• third_party: all dependency third_party libraries
• atframework: atframework projects and libraries

• export: exported libraries, used by client
• libatframe_utils: framework utility codes
• libatbus: communication library used between servers
• libatapp: server application framework, used to build a specified server type
• services: inner services of atframework

1. component: inner services common codes
2. atproxy: proxy server, used to connect difference service group to each other
3. atgateway: gateway server, used to manage client connections

• doc: documents
• install: all resources and configure templates
• project: project script, used to detect build environment and generate build scripts
• sample: sample codes to show usage of some libraries
• src: all real projects

• echosvr: the simplest server instance, just send back all data receive from client
• [others]: other services

Logic Code Tree

• src: all real projects

• server_frame: server common library

1. config: server configure defines and excel configure data structures
2. data: game data layer
3. dispatcher: decide how to deal with each type of messages and manage coroutine tasks
4. logic: game logic layer
5. rpc: all remote procedure call APIs, include server to server message, DB message and so on
6. utility: all shared utility codes

• tools: tool projects

Basic Usage

Build on Windows

You need to prebuilt all dependency libraries such as openssl/mbedtls, libcurl, libuv and so on. Then run

mkdir build_jobs_msvc
cd build_jobs_msvc
# run cmake
cmake [SOURCE PATH] -G "Visual Studio XXXX" -A x64 -DLIBUV_ROOT=[LIBUV INSTALL PATH] -DOPENSSL_ROOT=[OPENSSL INSTALL PATH] -DPROJECT_ENABLE_UNITTEST=YES -DPROJECT_ENABLE_SAMPLE=YES -DPROJECT_ENABLE_TOOLS=YES ...

cd build_jobs_msvc

cmake --build . --config Debug

Please see third_party to see which libraries is required.

Build on Unix like system

# auto setup cmake

sh cmake_dev.sh [options] ...

# we will generate directory build_jobs_$(basename $(uname -s)) for build and place publish directory
cd build_jobs_*

# just build with make -j4 or ninja -j4
cmake --build . -- -j4

Such as sh cmake_dev.sh -su to enable all unit test and samples, or sh cmake_dev.sh -a to use clang-analysis. You can also directly run cmake [SOURCE PATH] [options...] just like in windows, use your own prebuilt libraries or not. It depends to you.

All resource and file will be put into <BUILD_DIR>/publish after compile completed.

Configure

Configure file is placed on <BUILD_DIR>/publish/tools/script/config.conf just edit it and set your etcd server and DB configure， then run <BUILD_DIR>/publish/tools/script/gen_conf.py to generate all configure files and scripts for servers. restart_all.sh 、 stop_all.sh 、 reload_all.sh script files will also be generated for easy usage.

cd publish/tools/script

vim config.conf # edit configure

python3 gen_conf.py

./restart_all.sh

gen_conf.py also has options for set some configures instead of using it in config.conf, it's useful when integration our server into other management system. Use python3 ./gen_conf.py - --help for more help information.

At last, you can use <BUILD_DIR>/publish/tools/simulator/bin/simulator-cli to connect gateway and send/receive messages.