REST API

Wrapper to the Discord REST API. More...

Collaboration diagram for REST API:

Modules
	Request's handling
	Store, manage and dispatch individual requests.

Files
file	discord-request.h
	Generic macros for initializing a discord_attributes.

Data Structures
struct	discord_rest
	The handle used for interfacing with Discord's REST API. More...

Functions
CCORDcode	discord_rest_init (struct discord_rest *rest, const char token[])
	Initialize an REST handle. More...
void	discord_rest_cleanup (struct discord_rest *rest)
	Free an REST handle. More...
CCORDcode	discord_rest_run (struct discord_rest *rest, const struct discord_attributes *req, const struct ccord_szbuf *body, const enum http_method method, const char endpoint_fmt[],...) PRINTF_LIKE(5
	Perform a request to Discord. More...
CCORDcode void	discord_rest_stop_buckets (struct discord_rest *rest)
	Stop all bucket's on-going, pending and timed-out requests. More...

Detailed Description

Wrapper to the Discord REST API.

Function Documentation

discord_rest_init()

CCORDcode discord_rest_init	(	struct discord_rest *	rest,
		const char	token[]
	)

Initialize an REST handle.

Structure used for interfacing with the Discord's REST API

Parameters

rest	the REST handle to be initialized
token	the bot token

Returns

CCORDcode value for how the operation went, CCORD_OK means nothing out of the ordinary

discord_rest_cleanup()

void discord_rest_cleanup

(

struct discord_rest *

rest

)

Free an REST handle.

Parameters

rest	the handle initialized with discord_rest_init()

discord_rest_run()

CCORDcode discord_rest_run	(	struct discord_rest *	rest,
		const struct discord_attributes *	req,
		const struct ccord_szbuf *	body,
		const enum http_method	method,
		const char	endpoint_fmt[],
			...
	)

Perform a request to Discord.

This functions is a selector over discord_rest_run() or discord_rest_run_requestor()

Parameters

rest	the handle initialized with discord_rest_init()
req	return object of request
body	the body sent for methods that require (ex: post), leave as null if unecessary
method	the method in opcode format of the request being sent
endpoint_fmt	the printf-like endpoint formatting string

Returns

CCORDcode value for how the operation went, CCORD_OK means nothing out of the ordinary

Note

if sync is set then this function will block the thread and perform it immediately

discord_rest_stop_buckets()

CCORDcode void discord_rest_stop_buckets

(

struct discord_rest *

rest

)

Stop all bucket's on-going, pending and timed-out requests.

The requests will be moved over to client's 'queues->recycling' queue

Parameters

rest	the handle initialized with discord_rest_init()