D++ (DPP)
C++ Discord API Bot Library
dpp::websocket_client Class Reference

Implements a websocket client based on the SSL client. More...

#include <wsclient.h>

+ Inheritance diagram for dpp::websocket_client:
+ Collaboration diagram for dpp::websocket_client:

Public Member Functions

 websocket_client (const std::string &hostname, const std::string &port="443", const std::string &urlpath="")
 
virtual ~websocket_client ()
 
virtual void write (const std::string &data)
 Write to websocket. Encapsulates data in frames if the status is CONNECTED. More...
 
virtual bool HandleBuffer (std::string &buffer)
 Processes incoming frames from the SSL socket input buffer. More...
 
virtual void close ()
 Close websocket. More...
 
virtual bool HandleFrame (const std::string &buffer)
 Receives raw frame content only without headers. More...
 
virtual void Error (uint32_t errorcode)
 Called upon error frame. More...
 
virtual void OneSecondTimer ()
 
uint64_t get_bytes_out ()
 
uint64_t get_bytes_in ()
 
void ReadLoop ()
 Nonblocking I/O loop. More...
 
virtual void log (dpp::loglevel severity, const std::string &msg) const
 Log a message. More...
 

Public Attributes

std::function< int()> custom_readable_fd
 Attaching an additional file descriptor to this function will send notifications when there is data to read. More...
 
std::function< int()> custom_writeable_fd
 Attaching an additional file descriptor to this function will send notifications when you are able to write to the socket. More...
 
std::function< void()> custom_readable_ready
 This event will be called when you can read from the custom fd. More...
 
std::function< void()> custom_writeable_ready
 This event will be called when you can write to a custom fd. More...
 

Protected Member Functions

virtual void Connect ()
 
ws_state GetState ()
 

Protected Attributes

std::string buffer
 
std::string obuffer
 
bool nonblocking
 
int sfd
 
SSL * ssl
 
SSL_CTX * ctx
 
std::string cipher
 
time_t last_tick
 
std::string hostname
 
std::string port
 
uint64_t bytes_out
 
uint64_t bytes_in
 

Detailed Description

Implements a websocket client based on the SSL client.

Constructor & Destructor Documentation

◆ websocket_client()

dpp::websocket_client::websocket_client ( const std::string &  hostname,
const std::string &  port = "443",
const std::string &  urlpath = "" 
)

Connect to a specific websocket server.

Parameters
hostnameHostname to connect to
portPort to connect to
urlpathThe URL path components of the HTTP request to send

◆ ~websocket_client()

virtual dpp::websocket_client::~websocket_client ( )
virtual

Destructor

Member Function Documentation

◆ close()

virtual void dpp::websocket_client::close ( )
virtual

Close websocket.

Reimplemented from dpp::ssl_client.

◆ Connect()

virtual void dpp::websocket_client::Connect ( )
protectedvirtual

(Re)connect

Reimplemented from dpp::ssl_client.

◆ Error()

virtual void dpp::websocket_client::Error ( uint32_t  errorcode)
virtual

Called upon error frame.

Parameters
errorcodeThe error code from the websocket server

Reimplemented in dpp::discord_client, and dpp::discord_voice_client.

◆ get_bytes_in()

uint64_t dpp::ssl_client::get_bytes_in ( )
inherited

Get total bytes received

◆ get_bytes_out()

uint64_t dpp::ssl_client::get_bytes_out ( )
inherited

Get total bytes sent

◆ GetState()

ws_state dpp::websocket_client::GetState ( )
protected

Get websocket state

Returns
websocket state

◆ HandleBuffer()

virtual bool dpp::websocket_client::HandleBuffer ( std::string &  buffer)
virtual

Processes incoming frames from the SSL socket input buffer.

Parameters
bufferThe buffer contents. Can modify this value removing the head elements when processed.

Reimplemented from dpp::ssl_client.

◆ HandleFrame()

virtual bool dpp::websocket_client::HandleFrame ( const std::string &  buffer)
virtual

Receives raw frame content only without headers.

Parameters
bufferThe buffer contents
Returns
True if the frame was successfully handled. False if no valid frame is in the buffer.

Reimplemented in dpp::discord_client, and dpp::discord_voice_client.

◆ log()

virtual void dpp::ssl_client::log ( dpp::loglevel  severity,
const std::string &  msg 
) const
virtualinherited

Log a message.

Parameters
severityseverity of log message
msgLog message to send

Reimplemented in dpp::discord_client.

◆ OneSecondTimer()

