Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

Latest commit

 

History

History
72 lines (52 loc) · 2.18 KB

README.md

File metadata and controls

72 lines (52 loc) · 2.18 KB

CollabServer - Network

license Build Status

master dev
Build Status Build Status

Overview


This is an internal library for the CollabServer framework. It provides the networking components such as messaging and sockets.

Features


  • Messaging system
  • Socket wrapper

Build (CMake)


  • Requirements
    • CMake
    • C++11
    • pragma once support
    • Tested with gcc 4.8.4
    • Tested with clang 5.0.0
    • Tested only on Linux. No support certified for Mac and Windows
  • Dependencies (already in the repo and built by CMake)
# Build the tests
mkdir build
cd build
cmake -DCOLLABSERVER_NETWORK_TESTS=ON ..
make
make runTests

# Or use the build script
./build.sh
CMake option Description
COLLABSERVER_NETWORK_TESTS (ON / OFF) Set ON to build unit tests
CMAKE_BUILD_TYPE Debug, Release, RelWithDebInfo, MinSizeRel

Generate Documentation


  1. Install Doxygen
  2. Run doxygen Doxyfile
  3. Files are placed in doc folder

Contribution


Feel free to ask me any question, share your ideas or open an issue. I started this project during my master thesis at University of Montreal. Format uses clang-format with the Google Coding style https://google.github.io/styleguide/cppguide.html (see .clang-format for further information). Make sure you autoformat on save (see https://clang.llvm.org/docs/ClangFormat.html)