This class implements a guard for work completion within a specified duration.

Synopsis

Declared in <bslmt_timedcompletionguard.h>

class TimedCompletionGuard;

Type Aliases

Name

Description

Handler

Alias for a pointer to a handler taking a null‐terminated string.

allocator_type

Alias indicating this type is allocator‐aware.

Member Functions

Name

Description

TimedCompletionGuard [constructor]

Constructors

~TimedCompletionGuard [destructor]

Invoke release and destroy this guard.

get_allocator

Return the allocator used to supply memory.

guard

Schedule a handler invocation after duration unless released.

isGuarding

Return true if this guard is currently configured with a duration to guard, and false otherwise.

release

If a thread is waiting to alert at expiration of the set duration, join the thread, thus preventing any alerting.

updateText

Update the completion‐guard message text to text.

Static Member Functions

Name

Description

failByAbort [noreturn]

Abort after logging a diagnostic message built from text.

Created with MrDocs