AtomicUInt

public final class AtomicUInt

  • Declaration

    Swift

    public convenience init(_ initialValue: RawValue)
    Show on GitHub

  • Atomically loads and returns the current value of the atomic variable pointed to by the receiver. The operation is atomic read operation.

    Declaration

    Swift

    public func load(order: AtomicLoadMemoryOrder = .seqcst) -> RawValue

    Parameters

    order

    The memory synchronization ordering for this operation.

    Return Value

    The value stored in the receiver.

    Show on GitHub

  • Atomically replaces the value of the atomic variable pointed to by the receiver with desired. The operation is atomic write operation.

    Declaration

    Swift

    public func store(_ desired: RawValue, order: AtomicStoreMemoryOrder = .seqcst)

    Parameters

    desired

    The value to replace the receiver with.
    order

    The memory synchronization ordering for this operation.
    Show on GitHub

  • Atomically replaces the value pointed by the receiver with desired and returns the value the receiver held previously. The operation is read-modify-write operation.

    Declaration

    Swift

    public func exchange(_ desired: RawValue, order: AtomicMemoryOrder = .seqcst) -> RawValue

    Parameters

    desired

    The value to replace the receiver with.
    order

    The memory synchronization ordering for this operation.

    Return Value

    The value previously stored in the receiver.

    Show on GitHub

  • Atomically compares the value pointed to by the receiver with the value pointed to by expected, and if those are equal, replaces the former with desired (performs read-modify-write operation). Otherwise, loads the actual value pointed to by the receiver into *expected (performs load operation).

    Declaration

    Swift

    @discardableResult
public func compareExchange(
    _ expected: UnsafeMutablePointer<RawValue>,
    _ desired: RawValue,
    order: AtomicMemoryOrder = .seqcst,
    loadOrder: AtomicLoadMemoryOrder? = nil
) -> Bool

    Parameters

    expected

    The value expected to be found in the receiver.
    desired

    The value to store in the receiver if it is as expected.
    order

    The memory synchronization ordering for the read-modify-write operation if the comparison succeeds.
    loadOrder

    The memory synchronization ordering for the load operation if the comparison fails. Cannot specify stronger ordering than order.

    Return Value

    The result of the comparison: true if current value was equal to *expected, false otherwise.

    Show on GitHub

  • Atomically compares the value pointed to by the receiver with the value pointed to by expected, and if those are equal, replaces the former with desired (performs read-modify-write operation). Otherwise, loads the actual value pointed to by the receiver into *expected (performs load operation).

    Declaration

    Swift

    @discardableResult
public func compareExchange(
    _ expected: RawValue,
    _ desired: RawValue,
    order: AtomicMemoryOrder = .seqcst,
    loadOrder: AtomicLoadMemoryOrder? = nil
) -> RawValue

    Parameters

    expected

    The value expected to be found in the receiver.
    desired

    The value to store in the receiver if it is as expected.
    order

    The memory synchronization ordering for the read-modify-write operation if the comparison succeeds.
    loadOrder

    The memory synchronization ordering for the load operation if the comparison fails. Cannot specify stronger ordering than order.

    Return Value

    The value actually stored in the receiver. If exchange succeeded, this will be equal to expected.

    Show on GitHub

  • Atomically compares the value pointed to by the receiver with the value pointed to by expected, and if those are equal, replaces the former with desired (performs read-modify-write operation). Otherwise, loads the actual value pointed to by the receiver into *expected (performs load operation).

    This form of compare-and-exchange is allowed to fail spuriously, that is, act as if *current != *expected even if they are equal. When a compare-and-exchange is in a loop, this version will yield better performance on some platforms. When a weak compare-and-exchange would require a loop and a strong one would not, the strong one is preferable.

    Declaration

    Swift

    @discardableResult
