From 05b7c3ae3dd894b73ef737f94d5fd6f09ec77485 Mon Sep 17 00:00:00 2001 From: Christian Helmuth Date: Wed, 6 Mar 2013 11:23:52 +0100 Subject: [PATCH] base-foc: Improve documentation of signal_session Fixes #566. --- base-foc/include/signal_session/source_client.h | 11 ++++++----- base-foc/include/signal_session/source_rpc_object.h | 11 +++-------- 2 files changed, 9 insertions(+), 13 deletions(-) diff --git a/base-foc/include/signal_session/source_client.h b/base-foc/include/signal_session/source_client.h index cbc73b2ca..28bfbbe55 100644 --- a/base-foc/include/signal_session/source_client.h +++ b/base-foc/include/signal_session/source_client.h @@ -5,11 +5,12 @@ * \date 2010-02-03 * * On Fiasco.OC, the signal source server does not provide a blocking - * 'wait_for_signal' function because this kernel does no support - * out-of-order IPC replies. Instead, we use an IRQ kernel-object - * to let the client block until a signal is present at the - * server. The IRQ object gets initialized with the first - * call of 'wait_for_signal()'. + * 'wait_for_signal' function because this kernel does not support out-of-order + * IPC replies. Instead, we use an IRQ kernel-object to let the client block + * until a signal is present at the server. + * + * We request the IRQ object capability and attach to the IRQ on construction + * of the 'Signal_source_client' object. */ /* diff --git a/base-foc/include/signal_session/source_rpc_object.h b/base-foc/include/signal_session/source_rpc_object.h index 3ad5f3763..15741ed24 100644 --- a/base-foc/include/signal_session/source_rpc_object.h +++ b/base-foc/include/signal_session/source_rpc_object.h @@ -2,11 +2,6 @@ * \brief Signal-source server interface * \author Norman Feske * \date 2010-02-03 - * - * This file is only included by 'signal_session/server.h' and relies on the - * headers included there. No include guards are needed. It is a separate - * header file to make it easily replaceable by a platform-specific - * implementation. */ /* @@ -16,8 +11,8 @@ * under the terms of the GNU General Public License version 2. */ -#ifndef _INCLUDE__SIGNAL_SESSION__SOURCE_SERVER_H_ -#define _INCLUDE__SIGNAL_SESSION__SOURCE_SERVER_H_ +#ifndef _INCLUDE__SIGNAL_SESSION__SOURCE_RPC_OBJECT_H_ +#define _INCLUDE__SIGNAL_SESSION__SOURCE_RPC_OBJECT_H_ #include #include @@ -39,4 +34,4 @@ namespace Genode { }; } -#endif /* _INCLUDE__SIGNAL_SESSION__SOURCE_SERVER_H_ */ +#endif /* _INCLUDE__SIGNAL_SESSION__SOURCE_RPC_OBJECT_H_ */