V2.0.0

[lcsmuller]

See Also

#69

What?

1. Breaking changes
   1.1. Struct wrapping of callback parameters
   1.2. Requests are now performed in enqueue order
   1.3. Replace DISCORD_GATEWAY_EVENTS_* macro prefix with DISCORD_EV_*
   1.4. Rewrite discord_set_on_commands() function signature
2. Features
   2.1. Add functions for all Gateway commands
   2.2. Add discord_claim() and discord_unclaim() to grant client's ownership of Concord parameters, and override automatic cleanup
3. Bug Fixes
   3.1. Regression where WebSockets sessions were not being resumed
   3.2. Requests can now be sent in parallel even while there are requests being performed from the main-thread
4. Improve modularization and reduce code duplication for discord-gateway.c
5. Ratelimiting rewrite using the Timer API from Timer Wrapper Functions, and Refactoring #58
6. Rewrite Message Commands handling to perform its register and search operations on a hashtable
7. Showcase minimalistic slash-commands usage at README.md
8. Replace all Adapter references with REST

Why?

1. Breaking changes
   1.1. Struct wrapping of callback parameters

• Adding extra fields to structs won't break future builds, but adding extra parameters to a function would. Event data are now wrapped and accessed from structs
• The callbacks struct's ownership can now be granted to the user and passed around different callbacks, removing the complexity of having to create duplicates
  1.2. It is intuitively expected that the order of requests respects the order of their enqueue
  1.3. Reduce length for macros that are very often used
  1.4. The previous method of NULL-terminating a va_list of message commands was non-intuitive

2. Features
   2.1. On-going effort of covering the entire Discord API
   2.2. Allows client to keep ownership of Concord callback's parameter, rather than having to tediously clone the data of interest if they wanted to keep it between callbacks
3. Bug Fixes
   3.1. Sessions should be resumed when possible, rather than starting a new one on every reconnect
   3.2. Before user had to opt between choosing between synchronous or asynchronous requests, now they can do both simultaneously
4. Improve navigation by splitting discord-gateway.c into smaller files
5. Use of Concord's Timer API for Ratelimiting will ensure any regressions are swiftly noticed
6. Keep its interface familiar discord-rest_ratelimit.c and discord-refcount.c
7. Showcase slash-commands support and how to get started with a minimum reproducible example
8. Adapter was a misnomer back from Orca development, replacing it with REST gives a better description of it being a interface to the Discord's REST API

How?

1. Breaking changes
   1.1. By wrapping callback parameters in structs:
   before v2.0.0

   void on_message_reaction_add(struct discord *client,
                                u64snowflake user_id,
                                u64snowflake channel_id,
                                u64snowflake message_id,
                                u64snowflake guild_id,
                                const struct discord_guild_member *member,
                                const struct discord_emoji *emoji)
   {
       printf("%lld\n", user_id); 
   }
   
   void on_message_delete_bulk(struct discord *client,
                               const struct snowflakes *ids,
                               u64snowflake channel_id,
                               u64snowflake guild_id)
   {
       if (ids->size)
           printf("%lld\n", ids->array[0]); 
   }

   after v2.0.0

   void on_message_reaction_add(struct discord *client, const struct discord_message_reaction_add *event)
   {
       printf("%lld\n", event->user_id); 
   }
   
   void on_message_delete_bulk(struct discord *client,
                               const struct discord_message_delete_bulk *event)
   {
       if (event->ids->size)
           printf("%lld\n", event->ids->array[0]);
   }

1.2. By limiting to only one request per-bucket being sent at a time
1.3. Edit previous macros at gencodecs/api/gateway.pre.h
1.4. Rewrite discord_set_on_commands() function signature
before v2.0.0

discord_set_on_commands(client, callback, "foo", "bar", "baz", NULL);

after v2.0.0

char *cmds[] = { "foo", "bar", "baz" };
discord_set_on_commands(client, cmds, sizeof(cmds) / sizeof *cmds, callback);

2. Features
   2.1. See 1498dc3
   2.2. Add discord_claim() and discord_unclaim() to grant client's ownership of Concord parameters, and override automatic cleanup
3. See 23f03b7
4. See f3e9ba5