dpp::discord_client Class Reference

Implements a discord client. Each discord_client connects to one shard and derives from a websocket client. More...

#include <discordclient.h>

Inheritance diagram for dpp::discord_client:

Collaboration diagram for dpp::discord_client:

Public Member Functions
virtual void	log (dpp::loglevel severity, const std::string &msg) const
virtual void	handle_event (const std::string &event, json &j, const std::string &raw)
uint64_t	get_guild_count ()
	Get the Guild Count for this shard. More...
uint64_t	get_member_count ()
	Get the Member Count for this shard. More...
uint64_t	get_channel_count ()
	Get the Channel Count for this shard. More...
virtual void	one_second_timer ()
void	queue_message (const std::string &j, bool to_front=false)
	Queue a message to be sent via the websocket. More...
void	clear_queue ()
	Clear the outbound message queue. More...
size_t	get_queue_size ()
	Get the size of the outbound message queue. More...
bool	is_connected ()
	Returns true if the shard is connected. More...
dpp::utility::uptime	get_uptime ()
	Returns the connection time of the shard. More...
	discord_client (dpp::cluster *_cluster, uint32_t _shard_id, uint32_t _max_shards, const std::string &_token, uint32_t intents=0, bool compressed=true, websocket_protocol_t ws_protocol=ws_json)
	Construct a new discord_client object. More...
virtual	~discord_client ()
uint64_t	get_decompressed_bytes_in ()
virtual bool	handle_frame (const std::string &buffer)
virtual void	error (uint32_t errorcode)
void	run ()
	Start and monitor I/O loop. Note that this is a blocking call and is usually executed within a thread by whatever creates the object. More...
void	connect_voice (snowflake guild_id, snowflake channel_id, bool self_mute=false, bool self_deaf=false)
	Connect to a voice channel. More...
void	disconnect_voice (snowflake guild_id)
	Disconnect from the connected voice channel on a guild. More...
voiceconn *	get_voice (snowflake guild_id)
	Get the dpp::voiceconn object for a specific guild on this shard. More...
virtual void	write (const std::string &data)
	Write to websocket. Encapsulates data in frames if the status is CONNECTED. More...
virtual bool	handle_buffer (std::string &buffer)
	Processes incoming frames from the SSL socket input buffer. More...
virtual void	close ()
	Close websocket. More...
uint64_t	get_bytes_out ()
uint64_t	get_bytes_in ()
std::string	get_cipher ()
void	read_loop ()
	Nonblocking I/O loop. More...

Public Attributes
class dpp::cluster *	creator
uint32_t	heartbeat_interval
time_t	last_heartbeat
uint32_t	shard_id
uint32_t	max_shards
std::thread::native_handle_type	thread_id
uint64_t	last_seq
std::string	token
uint32_t	intents
std::string	sessionid
std::mutex	voice_mutex
uint32_t	resumes
uint32_t	reconnects
double	websocket_ping
bool	ready
time_t	last_heartbeat_ack
websocket_protocol_t	protocol
std::unordered_map< snowflake, voiceconn * >	connecting_voice_channels
socket_callback_t	custom_readable_fd
	Attaching an additional file descriptor to this function will send notifications when there is data to read. More...
socket_callback_t	custom_writeable_fd
	Attaching an additional file descriptor to this function will send notifications when you are able to write to the socket. More...
socket_notification_t	custom_readable_ready
	This event will be called when you can read from the custom fd. More...
socket_notification_t	custom_writeable_ready
	This event will be called when you can write to a custom fd. More...

Protected Member Functions
void	disconnect_voice_internal (snowflake guild_id, bool send_json=true)
	Disconnect from the connected voice channel on a guild. More...
virtual void	connect ()
ws_state	get_state ()

Protected Attributes
bool	terminating
	True if the shard is terminating. More...
std::string	buffer
std::string	obuffer
bool	nonblocking
dpp::socket	sfd
opensslcontext *	ssl
std::string	cipher
time_t	last_tick
std::string	hostname
std::string	port
uint64_t	bytes_out
uint64_t	bytes_in
bool	plaintext

Friends
class	dpp::events::voice_state_update
	Needed so that voice_state_update can call dpp::discord_client::disconnect_voice_internal. More...
class	dpp::events::guild_create
	Needed so that guild_create can request member chunks if you have the correct intents. More...
class	dpp::cluster
	Needed to allow cluster::set_presence to use the ETF functions. More...

Detailed Description

Implements a discord client. Each discord_client connects to one shard and derives from a websocket client.

Constructor & Destructor Documentation

