Thread Struct Reference

#include <Thread.h>

Overview

POSIX Threads.

Asynchronous computing via multiple threads of execution.

Definition at line 53 of file Thread.h.

Inheritance diagram for Thread:

Properties
ident	data
	The user data.
ThreadFunction	function
	The Thread function.
bool	isCancelled
	true when this Thread has been cancelled, false otherwise.
bool	isDetached
	true when this Thread has been detached, false otherwise.
bool	isExecuting
	true when this Thread is executing, false otherwise.
bool	isFinished
	true when this Thread is finished, false otherwise.
Object	object
	The superclass.
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class.
unsigned int	magic
	A header to allow introspection of Object types.

Methods
Class *	_Thread (void)
	The Thread archetype.
void	cancel (Thread *self)
	Cancel this Thread from another Thread.
Thread *	currentThread (void)
	Returns the currently executing Thread.
void	detach (Thread *self)
	Daemonize this Thread.
Thread *	init (Thread *self)
	Initializes this Thread.
Thread *	initWithFunction (Thread *self, ThreadFunction function, ident data)
	Initializes this Thread with the specified ThreadFunction and data.
void	join (Thread *self, ident *status)
	Wait for the specified Thread to terminate.
void	kill (Thread *self, int signal)
	Sends the given signal to this Thread.
void	start (Thread *self)
	Start this Thread.
Methods inherited from Object
Class *	_Object (void)
	The Object archetype.
Object *	copy (const Object *self)
	Creates a shallow copy of this Object.
void	dealloc (Object *self)
	Frees all resources held by this Object.
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object.
bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object.
bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership.

Protected Attributes
ThreadInterface *	interface
	The interface.
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface.

Property Details

data

ident Thread::data

The user data.

Definition at line 69 of file Thread.h.

function

ThreadFunction Thread::function

The Thread function.

Definition at line 74 of file Thread.h.

interface

ThreadInterface* Thread::interface

protected

The interface.

Definition at line 64 of file Thread.h.

isCancelled

bool Thread::isCancelled

true when this Thread has been cancelled, false otherwise.

Definition at line 79 of file Thread.h.

isDetached

bool Thread::isDetached

true when this Thread has been detached, false otherwise.

Definition at line 84 of file Thread.h.

isExecuting

bool Thread::isExecuting

true when this Thread is executing, false otherwise.

Definition at line 89 of file Thread.h.

isFinished

bool Thread::isFinished

true when this Thread is finished, false otherwise.

Definition at line 94 of file Thread.h.

object

Object Thread::object

The superclass.

Definition at line 58 of file Thread.h.

Method Details

_Thread()

Class * _Thread

(

void

)

The Thread archetype.

Returns

The Thread Class.

Definition at line 206 of file Thread.c.

                     {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "Thread",
      .superclass = _Object(),
      .instanceSize = sizeof(Thread),
      .interfaceOffset = offsetof(Thread, interface),
      .interfaceSize = sizeof(ThreadInterface),
      .initialize = initialize,
    });
  });
 
  return clazz;
}

cancel()

void cancel

(

Thread *

self

)

Cancel this Thread from another Thread.

Parameters

self	The Thread.

Definition at line 64 of file Thread.c.

                                 {
 
  assert(self->isCancelled == false);
 
  // https://stackoverflow.com/a/4760758
  // int err = pthread_cancel(*((pthread_t *) self->thread));
  // assert(err == 0);
 
  self->isCancelled = true;
}

currentThread()

Thread * currentThread

(

void

)

Returns the currently executing Thread.

Returns

The currently executing Thread.

Definition at line 81 of file Thread.c.

                                   {
 
  return _currentThread;
}

detach()

void detach

(

Thread *

self

)

Daemonize this Thread.

Parameters

self	The Thread.

Definition at line 90 of file Thread.c.

                                 {
 
  assert(self->isDetached == false);
 
  int err = pthread_detach(*((pthread_t *) self->thread));
  assert(err == 0);
 
  self->isDetached = true;
}

init()

Thread * init

(

Thread *

self

)

Initializes this Thread.

Parameters

self	The Thread.

Returns

The initialized Thread, or NULL on error.

Definition at line 104 of file Thread.c.

                                  {
 
  return $(self, initWithFunction, NULL, NULL);
}

initWithFunction()

Thread * initWithFunction	(	Thread *	self,
		ThreadFunction	function,
		ident	data
	)

Initializes this Thread with the specified ThreadFunction and data.

Parameters

self	The Thread.
function	The ThreadFunction to run.
data	The user data.

Returns

The initialized Thread, or NULL on error.

Definition at line 113 of file Thread.c.

                                                                                   {
 
  self = (Thread *) super(Object, self, init);
  if (self) {
    self->function = function;
    self->data = data;
 
    self->thread = calloc(1, sizeof(pthread_t));
    assert(self->thread);
  }
 
  return self;
}

join()

void join	(	Thread *	self,
		ident *	status
	)

Wait for the specified Thread to terminate.

Parameters

self	The Thread.
status	If not NULL, the return value of this Thread's ThreadFunction is returned here.

Definition at line 131 of file Thread.c.

                                              {
 
  int err = pthread_join(*((pthread_t *) self->thread), status);
  assert(err == 0);
}

kill()

void kill	(	Thread *	self,
		int	signal
	)

Sends the given signal to this Thread.

Parameters

self	The Thread.
signal	The signal to send.

start()

void start

(

Thread *

self

)

Start this Thread.

Parameters

self	The Thread.

Definition at line 169 of file Thread.c.

                                {
 
  assert(self->function);
 
  assert(self->isCancelled == false);
  assert(self->isDetached == false);
  assert(self->isExecuting == false);
  assert(self->isFinished == false);
 
  int err = pthread_create(self->thread, NULL, run, self);
  assert(err == 0);
}

---

The documentation for this struct was generated from the following files:

• Sources/Objectively/Thread.h
• Sources/Objectively/Thread.c