public func compareExchangeWeak(
    _ expected: UnsafeMutablePointer<RawValue>,
    _ desired: RawValue,
    order: AtomicMemoryOrder = .seqcst,
    loadOrder: AtomicLoadMemoryOrder? = nil
) -> Bool

    Parameters

    expected

    The value expected to be found in the receiver.
    desired

    The value to store in the receiver if it is as expected.
    order

    The memory synchronization ordering for the read-modify-write operation if the comparison succeeds.
    loadOrder

    The memory synchronization ordering for the load operation if the comparison fails. Cannot specify stronger ordering than order.

    Return Value

    The result of the comparison: true if current value was equal to *expected, false otherwise.

    Show on GitHub

  • Atomically compares the value pointed to by the receiver with the value pointed to by expected, and if those are equal, replaces the former with desired (performs read-modify-write operation). Otherwise, loads the actual value pointed to by the receiver into *expected (performs load operation).

    This form of compare-and-exchange is allowed to fail spuriously, that is, act as if *current != *expected even if they are equal. When a compare-and-exchange is in a loop, this version will yield better performance on some platforms. When a weak compare-and-exchange would require a loop and a strong one would not, the strong one is preferable.

    Declaration

    Swift

    @discardableResult
public func compareExchangeWeak(
    _ expected: RawValue,
    _ desired: RawValue,
    order: AtomicMemoryOrder = .seqcst,
    loadOrder: AtomicLoadMemoryOrder? = nil
) -> RawValue

    Parameters

    expected

    The value expected to be found in the receiver.
    desired

    The value to store in the receiver if it is as expected.
    order

    The memory synchronization ordering for the read-modify-write operation if the comparison succeeds.
    loadOrder

    The memory synchronization ordering for the load operation if the comparison fails. Cannot specify stronger ordering than order.

    Return Value

    The value actually stored in the receiver. If exchange succeeded, this will be equal to expected.

    Show on GitHub

  • Atomically replaces the value pointed by the receiver with the result of bitwise AND between the old value of the receiver and value, and returns the value the receiver held previously. The operation is read-modify-write operation.

    Declaration

    Swift

    @discardableResult
public func fetchAnd(_ value: RawValue, order: AtomicMemoryOrder = .seqcst) -> RawValue

    Parameters

    value

    The value to bitwise AND to the value stored in the receiver.
    order

    The memory synchronization ordering for this operation.

    Return Value

    The value previously stored in the receiver.

    Show on GitHub

  • Atomically replaces the value pointed by the receiver with the result of bitwise OR between the old value of the receiver and value, and returns the value the receiver held previously. The operation is read-modify-write operation.

    Declaration

    Swift

    @discardableResult
public func fetchOr(_ value: RawValue, order: AtomicMemoryOrder = .seqcst) -> RawValue

    Parameters

    value

    The value to bitwise OR to the value stored in the receiver.
    order

    The memory synchronization ordering for this operation.

    Return Value

    The value previously stored in the receiver.

    Show on GitHub

  • Atomically replaces the value pointed by the receiver with the result of bitwise XOR between the old value of the receiver and value, and returns the value the receiver held previously. The operation is read-modify-write operation.

    Declaration

    Swift

    @discardableResult
public func fetchXor(_ value: RawValue, order: AtomicMemoryOrder = .seqcst) -> RawValue

    Parameters

    value

    The value to bitwise XOR to the value stored in the receiver.
    order

    The memory synchronization ordering for this operation.

    Return Value

    The value previously stored in the receiver.

    Show on GitHub

  • Atomically replaces the value pointed by the receiver with the result of addition of value to the old value of the receiver, and returns the value the receiver held previously. The operation is read-modify-write operation.

    For signed integer types, arithmetic is defined to use two’s complement representation. There are no undefined results. For pointer types, the result may be an undefined address, but the operations otherwise have no undefined behavior.

    Declaration

    Swift

    @discardableResult
public func fetchAdd(_ value: RawValue, order: AtomicMemoryOrder = .seqcst) -> RawValue

    Parameters

    value

    The value to add to the value stored in the receiver.
    order

    The memory synchronization ordering for this operation.

    Return Value

    The value previously stored in the receiver.

    Show on GitHub

  • Atomically replaces the value pointed by the receiver with the result of subtraction of value to the old value of the receiver, and returns the value the receiver held previously. The operation is read-modify-write operation.

    For signed integer types, arithmetic is defined to use two’s complement representation. There are no undefined results. For pointer types, the result may be an undefined address, but the operations otherwise have no undefined behavior.

    Declaration

    Swift

    @discardableResult
public func fetchSub(_ value: RawValue, order: AtomicMemoryOrder = .seqcst) -> RawValue

    Parameters

    value

    The value to subtract from the value stored in the receiver.
    order

    The memory synchronization ordering for this operation.

    Return Value

    The value previously stored in the receiver.

    Show on GitHub