genode/repos/base/include/signal_session/source.h
Norman Feske eaac3cc1bd Revised API documentation
This patch curates the API documentation to become suitable for the
functional specificaton, which is partially generated from the header
files.
2015-04-09 16:04:46 +02:00

76 lines
1.7 KiB
C++

/*
* \brief Signal-source interface
* \author Norman Feske
* \date 2010-02-03
*
* This file is only included by 'signal_session/signal_session.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.
*/
/*
* Copyright (C) 2010-2013 Genode Labs GmbH
*
* This file is part of the Genode OS framework, which is distributed
* under the terms of the GNU General Public License version 2.
*/
#ifndef _INCLUDE__SIGNAL_SESSION__SOURCE_H_
#define _INCLUDE__SIGNAL_SESSION__SOURCE_H_
#include <base/rpc.h>
namespace Genode { struct Signal_source; }
/**
* Blocking part of the signal-session interface
*
* The blocking 'wait_for_signal()' operation cannot be part of the
* signal-session interface because otherwise, context allocations or
* signal submissions would not be possible while blocking for signals.
* Therefore, the blocking part is implemented a separate interface,
* which can be used by an independent thread.
*/
struct Genode::Signal_source
{
class Signal
{
private:
long _imprint;
int _num;
public:
Signal(long imprint, int num) :
_imprint(imprint),
_num(num)
{ }
Signal() : _imprint(0), _num(0) { }
long imprint() { return _imprint; }
int num() { return _num; }
};
virtual ~Signal_source() { }
/**
* Wait for signal
*/
virtual Signal wait_for_signal() = 0;
/*********************
** RPC declaration **
*********************/
GENODE_RPC(Rpc_wait_for_signal, Signal, wait_for_signal);
GENODE_RPC_INTERFACE(Rpc_wait_for_signal);
};
#endif /* _INCLUDE__SIGNAL_SESSION__SOURCE_H_ */