genode/repos/os/include/audio_out_session/rpc_object.h

117 lines
2.6 KiB
C
Raw Normal View History

2011-12-22 16:19:25 +01:00
/*
* \brief Server-side audio-session interface
2011-12-22 16:19:25 +01:00
* \author Sebastian Sumpf
* \date 2012-12-10
2011-12-22 16:19:25 +01:00
*/
/*
* Copyright (C) 2012-2017 Genode Labs GmbH
2011-12-22 16:19:25 +01:00
*
* This file is part of the Genode OS framework, which is distributed
* under the terms of the GNU Affero General Public License version 3.
2011-12-22 16:19:25 +01:00
*/
#ifndef _INCLUDE__AUDIO_OUT_SESSION__RPC_OBJECT_H_
#define _INCLUDE__AUDIO_OUT_SESSION__RPC_OBJECT_H_
#include <base/env.h>
2011-12-22 16:19:25 +01:00
#include <base/rpc_server.h>
#include <base/attached_ram_dataspace.h>
2011-12-22 16:19:25 +01:00
#include <audio_out_session/audio_out_session.h>
namespace Audio_out { class Session_rpc_object; }
2011-12-22 16:19:25 +01:00
class Audio_out::Session_rpc_object : public Genode::Rpc_object<Audio_out::Session,
Session_rpc_object>
{
protected:
Genode::Attached_ram_dataspace _ds; /* contains Audio_out stream */
Follow practices suggested by "Effective C++" The patch adjust the code of the base, base-<kernel>, and os repository. To adapt existing components to fix violations of the best practices suggested by "Effective C++" as reported by the -Weffc++ compiler argument. The changes follow the patterns outlined below: * A class with virtual functions can no longer publicly inherit base classed without a vtable. The inherited object may either be moved to a member variable, or inherited privately. The latter would be used for classes that inherit 'List::Element' or 'Avl_node'. In order to enable the 'List' and 'Avl_tree' to access the meta data, the 'List' must become a friend. * Instead of adding a virtual destructor to abstract base classes, we inherit the new 'Interface' class, which contains a virtual destructor. This way, single-line abstract base classes can stay as compact as they are now. The 'Interface' utility resides in base/include/util/interface.h. * With the new warnings enabled, all member variables must be explicitly initialized. Basic types may be initialized with '='. All other types are initialized with braces '{ ... }' or as class initializers. If basic types and non-basic types appear in a row, it is nice to only use the brace syntax (also for basic types) and align the braces. * If a class contains pointers as members, it must now also provide a copy constructor and assignment operator. In the most cases, one would make them private, effectively disallowing the objects to be copied. Unfortunately, this warning cannot be fixed be inheriting our existing 'Noncopyable' class (the compiler fails to detect that the inheriting class cannot be copied and still gives the error). For now, we have to manually add declarations for both the copy constructor and assignment operator as private class members. Those declarations should be prepended with a comment like this: /* * Noncopyable */ Thread(Thread const &); Thread &operator = (Thread const &); In the future, we should revisit these places and try to replace the pointers with references. In the presence of at least one reference member, the compiler would no longer implicitly generate a copy constructor. So we could remove the manual declaration. Issue #465
2017-12-21 15:42:15 +01:00
Genode::Signal_transmitter _progress { };
Genode::Signal_transmitter _alloc { };
Genode::Signal_context_capability _data_cap;
bool _stopped; /* state */
bool _progress_sigh; /* progress signal on/off */
bool _alloc_sigh; /* alloc signal on/off */
public:
Session_rpc_object(Genode::Env &env, Genode::Signal_context_capability data_cap)
:
_ds(env.ram(), env.rm(), sizeof(Stream)),
_data_cap(data_cap),
_stopped(true), _progress_sigh(false), _alloc_sigh(false)
{
_stream = _ds.local_addr<Stream>();
}
/**************
** Signals **
**************/
void progress_sigh(Genode::Signal_context_capability sigh) override
{
_progress.context(sigh);
_progress_sigh = true;
}
Genode::Signal_context_capability data_avail_sigh() override {
return _data_cap; }
void alloc_sigh(Genode::Signal_context_capability sigh) override
{
_alloc.context(sigh);
_alloc_sigh = true;
}
/***********************
** Session interface **
***********************/
void start() override { _stopped = false; }
void stop() override { _stopped = true; }
Genode::Dataspace_capability dataspace() { return _ds.cap(); }
/**********************************
** Session interface extensions **
**********************************/
/**
* Send 'progress' signal
*/
void progress_submit()
{
if (_progress_sigh)
_progress.submit();
}
/**
* Send 'alloc' signal
*/
void alloc_submit()
{
if (_alloc_sigh)
_alloc.submit();
}
/**
* Return true if client state is stopped
*/
bool stopped() const { return _stopped; }
/**
* Return true if client session is active
*/
bool active() const { return !_stopped; }
};
2011-12-22 16:19:25 +01:00
#endif /* _INCLUDE__AUDIO_OUT_SESSION__RPC_OBJECT_H_ */