Skip to content

Latest commit

 

History

History
110 lines (87 loc) · 2.78 KB

README.md

File metadata and controls

110 lines (87 loc) · 2.78 KB
Raw

Socket Manager

Safe and Efficient Socket Networking Library for C++

Easily manage multiple socket connections asynchronously in C++.

Installation

  • Step 1: Install Rust Nightly
curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain nightly-2024-02-04
  • Step 2: Install LLVM 17

macOS:

brew install llvm@17
# get brew environment
eval "$(brew shellenv)"

linux

wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 17 all
sudo ./update-alternatives-clang.sh 17 9999
  • Step 3: Pull the source code
git clone https://github.com/Congyuwang/socket_manager.git
cd socket_manager
git submodule update --init
  • Step 4: Build and Install

As a shared library:

cmake -B build -DCMAKE_BUILD_TYPE=Release \
               -DCMAKE_TOOLCHAIN_FILE=toolchain.cmake \
               -DCMAKE_INTERPROCEDURAL_OPTIMIZATION=ON
cmake --build build --parallel 4 --config Release
sudo cmake --install build --config Release

As a static library:

cmake -B build -DCMAKE_BUILD_TYPE=Release \
               -DCMAKE_TOOLCHAIN_FILE=toolchain.cmake \
               -DCMAKE_INTERPROCEDURAL_OPTIMIZATION=ON \
               -DBUILD_SHARED_LIBS=OFF
cmake --build build --parallel 4 --config Release
sudo cmake --install build --config Release

Usage

In your CMakeLists.txt, add the following lines:

find_package(socket_manager 0.2.0 REQUIRED)
target_link_libraries(test_socket_manager PUBLIC socket_manager)

Linking as Static Library

For linking, add the lines in the toolchain.cmake in your toolchain file or use the provided toolchain.cmake to ensure the right toolchain is used.

Example:

set(CMAKE_TOOLCHAIN_FILE ${CMAKE_SOURCE_DIR}/toolchain.cmake)

To enable lto, add:

set_property(TARGET <your-target> PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)

Memory (resource) Model

Dropping Sender will close the Write side of the connection, and drop its reference to Connection. The Read side will close when the socket sends FIN. To force close an established connection, call the close() method of the Connection object. ConnCallback will drop its internal reference to Connection when the connection is closed. Thus Connection will free any reference to Notifier or MsgReceiver. Note to drop all related resources, no reference to the returned Waker should be kept.

flowchart TD
    M(SocketManager) -->|strong ref| CB(ConnCallback)
    CB -->|strong ref, drop on close| CON(Connection)
    CON -->|strong ref| NF(Notifier)
    CON -->|strong ref| RCV(MsgReceiver)
    SEND(Sender) -->|strong ref| CON
    RCV -.->|returns| WK
    WK(Waker) -.->|drop to release| READ(Read Task)
    SEND -.->|drop to close| CB
Loading

See the example folder for more complicated case.