Request's return context. More...

#include <discord-response.h>

Collaboration diagram for discord_ret_webhook:

Data Fields
void *	data

void(*	cleanup )(struct discord client, void data)

const void *	keep

bool	high_priority

void(*	fail )(struct discord client, struct discord_response resp)

void(*	done )(struct discord client, struct discord_response resp, const struct discord_webhook *ret)

struct discord_webhook *	sync

Detailed Description

Request's return context.

Examples: webhook.c.

Field Documentation

◆ data

void* discord_ret_webhook::data

user arbitrary data to be passed to done or fail callbacks

◆ cleanup

void(* discord_ret_webhook::cleanup) (struct discord *client, void *data)

cleanup method to be called for data, once its no longer being referenced

◆ keep

const void* discord_ret_webhook::keep

Concord callback parameter the client wish to keep reference

◆ high_priority

bool discord_ret_webhook::high_priority

if true then request will be prioritized over already enqueued requests

◆ fail

void(* discord_ret_webhook::fail) (struct discord *client, struct discord_response *resp)

optional callback to be executed on a failed request

◆ done

void(* discord_ret_webhook::done) (struct discord *client, struct discord_response *resp, const struct discord_webhook *ret)

optional callback to be executed on a successful request

◆ sync

struct discord_webhook* discord_ret_webhook::sync

if an address is provided, then request will block the thread and perform on-spot. On success the response object will be written to the address, unless enabled with DISCORD_SYNC_FLAG

Examples: webhook.c.

The documentation for this struct was generated from the following file:

include/discord-response.h

Data Fields