mirror of
https://github.com/genodelabs/genode.git
synced 2024-12-28 17:48:53 +00:00
eba9c15746
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
158 lines
3.4 KiB
C++
158 lines
3.4 KiB
C++
/*
|
|
* \brief Client-side Audio_out-session
|
|
* \author Sebastian Sumpf
|
|
* \date 2012-12-20
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2012-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__AUDIO_OUT_SESSION__CLIENT_H_
|
|
#define _INCLUDE__AUDIO_OUT_SESSION__CLIENT_H_
|
|
|
|
#include <base/env.h>
|
|
#include <base/rpc_client.h>
|
|
#include <base/attached_dataspace.h>
|
|
#include <audio_out_session/audio_out_session.h>
|
|
|
|
namespace Audio_out {
|
|
struct Signal;
|
|
struct Session_client;
|
|
}
|
|
|
|
|
|
struct Audio_out::Signal
|
|
{
|
|
Genode::Signal_receiver recv { };
|
|
Genode::Signal_context context { };
|
|
Genode::Signal_context_capability cap;
|
|
|
|
Signal() : cap(recv.manage(&context)) { }
|
|
~Signal() { recv.dissolve(&context); }
|
|
|
|
void wait() { recv.wait_for_signal(); }
|
|
};
|
|
|
|
|
|
class Audio_out::Session_client : public Genode::Rpc_client<Session>
|
|
{
|
|
private:
|
|
|
|
Genode::Attached_dataspace _shared_ds;
|
|
|
|
Signal _progress { };
|
|
Signal _alloc { };
|
|
|
|
Genode::Signal_transmitter _data_avail;
|
|
|
|
public:
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* \param rm region map for attaching shared buffer
|
|
* \param session session capability
|
|
* \param alloc_signal true, install 'alloc_signal' receiver
|
|
* \param progress_signal true, install 'progress_signal' receiver
|
|
*/
|
|
Session_client(Genode::Region_map &rm,
|
|
Genode::Capability<Session> session,
|
|
bool alloc_signal, bool progress_signal)
|
|
:
|
|
Genode::Rpc_client<Session>(session),
|
|
_shared_ds(rm, call<Rpc_dataspace>()),
|
|
_data_avail(call<Rpc_data_avail_sigh>())
|
|
{
|
|
_stream = _shared_ds.local_addr<Stream>();
|
|
|
|
if (progress_signal)
|
|
progress_sigh(_progress.cap);
|
|
|
|
if (alloc_signal)
|
|
alloc_sigh(_alloc.cap);
|
|
}
|
|
|
|
|
|
/*************
|
|
** Signals **
|
|
*************/
|
|
|
|
void progress_sigh(Genode::Signal_context_capability sigh) {
|
|
call<Rpc_progress_sigh>(sigh); }
|
|
|
|
void alloc_sigh(Genode::Signal_context_capability sigh) {
|
|
call<Rpc_alloc_sigh>(sigh); }
|
|
|
|
Genode::Signal_context_capability data_avail_sigh() {
|
|
return Genode::Signal_context_capability(); }
|
|
|
|
|
|
/***********************
|
|
** Session interface **
|
|
***********************/
|
|
|
|
void start()
|
|
{
|
|
call<Rpc_start>();
|
|
|
|
/* reset tail pointer */
|
|
stream()->reset();
|
|
}
|
|
|
|
void stop() { call<Rpc_stop>(); }
|
|
|
|
|
|
/**********************************
|
|
** Session interface extensions **
|
|
**********************************/
|
|
|
|
/**
|
|
* Wait for progress signal
|
|
*/
|
|
void wait_for_progress()
|
|
{
|
|
if (!_progress.cap.valid()) {
|
|
Genode::warning("Progress signal is not installed, will not block "
|
|
"(enable in 'Audio_out::Connection')");
|
|
return;
|
|
}
|
|
|
|
_progress.wait();
|
|
}
|
|
|
|
/**
|
|
* Wait for allocation signal
|
|
*
|
|
* This can be used when the 'Stream' is full and the application wants
|
|
* to block until the stream has free elements again.
|
|
*/
|
|
void wait_for_alloc()
|
|
{
|
|
if (!_alloc.cap.valid()) {
|
|
Genode::warning("Alloc signal is not installed, will not block "
|
|
"(enable in 'Audio_out::Connection')");
|
|
return;
|
|
}
|
|
|
|
_alloc.wait();
|
|
}
|
|
|
|
/**
|
|
* Submit a packet
|
|
*/
|
|
void submit(Packet *packet)
|
|
{
|
|
bool empty = stream()->empty();
|
|
|
|
packet->_submit();
|
|
if (empty)
|
|
_data_avail.submit();
|
|
}
|
|
};
|
|
|
|
#endif /* _INCLUDE__AUDIO_OUT_SESSION__CLIENT_H_ */
|