[Spice-devel] [PATCH spice-server v2 3/3] Add documentation for Dispatcher

[Uri Lublin]

On 09/05/2017 09:51 PM, Jonathon Jongsma wrote:
> ---
>   server/dispatcher.h | 140 +++++++++++++++++++++++++++++++++++++++++++---------
>   1 file changed, 116 insertions(+), 24 deletions(-)
> 
> diff --git a/server/dispatcher.h b/server/dispatcher.h
> index 862fc46b9..058032dbb 100644
> --- a/server/dispatcher.h
> +++ b/server/dispatcher.h
> @@ -35,6 +35,18 @@ typedef struct Dispatcher Dispatcher;
>   typedef struct DispatcherClass DispatcherClass;
>   typedef struct DispatcherPrivate DispatcherPrivate;
>   
> +/* A Dispatcher provides inter-thread communication by serializing messages.
> + * Currently the Dispatcher uses a unix socket (socketpair) for dispatching the
> + * messages.
> + *
> + * Message types are identified by a unique integer value must first by

typo: by -> be

> + * registered with the class (see dispatcher_register_handler()) before they
> + * can be sent. Sending threads can send a message using the

Looks good to me.

Thanks for documenting the dispatcher,
     Uri.