| Qore Programming Language Reference Manual 2.2.0

Loading...
Searching...
No Matches
Public Member Functions | List of all members
Qore::Thread::AbstractThreadResource Class Reference

This class defines an abstract interface for thread resources. More...

`#include <QC_AbstractThreadResource.dox.h>`

## Public Member Functions
abstract nothing | cleanup ()
| This method is called by Qore itself when the thread resource is still allocated and requires cleanup.
| constructor ()
| Creates the internal thread resource object.
| destructor ()
| removes the thread resource if set; if so then the cleanup() method is called

## Detailed Description

This class defines an abstract interface for thread resources.

Overview
  Thread resources can be considered properties of a thread that need to be cleaned up when the thread exits or one of the thread cleanup functions is run:
  - Qore::throw_thread_resource_exceptions()
  - Qore::throw_thread_resource_exceptions_to_mark()
  The following functions allow classes of this type to be set or removed as thread resources:
  - Qore::set_thread_resource()
  - Qore::remove_thread_resource()
  If the thread resource is still set when the destructor is run, then the destructor frees the thread resource and calls cleanup().

Example
  # this class starts a background thread in the constructor that is managed as a thread resource in the creating thread
  class ThreadResourceExample inherits AbstractThreadResource {
  public {}
  private {
  Qore::Thread::Mutex m();
  Qore::Thread::Condition cond();
  Qore::Thread::Counter cnt();
  bool exit;
  }
  constructor() {
  start();
  }
  synchronized private start() {
  cnt.inc();
  set_thread_resource(self);
  on_error {
  cnt.dec();
  remove_thread_resource(self);
  }
  background waiter();
  }
  stop() {
  {
  m.lock();
  on_exit m.unlock();
  exit = True;
  cond.signal();
  }
  cnt.waitForZero();
  remove_thread_resource(self);
  }
  # the cleanup routine stops the thread and throws an exception
  cleanup() {
  m.lock();
  on_exit m.unlock();
  if (!exit) {
  stop();
  throw "THREAD-RESOURCE-ERROR", sprintf("the background thread was stopped during thread resource cleanup; call %s::stop() before exiting the thread to avoid this exception", self.className());
  }
  }
  # the background thread simply waits for the exit condition
  private waiter() {
  on_exit cnt.dec();
  m.lock();
  on_exit m.unlock();
  while (!exit)
  cond.wait(m);
  }
  }

See also
  Thread Resources

Since
  Qore 0.8.12

## Member Function Documentation

## ◆ cleanup()

abstract nothing Qore::Thread::AbstractThreadResource::cleanup | ( |  | ) |

This method is called by Qore itself when the thread resource is still allocated and requires cleanup.

This method should clean up the resource and normally should throw an appropriate exception explaining:

- what the programming error was (ex: failing to unlock a lock before the thread exited)
- what happened (ex: the lock was automatically released)
- how to prevent it from happening in the future (ex: make sure and release the lock before exiting the thread)

This method is called in the following situations:

- Qore::throw_thread_resource_exceptions() is called and the current object is still set as a thread resource
- Qore::throw_thread_resource_exceptions_to_mark() is called and the current object is set as a thread resource after the current mark set by Qore::mark_thread_resources()
- the thread exits and the current object is still set as a thread resource

Note
  - thread resources are set with Qore::set_thread_resource() and removed with Qore::remove_thread_resource()
  - if this method does not throw an exception, then thread resource cleanup for the object will be performed silently

See also
  Thread Resources