From b46488ac2829b4f0bb02a76d49c158e43a7c8a16 Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Sun, 8 Mar 2020 14:25:15 +0100 Subject: [PATCH] Add a description of communication.h --- src/common/communication.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/common/communication.h b/src/common/communication.h index 8e4d6cf1..1dd9a582 100644 --- a/src/common/communication.h +++ b/src/common/communication.h @@ -35,7 +35,16 @@ #include "logging.h" -// These are for the serialization done by bitsery +// This file can be divided into four sections: +// - Data structures for passing events and their accompanying bitsery +// serializers. +// - Serialization functions for structs from `aeffectx.h`. +// - Convenience functions for serializing structs and sending them over +// sockets, and similar functions for receiving and deserializing those +// structs. +// - Two functions to send and passthrough `dispatch` (host -> plugin) and +// `audioMasterCallback` (plugin -> host) events since those should be handled +// in exactly the same way. /** * The maximum number of audio channels supported.