Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 1.45 KB

README.md

File metadata and controls

44 lines (28 loc) · 1.45 KB
Raw

libSocket is a portable low-level socket library.

The purpose of this library is to wrap the BSD & winsock2 API to hidde the differences between the two APIs.

The Winsock2 API is similar but not fully compatible with the BSD API, which is a shame because that was its purpose.

The purpose of this library is to:

  • To support both IPV4 and IPV6 addresses.
  • Never allocate memory dynamically.
  • KISS : Keep It Simple Stupid.

This library is tested on

  • Linux (Ubuntu 20.04)
  • MacOSX
  • Windows with Visual Studio Community 2019

How to build

This library use cmake.

  • Either you build and install this lib
   git clone https://github.com/TheBigFred/libSocket.git
   mkdir build
   cmake -S libSocket -B build
   make -j4
   sudo make install

The default install dir is /usr/local. You can change it by adding -DCMAKE_INSTALL_PREFIX:PATH="your install path" at the end of the cmake command line.

The lib provide a cmake package and is found with find_package(libSocket). Available targets are: Socket-static and Socket-shared.

  • Either you include the sources in a subfolder of your project and you include it with an add_subdirectory. The libSocket CMakeLists is written carefully to be added in a parent CMakeLists.

Two cmake options are available:

  • -DENABLE_DOC_libSocket:BOOL=ON : add the make target libSocket-doxygen which generate the doxygen documentation.
  • -DENABLE_TEST_libSocket:BOOL=ON : enable the unitests and examples build.