lumiera_/tests/library/sync-waiting-test.cpp
Ichthyostega 806db414dd Copyright: clarify and simplify the file headers
* Lumiera source code always was copyrighted by individual contributors
 * there is no entity "Lumiera.org" which holds any copyrights
 * Lumiera source code is provided under the GPL Version 2+

== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''

The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!

The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.
2024-11-17 23:42:55 +01:00

118 lines
3.1 KiB
C++
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
SyncWaiting(Test) - check the monitor object based wait/notification
Copyright (C)
2008, Hermann Vosseler <Ichthyostega@web.de>
  **Lumiera** is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by the
  Free Software Foundation; either version 2 of the License, or (at your
  option) any later version. See the file COPYING for further details.
* *****************************************************************/
/** @file sync-waiting-test.cpp
** unit test \ref SyncWaiting_test
*/
#include "lib/test/run.hpp"
#include "lib/error.hpp"
#include "lib/thread.hpp"
#include "lib/sync.hpp"
#include <atomic>
using test::Test;
using std::atomic_uint;
using std::atomic_bool;
using std::this_thread::sleep_for;
using std::chrono_literals::operator ""ms;
namespace lib {
namespace test{
namespace { // test subject...
/** demonstrates how to wait on a simple boolean flag */
class SyncOnBool
: public Sync<NonrecursiveLock_Waitable>
{
atomic_uint sum_{0}, input_{0};
atomic_bool got_new_data_{false};
public:
void getIt()
{
Lock await{this, [&]{ return bool(got_new_data_); }};
sum_ += input_;
}
void provide (uint val)
{
Lock sync{this};
input_ = val;
got_new_data_ = true;
sync.notify_all();
}
/** harvesting the result...*/
uint result () { return sum_; }
};
}//(End) test subject.
/************************************************************************//**
* @test concurrent waiting and notification, implemented via object monitor.
* This test covers the second part of the monitor pattern, which builds upon
* the locking part, additionally using an embedded condition. Two interwoven
* threads are created, both blocked until a start value is given. Once awakened,
* each thread should add the start value to a common sum field.
* @see SyncLocking_test
* @see sync.hpp
*/
class SyncWaiting_test : public Test
{
virtual void
run (Arg)
{
seedRand();
SyncOnBool token;
ThreadJoinable ping ("SyncWaiting ping", [&]{ token.getIt(); });
ThreadJoinable pong ("SyncWaiting pong", [&]{ token.getIt(); });
CHECK (ping);
CHECK (pong);
CHECK (0 == token.result());
sleep_for (100ms); // if the threads don't block correctly, they've missed their chance by now...
// kick off the notification cascade...
uint val = rani(1000);
token.provide (val);
// wait for the two Threads to finish their handshake
pong.join();
ping.join();
CHECK (2*val == token.result());
}
};
/** Register this test class... */
LAUNCHER (SyncWaiting_test, "unit common");
}} // namespace lib::test