virtual void dpp::websocket_client::OneSecondTimer ( )
virtual

Fires every second from the underlying socket I/O loop, used for sending webscocket pings

Reimplemented from dpp::ssl_client.

Reimplemented in dpp::discord_client, and dpp::discord_voice_client.

◆ ReadLoop()

void dpp::ssl_client::ReadLoop ( )
inherited

Nonblocking I/O loop.

◆ write()

virtual void dpp::websocket_client::write ( const std::string &  data)
virtual

Write to websocket. Encapsulates data in frames if the status is CONNECTED.

Parameters
dataThe data to send.

Reimplemented from dpp::ssl_client.

Member Data Documentation

◆ buffer

std::string dpp::ssl_client::buffer
protectedinherited

Input buffer received from openssl

◆ bytes_in

uint64_t dpp::ssl_client::bytes_in
protectedinherited

Bytes in

◆ bytes_out

uint64_t dpp::ssl_client::bytes_out
protectedinherited

Bytes out

◆ cipher

std::string dpp::ssl_client::cipher
protectedinherited

SSL cipher in use

◆ ctx

SSL_CTX* dpp::ssl_client::ctx
protectedinherited

OpenSSL context

◆ custom_readable_fd

std::function<int()> dpp::ssl_client::custom_readable_fd
inherited

Attaching an additional file descriptor to this function will send notifications when there is data to read.

NOTE: Only hook this if you NEED it as it can increase CPU usage of the thread! Returning -1 means that you don't want to be notified.

◆ custom_readable_ready

std::function<void()> dpp::ssl_client::custom_readable_ready
inherited

This event will be called when you can read from the custom fd.

◆ custom_writeable_fd

std::function<int()> dpp::ssl_client::custom_writeable_fd
inherited

Attaching an additional file descriptor to this function will send notifications when you are able to write to the socket.

NOTE: Only hook this if you NEED it as it can increase CPU usage of the thread! You should toggle this to -1 when you do not have anything to write otherwise it'll keep triggering repeatedly (it is level triggered).

◆ custom_writeable_ready

std::function<void()> dpp::ssl_client::custom_writeable_ready
inherited

This event will be called when you can write to a custom fd.

◆ hostname

std::string dpp::ssl_client::hostname
protectedinherited

Hostname connected to

◆ last_tick

time_t dpp::ssl_client::last_tick
protectedinherited

For timers

◆ nonblocking

bool dpp::ssl_client::nonblocking
protectedinherited

True if in nonblocking mode. The socket switches to nonblocking mode once ReadLoop is called.

◆ obuffer

std::string dpp::ssl_client::obuffer
protectedinherited

Output buffer for sending to openssl

◆ port

std::string dpp::ssl_client::port
protectedinherited

Port connected to

◆ sfd

int dpp::ssl_client::sfd
protectedinherited

Raw file descriptor of connection

◆ ssl

SSL* dpp::ssl_client::ssl
protectedinherited

OpenSSL session

D++ Library version 10.0.29D++ Library version 10.0.28D++ Library version 10.0.27D++ Library version 10.0.26D++ Library version 10.0.25D++ Library version 10.0.24D++ Library version 10.0.23D++ Library version 10.0.22D++ Library version 10.0.21D++ Library version 10.0.20D++ Library version 10.0.19D++ Library version 10.0.18D++ Library version 10.0.17D++ Library version 10.0.16D++ Library version 10.0.15D++ Library version 10.0.14D++ Library version 10.0.13D++ Library version 10.0.12D++ Library version 10.0.11D++ Library version 10.0.10D++ Library version 10.0.9D++ Library version 10.0.8D++ Library version 10.0.7D++ Library version 10.0.6D++ Library version 10.0.5D++ Library version 10.0.4D++ Library version 10.0.3D++ Library version 10.0.2D++ Library version 10.0.1D++ Library version 10.0.0D++ Library version 9.0.19D++ Library version 9.0.18D++ Library version 9.0.17D++ Library version 9.0.16D++ Library version 9.0.15D++ Library version 9.0.14D++ Library version 9.0.13D++ Library version 9.0.12D++ Library version 9.0.11D++ Library version 9.0.10D++ Library version 9.0.9D++ Library version 9.0.8D++ Library version 9.0.7D++ Library version 9.0.6D++ Library version 9.0.5D++ Library version 9.0.4D++ Library version 9.0.3D++ Library version 9.0.2D++ Library version 9.0.1D++ Library version 9.0.0D++ Library version 1.0.2D++ Library version 1.0.1D++ Library version 1.0.0