discord_client()

dpp::discord_client::discord_client	(	dpp::cluster *	_cluster,
		uint32_t	_shard_id,
		uint32_t	_max_shards,
		const std::string &	_token,
		uint32_t	intents = 0,
		bool	compressed = true,
		websocket_protocol_t	ws_protocol = ws_json
	)

Construct a new discord_client object.

Parameters

_cluster	The owning cluster for this shard
_shard_id	The ID of the shard to start
_max_shards	The total number of shards across all clusters
_token	The bot token to use for identifying to the websocket
intents	Privileged intents to use, a bitmask of values from dpp::intents
compressed	True if the received data will be gzip compressed
ws_protocol	Websocket protocol to use for the connection, JSON or ETF

~discord_client()

virtual dpp::discord_client::~discord_client ( )

virtual

Destructor

Member Function Documentation

clear_queue()

void dpp::discord_client::clear_queue

(

)

Clear the outbound message queue.

close()

virtual void dpp::websocket_client::close ( )

virtualinherited

Close websocket.

Reimplemented from dpp::ssl_client.

connect()

virtual void dpp::websocket_client::connect ( )

protectedvirtualinherited

(Re)connect

Reimplemented from dpp::ssl_client.

connect_voice()

void dpp::discord_client::connect_voice	(	snowflake	guild_id,
		snowflake	channel_id,
		bool	self_mute = false,
		bool	self_deaf = false
	)

Connect to a voice channel.

Parameters

guild_id	Guild where the voice channel is
channel_id	Channel ID of the voice channel
self_mute	True if the bot should mute itself
self_deaf	True if the bot should deafen itself

disconnect_voice()

void dpp::discord_client::disconnect_voice

(

snowflake

guild_id

)

Disconnect from the connected voice channel on a guild.

Parameters

guild_id

The guild who's voice channel you wish to disconnect from

disconnect_voice_internal()

void dpp::discord_client::disconnect_voice_internal ( snowflake  guild_id, bool  send_json = true  )

protected

Disconnect from the connected voice channel on a guild.

Parameters

guild_id	The guild who's voice channel you wish to disconnect from
send_json	True if we shold send a json message confirming we are leaving the VC Should be set to false if we already receive this message in an event.

error()

virtual void dpp::discord_client::error ( uint32_t  errorcode )

virtual

Handle a websocket error.

Parameters

errorcode

The error returned from the websocket

Reimplemented from dpp::websocket_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

get_channel_count()

uint64_t dpp::discord_client::get_channel_count

(

)

Get the Channel Count for this shard.

Returns

uint64_t channel count

get_cipher()

std::string dpp::ssl_client::get_cipher ( )

inherited

Get SSL cipher name

get_decompressed_bytes_in()

uint64_t dpp::discord_client::get_decompressed_bytes_in

(

)

Get decompressed total bytes received

get_guild_count()

uint64_t dpp::discord_client::get_guild_count

(

)

Get the Guild Count for this shard.

Returns

uint64_t guild count

get_member_count()

uint64_t dpp::discord_client::get_member_count

(

)

Get the Member Count for this shard.

Returns

uint64_t member count

get_queue_size()

size_t dpp::discord_client::get_queue_size

(

)

Get the size of the outbound message queue.

Returns

The size of the queue

get_state()

ws_state dpp::websocket_client::get_state ( )

protectedinherited

Get websocket state

Returns

websocket state

get_uptime()

dpp::utility::uptime dpp::discord_client::get_uptime

(

)

Returns the connection time of the shard.

Returns

dpp::utility::uptime Detail of how long the shard has been connected for

get_voice()

voiceconn * dpp::discord_client::get_voice

(

snowflake

guild_id

)

Get the dpp::voiceconn object for a specific guild on this shard.

Parameters

guild_id

The guild ID to retrieve the voice connection for

Returns

voiceconn* The voice connection for the guild, or nullptr if there is no voice connection to this guild.

handle_buffer()

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

virtualinherited

Processes incoming frames from the SSL socket input buffer.

Parameters

buffer

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

Reimplemented from dpp::ssl_client.

handle_event()

virtual void dpp::discord_client::handle_event ( const std::string &  event, json &  j, const std::string &  raw  )

virtual

Handle an event (opcode 0)

Parameters

event	Event name, e.g. MESSAGE_CREATE
j	JSON object for the event content
raw	Raw JSON event string

handle_frame()

virtual bool dpp::discord_client::handle_frame ( const std::string &  buffer )

virtual

Handle JSON from the websocket.

Parameters

