RSP

OVERVIEW

RealTime Server Platform

started @since 23.09.10
development by @nolleh

it aims to make room based socket server platform(framework) in production level for core parts. (long term project, and this will be progressed in my leisure time, so getting longer.)

• 😎 if you implement contents logic with shared_library to room server,
  multithreading / network / session management no need to be cared,
  just concentrate on your business logic in room

terms room based meaning

user can explore rooms that open to match, and enter a room that selected by user or randomly, that open to that user by conditions (like ranking point or money)

terms socket server meaning

I believe C++ is A almost fastest language and a real time server should take advantage of that,
if that is crucial parts of the application.
as such principle, used 'socket' (could be websocket) for maintain connectivity with simplest protocol. using binary protocol and protobuf (far-much-lighter ~but hard to debug~ than that of json or...)

terms platform meaning

can be used other business logic by using shared_library meaning:

1. after enter the room, communication between client <-> server is bypassed to library (contents logic),
   so with this platform, you can implement ANY (Game/Chatting) logic that need to communicate between same room users
2. after enter the room, the rooms' logic is ALSO changeable by shared library WHILE RUNNING SERVER (with-no-shutdown-time)

it is open to use,
but plz represent where it from and
and also if you like this, or to give motivation for development, press star. :) -- follows GNU GPL LICENSE

restriction

to make things simple, not very concern about multi platform (OS) or compiler version. if need or it stimulate my curiosity (... 😅), it is possible choose component that not compatible with other platform. the dependencies will be descripted below.

dependencies

• tested on
  • cxx-20
  • boost-1_83_0
  • cmake-3.25.1
  • gcc-12.3.0
  • protoc-3.21.12
  • zeromq-4.3.4-6
  • cppzmq-4.10.0-1

run

1. manual build

1. prepare the dependencies, and run ./rebuild.sh
2. then ./run-svr.sh and ./run-cli.sh (with individual terminal)

2. from prebuilt

• until now, tested on ubuntu (with aarch64)

from here, https://github.com/nolleh/rsp/releases

download tar
then untar, then run

tar -xvf {filename}
./User
./Client 127.0.0.1

currently used port : 8080

filename is file that you downloaded. differ from distribution. for now ubuntu,

• rsp-v0.0.1-ubuntu-aarch64.tar

for more explanation, there may exist in release page.

style

basically, follow google c++ style guide

• but used c++20 features(my curiosity) if needed, which is opposite that guide
• but used snakecase on class names (except proto)
• but used snakecase on function names

used cpplint, which will be checked in CI level.

project

rsp-cli

client for connecting to svr. no GUI

rsp-svr

server for rsp

user

server that works as gateway, and managed user session

room

the room server user entered

room_manager

determines that a user which room should be assigned to enter. (load balancing, and match making)

Troubleshoot

• objdump -S -f $file

./cmake.sh -D
./build.sh
gdb