WPILibC++  unspecified
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
hal::IndexedHandleResource< THandle, TStruct, size, enumValue > Class Template Reference

The IndexedHandleResource class is a way to track handles. More...

#include <IndexedHandleResource.h>

Public Member Functions

 IndexedHandleResource (const IndexedHandleResource &)=delete
 
IndexedHandleResourceoperator= (const IndexedHandleResource &)=delete
 
THandle Allocate (int16_t index, int32_t *status)
 
std::shared_ptr< TStruct > Get (THandle handle)
 
void Free (THandle handle)
 

Friends

class IndexedHandleResourceTest
 

Detailed Description

template<typename THandle, typename TStruct, int16_t size, HAL_HandleEnum enumValue>
class hal::IndexedHandleResource< THandle, TStruct, size, enumValue >

The IndexedHandleResource class is a way to track handles.

This version allows a limited number of handles that are allocated by index. Because they are allocated by index, each individual index holds its own mutex, which reduces contention heavily.]

Template Parameters
THandleThe Handle Type (Must be typedefed from HAL_Handle)
TStructThe struct type held by this resource
sizeThe number of resources allowed to be allocated
enumValueThe type value stored in the handle

The documentation for this class was generated from the following file: