OperationQueue.c File Reference

#include <assert.h>
#include "OperationQueue.h"

Go to the source code of this file.

Macros
#define	_Class   _OperationQueue

Functions
Class *	_OperationQueue (void)
static void	addOperation (OperationQueue *self, Operation *operation)
static Operation *	addOperationWithFunction (OperationQueue *self, OperationFunction function, ident data)
static void	cancelAllOperations (OperationQueue *self)
static Object *	copy (const Object *self)
static OperationQueue *	currentQueue (void)
static void	dealloc (Object *self)
static OperationQueue *	init (OperationQueue *self)
static void	initialize (Class *clazz)
static OperationQueue *	initWithMaxConcurrentOperations (OperationQueue *self, size_t maxConcurrentOperations)
static bool	isOperationReady (const ident obj, ident data)
	Predicate matching the next Operation eligible to start.
static size_t	operationCount (const OperationQueue *self)
static Array *	operations (const OperationQueue *self)
static void	removeOperation (OperationQueue *self, Operation *operation)
static void	resume (OperationQueue *self)
static ident	run (Thread *thread)
	ThreadFunction for the OperationQueue Threads.
static void	suspend (OperationQueue *self)
static void	waitUntilAllOperationsAreFinished (OperationQueue *self)

Variables
static __thread OperationQueue *	_currentQueue

Macro Definition Documentation

_Class

#define _Class   _OperationQueue

Definition at line 28 of file OperationQueue.c.

Function Documentation

_OperationQueue()

Class * _OperationQueue

(

void

)

Definition at line 349 of file OperationQueue.c.

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

addOperation()

static void addOperation ( OperationQueue *  self, Operation *  operation  )

static

Definition at line 74 of file OperationQueue.c.

                                                                     {
 
  assert(operation);
  assert(operation->isCancelled == false);
  assert(operation->isExecuting == false);
  assert(operation->isFinished == false);
 
  synchronized(self->locals.condition, {
    operation->locals.queue = self;
    $(self->locals.operations, addObject, operation);
    $(self->locals.condition, signal);
  });
}

addOperationWithFunction()

static Operation * addOperationWithFunction ( OperationQueue *  self, OperationFunction  function, ident  data  )

static

Definition at line 92 of file OperationQueue.c.

                                                                                                         {
 
  assert(function);
 
  Operation *operation = $(alloc(Operation), initWithFunction, function, data);
 
  $(self, addOperation, operation);
 
  return operation;
}

cancelAllOperations()

static void cancelAllOperations ( OperationQueue *  self )

static

Definition at line 107 of file OperationQueue.c.

                                                      {
 
  Array *operations = $(self, operations);
 
  for (size_t i = 0; i < operations->count; i++) {
    $((Operation *) $(operations, objectAtIndex, i), cancel);
  }
 
  release(operations);
}

copy()

static Object * copy ( const Object *  self )

static

See also

Object::copy(const Object *)

Definition at line 35 of file OperationQueue.c.

                                        {
 
  return NULL;
}

currentQueue()

static OperationQueue * currentQueue ( void  )

static

Definition at line 124 of file OperationQueue.c.

                                          {
  return _currentQueue;
}

dealloc()

static void dealloc ( Object *  self )

static

See also

Object::dealloc(Object *)

Definition at line 43 of file OperationQueue.c.

                                  {
 
  OperationQueue *this = (OperationQueue *) self;
 
  const Array *threads = (Array *) this->locals.threads;
 
  for (size_t i = 0; i < threads->count; i++) {
    $((Thread *) $(threads, objectAtIndex, i), cancel);
  }
 
  synchronized(this->locals.condition, {
    $(this->locals.condition, broadcast);
  });
 
  for (size_t i = 0; i < threads->count; i++) {
    $((Thread *) $(threads, objectAtIndex, i), join, NULL);
  }
 
  release(this->locals.threads);
  release(this->locals.condition);
  release(this->locals.operations);
 
  super(Object, self, dealloc);
}

init()

static OperationQueue * init ( OperationQueue *  self )

static

Definition at line 182 of file OperationQueue.c.

                                                  {
  return $(self, initWithMaxConcurrentOperations, 1);
}

initialize()

static void initialize ( Class *  clazz )

static

See also

Class::initialize(Class *)

Definition at line 326 of file OperationQueue.c.

                                     {
 
  ((ObjectInterface *) clazz->interface)->copy = copy;
  ((ObjectInterface *) clazz->interface)->dealloc = dealloc;
 
  ((OperationQueueInterface *) clazz->interface)->addOperation = addOperation;
  ((OperationQueueInterface *) clazz->interface)->addOperationWithFunction = addOperationWithFunction;
  ((OperationQueueInterface *) clazz->interface)->cancelAllOperations = cancelAllOperations;
  ((OperationQueueInterface *) clazz->interface)->currentQueue = currentQueue;
  ((OperationQueueInterface *) clazz->interface)->init = init;
  ((OperationQueueInterface *) clazz->interface)->initWithMaxConcurrentOperations = initWithMaxConcurrentOperations;
  ((OperationQueueInterface *) clazz->interface)->operationCount = operationCount;
  ((OperationQueueInterface *) clazz->interface)->operations = operations;
  ((OperationQueueInterface *) clazz->interface)->removeOperation = removeOperation;
  ((OperationQueueInterface *) clazz->interface)->resume = resume;
  ((OperationQueueInterface *) clazz->interface)->suspend = suspend;
  ((OperationQueueInterface *) clazz->interface)->waitUntilAllOperationsAreFinished = waitUntilAllOperationsAreFinished;
}

