masesk / easy-socket

Modern C++ 11 native, OS agnostic, socket library/starting base with a single header include

easy-socket

Modern C++ 11 native, OS agnostic, socket library/starter code with a single header include

Features

• Easy: Start using simple socket features by including a single header file
• Portable: Works on Windows and Linux
• Configurable: All sockets configurations and settings can easily be accessed and changed from the header file.

Requirements

• C++ 11 and up

Namespace, Usecase, Members, Functions

Import:

#include <masesk/EasySocket.hpp>

Namespace and Initialize

masesk::EasySocket easySocket; //or using namespace masesk;

Usecase

• EasySocket wraps the code for the server and client, so that a single header can be used to initialize and start a server or a client.

//server example 

#include <iostream>
#include <masesk/EasySocket.hpp>
using namespace std;
using namespace masesk;

void handleData(const std::string &data) {
	cout << "Client sent: " + data << endl;
}

int main() {
	EasySocket socketManager;
	socketManager.socketListen("test", 8080, &handleData);
	return 0;
}

// client example
#include <iostream>
#include <masesk/EasySocket.hpp>
#include <string>
using namespace std;
using namespace masesk;
int main() {
	EasySocket socketManager;
	socketManager.socketConnect("test", "127.0.0.1", 8080);
	socketManager.socketSend("test", "Hello from client!");
	socketManager.closeConnection("test");
	return 0;
}

Functions

Server Functions

• void socketListen(std::string channelName, int port, std::function<void (std::string data)> callback);
  • channelName: string identifier of channel
  • port: integer value of port used on server side (eg. 8080)
  • function: pointer of function that will be called to handle the data when the server recieves data from the client

Client Functions

• void socketConnect(std::string channelName, std::string ip, int port) - start a new connection with a server with a channel name, ip address of the server, and the port the server would be listening on.
  • channelName - string identifier of channel
  • ip - string for where the server resides (eg. 127.0.0.1 for local)
  • port - integer value of port used on server side (eg. 8080)
• void socketSend(std::string channelName, std::string data) - send data to server based on channel name
  • channelName: string identifier of channel
  • data: data to be sent through to the server on given channel
• void closeConnection(std::string channelName) - close connection with server using channel name
  • channelName: string identifier of channel

Example

Check test/test-server and test/test-client for a working client and server example running locally.

Build Tests on Windows

1. Open easy-socket.sln in Visual Studio 2017
2. Right click on test-client, select properites, and change Windows SDK Version to your installed 10.x
3. Right click on test-server, select properites, and change Windows SDK Version to your installed 10.x
4. Right click on Solution 'easy-socket' and select Rebuild entire solution.
5. Select desired Configuration (Debug/Release) and Platform (x64/Win32) from the top-bar dropdowns next to the start button.
6. Executables will be available at [x64 or Win32]/[Debug or Release]

Build Tests on Linux

Requirements:

• CMake (> v3.5)
• make
• g++ (> v6.1)

mkdir build

cd build

cmake ..

make

Executables will be available at build/tests/test-client/client and build/tests/test-client/server