Base Framework
Public Member Functions | Protected Attributes | List of all members
Resource Class Reference

#include <base/Resource.h>

Inherits Object.

Inherited by Event, File, FolderMonitor, HTTPSRequest, MutualExclusion, Pipe, ReadWriteLock, RecursiveMutualExclusion, Semaphore, Socket [virtual], and SSLSocket.

Public Member Functions

String getDescription () const
 
void setDescription (const String &description)
 
unsigned int getResourceId () const
 
unsigned int getCreatedById () const
 
AnyReference getHandle () const noexcept
 
template<class TYPE >
TYPE & getInternalHandle () const
 
 operator bool () const noexcept
 

Protected Attributes

AnyReference handle
 

Detailed Description

Base class for resource handles.

Member Function Documentation

◆ getCreatedById()

unsigned int Resource::getCreatedById ( ) const

Returns the thread that created the resource.

◆ getDescription()

String Resource::getDescription ( ) const

Returns the description of the resource.

◆ getHandle()

AnyReference Resource::getHandle ( ) const
inlinenoexcept

Returns the handle.

◆ getInternalHandle()

template<class TYPE >
TYPE& Resource::getInternalHandle ( ) const
inline

Returns the handle.

◆ getResourceId()

unsigned int Resource::getResourceId ( ) const

Returns the unique resource ID.

◆ operator bool()

Resource::operator bool ( ) const
inlinenoexcept

Returns true if handle is set.

◆ setDescription()

void Resource::setDescription ( const String description)

Sets the description of the resource.

Member Data Documentation

◆ handle

AnyReference Resource::handle
protected

Internal handle for resource.