Websocket Client

References

#include "IP/InternetProtocol.hpp"

Syntax

namespace InternetProtocol
class WebsocketClient

Example Code

#include <iostream>
#include <IP/Websocket/WebsocketClient.hpp>
 
using namespace InternetProtocol;
 
int main()
{
    WebsocketClient client;
    client.set_host("localhost", "3000");
    client.on_message_received = [&](const FWsMessage message) {
        std::cout << buffer_to_string(message) << std::endl;
    };
    client.connect();
 
    std::string input;
    std::cout << "Digite algo: ";
    while (std::getline(std::cin, input)) {
        if (input == "quit")
        {
            break;
        }
        client.send(input);
    }
 
    return 0;
}

Variables

EOpcode

namespace InternetProtocol
 
enum class EOpcode : uint8_t {
    FRAME_CON,
    TEXT_FRAME,
    BINARY_FRAME,
    NON_CONTROL_FRAMES,
    CONNECTION_CLOSE,
    PING,
    PONG,
    FURTHER_FRAMES,
};

FDataFrame

namespace InternetProtocol
 
struct FDataFrame {
    bool fin;
    bool rsv1;
    bool rsv2;
    bool rsv3;
    bool mask;
    EOpcode opcode;
    size_t length;
    std::array<std::byte, 4> masking_key;
};

FWsMessage

namespace InternetProtocol
 
struct FWsMessage {
    FDataFrame data_frame;
    std::vector<std::byte> payload;
    std::string toString() const;
    size_t size;
};

Functions

Set Host

Set the adress and port of host

void set_host(const std::string &ip, const std::string &port)

Get Socket

Get socket connection properties

asio::ip::tcp::socket &get_socket()

Set Max Send Buffer Size

Set max size in bytes of send buffer

void set_max_send_buffer_size(int value = 1400)

Get Max Send Buffer Size

Get max size in bytes of send buffer

int get_max_send_buffer_size() const

Set Split Package

If the size of a message exceeds the maximum allowed size for the send buffer, it will be divided into smaller packets before being sent.

void set_split_package(bool value = true)

Get Split Package

Get if Split Package is enabled

bool get_split_package() const

Send Str

Send a string message
Return false if string is empty or socket is closed
Warning: If you’re using Windows, ensure that you are sending characters compatible with UTF-8

bool send_str(const std::string &message)

Send Buffer

Send a buffer message
Return false if byte array is empty or socket is closed

bool send_buffer(const std::vector<uint8_t> &buffer)

Send Ping

Send a ping to websocket server
Return false if socket is closed

bool send_ping()

Connect

Connect to the host
Return true if It's able to connect

bool connect()

Close

Close connection

void close()

Get Error Code

Get latest error code

asio::error_code get_error_code() const

Handshake Functions

Handshake is a http request to contact the server and requesting a WebSocket connection

Set Headers

Set handshake headers

void set_headers(const std::map<std::string, std::string> &headers)

Get Headers

Return a reference to handshake headers
Use this function to modify or append values to headers

std::map<std::string, std::string> &get_headers()

Dataframe Functions

Set RSV1

void set_RSV1(bool value = false)

Use RSV1

bool use_RSV1() const

Set RSV2

void set_RSV2(bool value = false)

Use RSV2

bool use_RSV2() const

Set RSV3

void set_RSV3(bool value = false)

Use RSV3

bool use_RSV3() const

Set Mask

void set_Mask(bool value = true)

Use Mask

bool use_Mask() const

Events

On Connected

Event triggered when a connection is estabilished

std::function<void()> on_connected

On Bytes Transferred

Event triggered when socket send or receive data
size_t: bytes sent
size_t: bytes received

std::function<void(const size_t, const size_t)> on_bytes_transfered

On Message Sent

Event triggered when a message is sent
size_t: size of message

std::function<void(const asio::error_code &)> on_message_sent

On Message Received

Event triggered when a message is received
const asio::error_code &: if error occur, error code will be different from 0

std::function<void(const FWsMessage)> on_message_received

On Pong Received

Event triggered when a pong message is received

std::function<void()> on_pong_received

On Close Notify

Event triggered when a server send a close notification

std::function<void()> on_close_notify

On Close

Event triggered when a connection is closed

std::function<void()> on_close

On Handshake Fail

Event triggered if any error occur during handshake.
Normally, when a handshake error occurs, the socket is automatically closed, triggering the on_close event.

std::function<void(const Client::FResponse)> on_handshake_fail

On Error

Event triggered if any error occur during async process.
const asio::error_code &: if error occur, error code will be different from 0.
Normally, when an error occurs, the socket is automatically closed, triggering the on_close event.

std::function<void(const asio::error_code &)> on_error

Websocket Client

On this page