Differential D14 Diff 14406 source/simulation2/system/SimSynchronization.h

Changeset View

Standalone View

source/simulation2/system/SimSynchronization.h

This file was added.

				/* Copyright (C) 2020 Wildfire Games.
				* This file is part of 0 A.D.
				*
				* 0 A.D. 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.
				*
				* 0 A.D. is distributed in the hope that it will be useful,
				* but WITHOUT ANY WARRANTY; without even the implied warranty of
				* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
				* GNU General Public License for more details.
				*
				* You should have received a copy of the GNU General Public License
				* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
				*/

				#ifndef INCLUDED_SIM_SYNCHRONIZATION
				#define INCLUDED_SIM_SYNCHRONIZATION

				/**
				* Some simulation operations are threaded.
				* To avoid logical errors, this holds the status of all relevant operations,
				* so that components can ENSURE() they're only doing operations in the correct state(s).
				* This is intended to reveal programming errors, not to actually be a synchronization mechanism.
				*
				* Though data in this class is really intended to be written to from the main thread,
				* variables are atomic to ensure that operations are not reordered in a confusing way.
				*/
				struct SSimSynchronization
				{
				NONCOPYABLE(SSimSynchronization);

				SSimSynchronization() : m_ComputingPaths(false) {};

				void Reset() {
				m_ComputingPaths = false;
				}

				/**
				* When this is true, the pathfinders are computing paths. In practice:
				* - Nothing can change the pathfinder grid.
				* - Nothing can change obstruction state (neither the obstructions nor the manager's).
				* This means no entities can be moved, killed, created, etc.
				*/
				std::atomic<bool> m_ComputingPaths;
				};
				StanUnsubmitted Not Done Inline Actions #include <atomic> Stan: ``` #include <atomic> ```

				#endif // INCLUDED_SIM_SYNCHRONIZATION