OperationQueue Struct Reference

#include <OperationQueue.h>

Overview

OperationQueues provide a thread of execution for Operations.

Definition at line 44 of file OperationQueue.h.

Inheritance diagram for OperationQueue:

Properties
_Bool	isSuspended
	When true, the queue will not start any new Operations. More...
Object	object
	The superclass. More...
Condition *	condition
	A condition signaled on addOperation and removeOperation. More...
MutableArray *	operations
	The Operations. More...
Thread *	thread
	The backing Thread. More...
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class. More...

Methods
Class *	_OperationQueue (void)
	The OperationQueue archetype. More...
void	addOperation (OperationQueue *self, Operation *operation)
	Adds an Operation to this queue. More...
void	cancelAllOperations (OperationQueue *self)
	Cancels all pending Operations residing within this Queue. More...
OperationQueue *	currentQueue (void)
OperationQueue *	init (OperationQueue *self)
	Initializes this OperationQueue. More...
size_t	operationCount (const OperationQueue *self)
Array *	operations (const OperationQueue *self)
void	removeOperation (OperationQueue *self, Operation *operation)
	Removes the Operation from this queue. More...
void	waitUntilAllOperationsAreFinished (OperationQueue *self)
	Waits until all Operations submitted to this queue have finished. More...
Methods inherited from Object
Class *	_Object (void)
	The Object archetype. More...
Object *	copy (const Object *self)
	Creates a shallow copy of this Object. More...
void	dealloc (Object *self)
	Frees all resources held by this Object. More...
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object. More...
_Bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object. More...
_Bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership. More...

Protected Attributes
OperationQueueInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

condition

Condition* OperationQueue::condition

A condition signaled on addOperation and removeOperation.

Definition at line 65 of file OperationQueue.h.

interface

OperationQueueInterface* OperationQueue::interface

protected

The interface.

Definition at line 55 of file OperationQueue.h.

isSuspended

_Bool OperationQueue::isSuspended

When true, the queue will not start any new Operations.

Definition at line 82 of file OperationQueue.h.

object

Object OperationQueue::object

The superclass.

Definition at line 49 of file OperationQueue.h.

operations

MutableArray* OperationQueue::operations

The Operations.

Definition at line 70 of file OperationQueue.h.

thread

Thread* OperationQueue::thread

The backing Thread.

Definition at line 75 of file OperationQueue.h.

Method Details

_OperationQueue()

Class * _OperationQueue

(

void

)

The OperationQueue archetype.

Returns

The OperationQueue Class.

Definition at line 252 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()

void addOperation	(	OperationQueue *	self,
		Operation *	operation
	)

Adds an Operation to this queue.

Parameters

self	The OperationQueue.
operation	The Operation to add.

Definition at line 63 of file OperationQueue.c.

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

cancelAllOperations()

void cancelAllOperations

(

OperationQueue *

self

)

Cancels all pending Operations residing within this Queue.

Parameters

self	The OperationQueue.

Definition at line 80 of file OperationQueue.c.

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

currentQueue()

OperationQueue * currentQueue

(

void

)

Returns

The current OperationQueue, or NULL if none can be determined.

Remarks

This method should only be called from a synchronous Operation that was dispatched via an OperationQueue. This method uses thread-local storage.

Definition at line 97 of file OperationQueue.c.

                                          {
 
    return _currentQueue;
}

init()

OperationQueue * init

(

OperationQueue *

self

)

Initializes this OperationQueue.

Parameters

self	The OperationQueue.

Returns

The initialized OperationQueue, or NULL on error.

Definition at line 148 of file OperationQueue.c.

                                                  {
 
    self = (OperationQueue *) super(Object, self, init);
    if (self) {
 
        self->locals.condition = $(alloc(Condition), init);
        assert(self->locals.condition);
 
        self->locals.operations = $(alloc(MutableArray), init);
        assert(self->locals.operations);
 
        self->locals.thread = $(alloc(Thread), initWithFunction, run, self);
        assert(self->locals.thread);
 
        $(self->locals.thread, start);
    }
 
    return self;
}

operationCount()

size_t operationCount

(

const OperationQueue *

self

)

Parameters

self	The OperationQueue.

Returns

The instantaneous count of this OperationQueue's Operations.

Definition at line 172 of file OperationQueue.c.

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

operations()

Array * operations

(

const OperationQueue *

self

)

Parameters

self	The OperationQueue.

Returns

An instantaneous copy of this OperationQueue's Operations.

Definition at line 187 of file OperationQueue.c.

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

removeOperation()

void removeOperation	(	OperationQueue *	self,
		Operation *	operation
	)

Removes the Operation from this queue.

Parameters

self	The OperationQueue.
operation	The Operation to remove.

Definition at line 202 of file OperationQueue.c.

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

waitUntilAllOperationsAreFinished()

void waitUntilAllOperationsAreFinished

(

OperationQueue *

self

)

Waits until all Operations submitted to this queue have finished.

Parameters

self	The OperationQueue.

Definition at line 217 of file OperationQueue.c.

                                                                    {
 
    Array *operations = (Array *) self->locals.operations;
    while (operations->count > 0) {
 
        synchronized(self->locals.condition, {
            $(self->locals.condition, wait);
        });
    }
}

---

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

• Sources/Objectively/OperationQueue.h
• Sources/Objectively/OperationQueue.c