discord_ret_channel Struct Reference

Request's return context. More...

#include <discord-response.h>

Collaboration diagram for discord_ret_channel:

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_channel *ret)
struct discord_channel *	sync

Detailed Description

Request's return context.

Examples

channel.c, and manual-dm.c.

Field Documentation

data

void* discord_ret_channel::data

user arbitrary data to be passed to done or fail callbacks

cleanup

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

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

keep

const void* discord_ret_channel::keep

Concord callback parameter the client wish to keep reference

high_priority

bool discord_ret_channel::high_priority

if true then request will be prioritized over already enqueued requests

fail

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

optional callback to be executed on a failed request

done

void(* discord_ret_channel::done) (struct discord *client, struct discord_response *resp, const struct discord_channel *ret)

optional callback to be executed on a successful request

Examples

channel.c.

sync

struct discord_channel* discord_ret_channel::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

manual-dm.c.

---

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

• include/discord-response.h