[Spice-devel] [spice-streaming-agent PATCH] handle_stream_error: add comment for inheriting struct

[Frediano Ziglio]

> 
> Introduced in 548577dc8adae1a558
> 
> Signed-off-by: Uri Lublin <uril at redhat.com>
> ---
>  src/spice-streaming-agent.cpp | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/src/spice-streaming-agent.cpp b/src/spice-streaming-agent.cpp
> index b39782c..e25d47a 100644
> --- a/src/spice-streaming-agent.cpp
> +++ b/src/spice-streaming-agent.cpp
> @@ -145,6 +145,11 @@ static void handle_stream_error(size_t len)
>                                   std::to_string(sizeof(StreamMsgNotifyError))
>                                   + ")");
>      }
>  
> +    // This struct inherits StreamMsgNotifyError. Its memory layout is:
> +    // offset 0: StreamMsgNotifyError.error_code (a uint32_t)
> +    // offset 4: StreamMsgNotifyError.msg and also msg.msg (a
> uint8_t[1024]).
> +    // Both StreamMsgNotifyError.msg and msg.msg point to the same
> +    // memory location (practically local msg overrides inherited msg).
>      struct : StreamMsgNotifyError {
>          uint8_t msg[1024];
>      } msg;

When I sent my suggestion I didn't wanted to clash with inherited field,
just didn't invented a new name.
Maybe would be easier and more clear to rename to msg_buffer or similar
to avoid the confusion?

Frediano