sync_per_thread Class

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at sync_per_thread Class.

Describes a synchronization filter that provides a separate cache object for each thread.

template <class Cache>  
class sync_per_thread

Parameters

ParameterDescription
CacheThe type of cache associated with the synchronization filter. This can be cache_chunklist, cache_freelist, or cache_suballoc.

Allocators that use sync_per_thread can compare equal even though blocks allocated in one thread cannot be deallocated from another thread. When using one of these allocators memory blocks allocated in one thread should not be made visible to other threads. In practice this means that a container that uses one of these allocators should only be accessed by a single thread.

Member Functions

allocateAllocates a block of memory.
deallocateFrees a specified number of objects from storage beginning at a specified position.
equalsCompares two caches for equality.

Header: <allocators>

Namespace: stdext

Allocates a block of memory.

void *allocate(std::size_t count);

Parameters

ParameterDescription
countThe number of elements in the array to be allocated.

Remarks

The member function returns the result of a call to cache::allocate(count) on the cache object belonging to the current thread. If no cache object has been allocated for the current thread, it first allocates one.

Frees a specified number of objects from storage beginning at a specified position.

void deallocate(void* ptr, std::size_t count);

Parameters

ParameterDescription
ptrA pointer to the first object to be deallocated from storage.
countThe number of objects to be deallocated from storage.

Remarks

The member function calls deallocate on the cache object belonging to the current thread. If no cache object has been allocated for the current thread, it first allocates one.

Compares two caches for equality.

bool equals(const sync<Cache>& Other) const;

Parameters

ParameterDescription
CacheThe cache object of the synchronization filter.
OtherThe cache object to compare for equality.

Return Value

false if no cache object has been allocated for this object or for Other in the current thread. Otherwise it returns the result of applying operator== to the two cache objects.

Remarks

<allocators>

Show: