Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.1 KB

DOCUMENTATION.md

File metadata and controls

44 lines (30 loc) · 1.1 KB

Hermes documentation

Hermes is a lightweight, cross-platform, asynchronous, C++11 network library. Hermes provides an user-friendly API with which you can easily create a server or client following either the TCP or UDP protocol. Hermes is based on a polling model using a thread pool to handle events asynchronously between the server and the clients.

To use Hermes, you just need to include the Hermes.hpp header in your code.

  • Compiling using g++:

Assuming you want to compile a file containing some code using Hermes' features. You just need to run the following command:

g++ -std=c++11 your_file.cpp -pthread -o binary_name

Summary

  • TCP API

    • Socket

      • API
    • Server

      • API
      • example: Asynchronous TCP echo server
    • Client

      • API
      • example: TCP client
  • UDP API

    • Socket

      • API
    • Server

      • API
      • example: Asynchronous UDP server
    • Client

      • API
      • example: Hello world!
      • example: Broadcasting "Hello world!"