genode/repos/os/include/input_session/input_session.h
2017-05-31 13:16:21 +02:00

87 lines
1.9 KiB
C++

/*
* \brief Input session interface
* \author Norman Feske
* \date 2006-08-16
*/
/*
* Copyright (C) 2006-2017 Genode Labs GmbH
*
* This file is part of the Genode OS framework, which is distributed
* under the terms of the GNU Affero General Public License version 3.
*/
#ifndef _INCLUDE__INPUT_SESSION__INPUT_SESSION_H_
#define _INCLUDE__INPUT_SESSION__INPUT_SESSION_H_
#include <dataspace/capability.h>
#include <base/rpc_server.h>
#include <session/session.h>
#include <base/signal.h>
namespace Input { struct Session; }
struct Input::Session : Genode::Session
{
/**
* \noapi
*/
static const char *service_name() { return "Input"; }
/*
* An input session consumes a dataspace capability for the server's
* session-object allocation, a dataspace capability for the input
* buffer, and its session capability.
*/
enum { CAP_QUOTA = 3 };
virtual ~Session() { }
/**
* Return capability to event buffer dataspace
*/
virtual Genode::Dataspace_capability dataspace() = 0;
/**
* Request input state
*
* \return true if new events are available
*/
virtual bool pending() const = 0;
/**
* Request input state
*
* \noapi
* \deprecated use 'pending' instead
*/
bool is_pending() const { return pending(); }
/**
* Flush pending events to event buffer
*
* \return number of flushed events
*/
virtual int flush() = 0;
/**
* Register signal handler to be notified on arrival of new input
*/
virtual void sigh(Genode::Signal_context_capability) = 0;
/*********************
** RPC declaration **
*********************/
GENODE_RPC(Rpc_dataspace, Genode::Dataspace_capability, dataspace);
GENODE_RPC(Rpc_pending, bool, pending);
GENODE_RPC(Rpc_flush, int, flush);
GENODE_RPC(Rpc_sigh, void, sigh, Genode::Signal_context_capability);
GENODE_RPC_INTERFACE(Rpc_dataspace, Rpc_pending, Rpc_flush, Rpc_sigh);
};
#endif /* _INCLUDE__INPUT_SESSION__INPUT_SESSION_H_ */