initWithMaxConcurrentOperations()

static OperationQueue * initWithMaxConcurrentOperations ( OperationQueue *  self, size_t  maxConcurrentOperations  )

static

Definition at line 190 of file OperationQueue.c.

                                                                                                             {
 
  assert(maxConcurrentOperations);
 
  self = (OperationQueue *) super(Object, self, init);
  if (self) {
 
    self->locals.condition = $(alloc(Condition), init);
    assert(self->locals.condition);
 
    self->locals.operations = $(alloc(Array), init);
    assert(self->locals.operations);
 
    self->locals.threads = $(alloc(Array), init);
    assert(self->locals.threads);
 
    for (size_t i = 0; i < maxConcurrentOperations; i++) {
 
      Thread *thread = $(alloc(Thread), initWithFunction, run, self);
      assert(thread);
 
      $(self->locals.threads, addObject, thread);
 
      release(thread);
    }
 
    const Array *threads = (Array *) self->locals.threads;
    for (size_t i = 0; i < threads->count; i++) {
      $((Thread *) $(threads, objectAtIndex, i), start);
    }
  }
 
  return self;
}

isOperationReady()

static bool isOperationReady ( const ident  obj, ident  data  )

static

Predicate matching the next Operation eligible to start.

Definition at line 131 of file OperationQueue.c.

                                                          {
  return $((Operation *) obj, isReady);
}

operationCount()

static size_t operationCount ( const OperationQueue *  self )

static

Definition at line 229 of file OperationQueue.c.

                                                         {
 
  size_t count;
 
  synchronized(self->locals.condition, {
    count = ((Array *) self->locals.operations)->count;
  });
 
  return count;
}

operations()

static Array * operations ( const OperationQueue *  self )

static

Definition at line 244 of file OperationQueue.c.

                                                     {
 
  ident operations;
 
  synchronized(self->locals.condition, {
    operations = $((Object * ) self->locals.operations, copy);
  });
 
  return (Array *) operations;
}

removeOperation()

static void removeOperation ( OperationQueue *  self, Operation *  operation  )

static

Definition at line 259 of file OperationQueue.c.

                                                                        {
 
  assert(operation);
  assert(operation->isExecuting == false);
 
  synchronized(self->locals.condition, {
    operation->locals.queue = NULL;
    $(self->locals.operations, removeObject, operation);
    $(self->locals.condition, signal);
  });
}

resume()

static void resume ( OperationQueue *  self )

static

Definition at line 275 of file OperationQueue.c.

                                         {
 
  synchronized(self->locals.condition, {
    self->isSuspended = false;
    $(self->locals.condition, broadcast);
  });
}

run()

static ident run ( Thread *  thread )

static

ThreadFunction for the OperationQueue Threads.

Definition at line 138 of file OperationQueue.c.

                                 {
 
  OperationQueue *self = _currentQueue = thread->data;
 
  bool isCancelled = false;
 
  while (!isCancelled) {
 
    Operation *operation = NULL;
 
    synchronized(self->locals.condition, {
 
      isCancelled = thread->isCancelled;
 
      if (!isCancelled && self->isSuspended == false) {
 
        operation = $(self->locals.operations, find, isOperationReady, NULL);
        if (operation) {
          operation->isDispatched = true;
          $(self->locals.condition, signal);
        }
      }
 
      if (operation == NULL && !isCancelled) {
        $(self->locals.condition, wait);
      }
    });
 
    if (operation == NULL) {
      continue;
    }
 
    $(operation, start);
 
    $(self, removeOperation, operation);
  }
 
  return NULL;
}

suspend()

static void suspend ( OperationQueue *  self )

static

Definition at line 287 of file OperationQueue.c.

                                          {
 
  synchronized(self->locals.condition, {
    self->isSuspended = true;
  });
}

waitUntilAllOperationsAreFinished()

static void waitUntilAllOperationsAreFinished ( OperationQueue *  self )

static

Definition at line 298 of file OperationQueue.c.

                                                                    {
 
  while (true) {
 
    Operation *operation = NULL;
 
    synchronized(self->locals.condition, {
      const Array *operations = (Array *) self->locals.operations;
      if (operations->count) {
        operation = retain($(operations, firstObject));
      }
    });
 
    if (operation == NULL) {
      break;
    }
 
    $(operation, waitUntilFinished);
 
    release(operation);
  }
}

Variable Documentation

_currentQueue

__thread OperationQueue* _currentQueue

static

Definition at line 118 of file OperationQueue.c.