Skip to content

README.md

Latest commit

 

History

History
71 lines (40 loc) · 1.4 KB

README.md

File metadata and controls

71 lines (40 loc) · 1.4 KB

MDTP ( Markdown Transfer Protocol )

MDTP is a simple network protocol inspired by HTTP.

MDTP includes a Server Socket and a Client Socket for communicating back and forth with a server and clients.

It builds on TCP and is just a fun little project I made to learn more about the concept.

MDTP communication listens on port 50 by default.

Usage

If you for some reason wants to use MDTP to send data and receive data you are more than welcome to.

Installation

To install MDTP in a cmake project add this to the cmake

include( FetchContent )
FetchContent_Declare(
        MDTP
        GIT_REPOSITORY https://github.com/Xtarii/MDTP.git
        GIT_TAG <tag>    # Version Tag
)
FetchContent_MakeAvailable(MDTP)



target_link_libraries(<project> PRIVATE MDTP)    # Link to Project

Creating a Server

Creating a Server

// Creating a Server ( PORT is set by default and therefore not required )
MDTPServer serverSocket = MDTPServer(50);


// Accepting Clients
MDTPConnection client = serverSocket.accept();


// Reads Data from Client
MDTPObject request = client.read();


// Writes Data back to client
client.write({ .command = STATUS_OK, .body = "# Hello World\r\nA markdown protocol" });

Creating a Client

Creating a Client

MDTPClient client("127.0.0.1", 50); // The Port is not needed as the default is 50
MDTPObject data = client.fetch("/test");