Display the source code in core/atomic.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Function `core.atomic.atomicFetchSub`

Atomically subtracts mod from the value referenced by val and returns the value val held previously. This operation is both lock-free and atomic.


						
				T atomicFetchSub(MemoryOrder ms = MemoryOrder.seq, T)
				(
				

				  ref T val,
				

				  size_t mod
				

				) pure nothrow @nogc @trusted
				

				if ((__traits(isIntegral, T) || is(T == U*, U)) && !is(T == shared));
				

				

				T atomicFetchSub(MemoryOrder ms = MemoryOrder.seq, T)
				(
				

				  shared ref T val,
				

				  size_t mod
				

				) pure nothrow @nogc @trusted
				

				if (__traits(isIntegral, T) || is(T == U*, U));

Parameters

Name	Description
val	Reference to the value to modify.
mod	The value to subtract.

Returns

The value held previously by val.

Authors

Sean Kelly, Alex Rønne Petersen, Manu Evans

License

Boost License 1.0