dpp::event_dispatch_t Struct Reference

Base event parameter struct. Each event you receive from the library will have its parameter derived from this class. The class contains the raw event data, and a pointer to the current shard's dpp::discord_client object. You can also use this object to cancel the current event, meaning that any listeners after yours do not get notified of the current event if you call it. More...

#include <dispatcher.h>

Inheritance diagram for dpp::event_dispatch_t:

Collaboration diagram for dpp::event_dispatch_t:

Public Member Functions
	event_dispatch_t ()=default
	Construct a new event_dispatch_t object. More...
	event_dispatch_t (const event_dispatch_t &rhs)=default
	Construct a new event_dispatch_t object. More...
	event_dispatch_t (event_dispatch_t &&rhs)=default
	Construct a new event_dispatch_t object. More...
	event_dispatch_t (dpp::cluster *creator, uint32_t shard_id, const std::string &raw)
	Construct a new event_dispatch_t object. More...
discord_client *	from () const
	Returns the shard object for the events shard id. More...
	event_dispatch_t (dpp::cluster *creator, uint32_t shard_id, std::string &&raw)
	Construct a new event_dispatch_t object. More...
event_dispatch_t &	operator= (const event_dispatch_t &rhs)=default
	Copy another event_dispatch_t object. More...
event_dispatch_t &	operator= (event_dispatch_t &&rhs)=default
	Move from another event_dispatch_t object. More...
virtual	~event_dispatch_t ()=default
	Destroy an event_dispatch_t object Protected because this object is to be derived from. More...
const event_dispatch_t &	cancel_event () const
	Cancels the event in progress. Any other attached lambdas for this event after this one are not called. More...
event_dispatch_t &	cancel_event ()
	Cancels the event in progress. Any other attached lambdas for this event after this one are not called. More...
bool	is_cancelled () const
	Returns true if the event is cancelled. Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state). More...

Public Attributes
std::string	raw_event = {}
	Raw event data. If you are using json on your websocket, this will contain json, and if you are using ETF as your websocket protocol, it will contain raw ETF data. More...
uint32_t	shard = 0
	Shard the event came from. More...
dpp::cluster *	owner = nullptr
	Cluster owning the event dispatch. More...
bool	cancelled = false
	Whether the event was cancelled using cancel_event(). More...

Detailed Description

Base event parameter struct. Each event you receive from the library will have its parameter derived from this class. The class contains the raw event data, and a pointer to the current shard's dpp::discord_client object. You can also use this object to cancel the current event, meaning that any listeners after yours do not get notified of the current event if you call it.

Constructor & Destructor Documentation

event_dispatch_t() [1/5]

dpp::event_dispatch_t::event_dispatch_t ( )

default

Construct a new event_dispatch_t object.

event_dispatch_t() [2/5]

dpp::event_dispatch_t::event_dispatch_t ( const event_dispatch_t &  rhs )

default

Construct a new event_dispatch_t object.

Parameters

rhs	event_dispatch_t object to copy from

event_dispatch_t() [3/5]

dpp::event_dispatch_t::event_dispatch_t ( event_dispatch_t &&  rhs )

default

Construct a new event_dispatch_t object.

Parameters

rhs	event_dispatch_t object to move from

event_dispatch_t() [4/5]

dpp::event_dispatch_t::event_dispatch_t	(	dpp::cluster *	creator,
		uint32_t	shard_id,
		const std::string &	raw
	)

Construct a new event_dispatch_t object.

Parameters

shard_id	The shard the event originated on.
raw	Raw event data as JSON or ETF

event_dispatch_t() [5/5]

dpp::event_dispatch_t::event_dispatch_t	(	dpp::cluster *	creator,
		uint32_t	shard_id,
		std::string &&	raw
	)

Construct a new event_dispatch_t object.

Parameters

shard_id	The shard the event originated on.
raw	Raw event data as JSON or ETF

~event_dispatch_t()

virtual dpp::event_dispatch_t::~event_dispatch_t ( )

virtualdefault

Destroy an event_dispatch_t object Protected because this object is to be derived from.

Member Function Documentation

cancel_event() [1/2]

event_dispatch_t & dpp::event_dispatch_t::cancel_event

(

)

Cancels the event in progress. Any other attached lambdas for this event after this one are not called.

Warning

This will modify the event object in a non-thread-safe manner.

Returns

const event_dispatch_t& reference to self for chaining

cancel_event() [2/2]

const event_dispatch_t & dpp::event_dispatch_t::cancel_event

(

)

const

Cancels the event in progress. Any other attached lambdas for this event after this one are not called.

Warning

This will modify the event object in a non-thread-safe manner.

Returns

const event_dispatch_t& reference to self for chaining

from()

discord_client * dpp::event_dispatch_t::from

(

)

const

Returns the shard object for the events shard id.

Returns

discord client object

is_cancelled()

bool dpp::event_dispatch_t::is_cancelled

(

)

const

Returns true if the event is cancelled. Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state).

Returns

true if the event is cancelled

operator=() [1/2]

event_dispatch_t & dpp::event_dispatch_t::operator= ( const event_dispatch_t &  rhs )

default

Copy another event_dispatch_t object.

Parameters

rhs	The event to copy from

operator=() [2/2]

event_dispatch_t & dpp::event_dispatch_t::operator= ( event_dispatch_t &&  rhs )

default

Move from another event_dispatch_t object.

Parameters

rhs	The event to move from

Member Data Documentation

cancelled

bool dpp::event_dispatch_t::cancelled = false

mutable

Whether the event was cancelled using cancel_event().

owner

dpp::cluster* dpp::event_dispatch_t::owner = nullptr

Cluster owning the event dispatch.

raw_event

std::string dpp::event_dispatch_t::raw_event = {}

Raw event data. If you are using json on your websocket, this will contain json, and if you are using ETF as your websocket protocol, it will contain raw ETF data.

shard

uint32_t dpp::event_dispatch_t::shard = 0

Shard the event came from.