buffer

The entire buffer content from the websocket client

Returns

True if a frame has been handled

Reimplemented from dpp::websocket_client.

is_connected()

bool dpp::discord_client::is_connected

(

)

Returns true if the shard is connected.

Returns

True if connected

log()

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

virtual

Log a message to whatever log the user is using. The logged message is passed up the chain to the on_log event in user code which can then do whatever it wants to do with it.

Parameters

severity	The log level from dpp::loglevel
msg	The log message to output

Reimplemented from dpp::ssl_client.

one_second_timer()

virtual void dpp::discord_client::one_second_timer ( )

virtual

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

Reimplemented from dpp::websocket_client.

queue_message()

void dpp::discord_client::queue_message	(	const std::string &	j,
		bool	to_front = false
	)

Queue a message to be sent via the websocket.

Parameters

j	The JSON data of the message to be sent
to_front	If set to true, will place the message at the front of the queue not the back (this is for urgent messages such as heartbeat, presence, so they can take precedence over chunk requests etc)

read_loop()

void dpp::ssl_client::read_loop ( )

inherited

Nonblocking I/O loop.

Exceptions

std::exception

Any std::exception (or derivative) thrown from read_loop() causes reconnection of the shard

run()

void dpp::discord_client::run

(

)

Start and monitor I/O loop. Note that this is a blocking call and is usually executed within a thread by whatever creates the object.

write()

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

virtualinherited

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

Parameters

data	The data to send.

Reimplemented from dpp::ssl_client.

Friends And Related Function Documentation

dpp::cluster

friend class dpp::cluster

friend

Needed to allow cluster::set_presence to use the ETF functions.

dpp::events::guild_create

friend class dpp::events::guild_create

friend

Needed so that guild_create can request member chunks if you have the correct intents.

dpp::events::voice_state_update

friend class dpp::events::voice_state_update

friend

Needed so that voice_state_update can call dpp::discord_client::disconnect_voice_internal.

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

connecting_voice_channels

std::unordered_map<snowflake, voiceconn*> dpp::discord_client::connecting_voice_channels

List of voice channels we are connecting to keyed by guild id

creator

class dpp::cluster* dpp::discord_client::creator

Owning cluster

custom_readable_fd

socket_callback_t 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

socket_notification_t dpp::ssl_client::custom_readable_ready

inherited

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

custom_writeable_fd

socket_callback_t 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

socket_notification_t dpp::ssl_client::custom_writeable_ready

inherited

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

heartbeat_interval

uint32_t dpp::discord_client::heartbeat_interval

Heartbeat interval for sending heartbeat keepalive

hostname

std::string dpp::ssl_client::hostname

protectedinherited

Hostname connected to

intents

uint32_t dpp::discord_client::intents

Privileged gateway intents

last_heartbeat

time_t dpp::discord_client::last_heartbeat

Last heartbeat

last_heartbeat_ack

time_t dpp::discord_client::last_heartbeat_ack

Last heartbeat ACK (opcode 11)

last_seq

uint64_t dpp::discord_client::last_seq

Last sequence number received, for resumes and pings

last_tick

time_t dpp::ssl_client::last_tick

protectedinherited

For timers

max_shards

uint32_t dpp::discord_client::max_shards

Total number of shards

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

plaintext

bool dpp::ssl_client::plaintext

protectedinherited

port

std::string dpp::ssl_client::port

protectedinherited

Port connected to

protocol

websocket_protocol_t dpp::discord_client::protocol

Current websocket protocol, currently either ETF or JSON

ready

bool dpp::discord_client::ready

True if READY or RESUMED has been received

reconnects

uint32_t dpp::discord_client::reconnects

Reconnection count

resumes

uint32_t dpp::discord_client::resumes

Resume count

sessionid

std::string dpp::discord_client::sessionid

Discord session id

sfd

dpp::socket dpp::ssl_client::sfd

protectedinherited

Raw file descriptor of connection

shard_id

uint32_t dpp::discord_client::shard_id

Shard ID of this client

ssl

opensslcontext* dpp::ssl_client::ssl

protectedinherited

Openssl opaque contexts

terminating

bool dpp::discord_client::terminating

protected

True if the shard is terminating.

thread_id

std::thread::native_handle_type dpp::discord_client::thread_id

Thread ID

token

std::string dpp::discord_client::token

Discord bot token

voice_mutex

std::mutex dpp::discord_client::voice_mutex

Mutex for voice connections map

websocket_ping

double dpp::discord_client::websocket_ping

Websocket latency in fractional seconds