Objectively 1.0.0
Ultra-lightweight object oriented framework for GNU C.
OperationQueue.h
Go to the documentation of this file.
1/*
2 * Objectively: Ultra-lightweight object oriented framework for GNU C.
3 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
4 *
5 * This software is provided 'as-is', without any express or implied
6 * warranty. In no event will the authors be held liable for any damages
7 * arising from the use of this software.
8 *
9 * Permission is granted to anyone to use this software for any purpose,
10 * including commercial applications, and to alter it and redistribute it
11 * freely, subject to the following restrictions:
12 *
13 * 1. The origin of this software must not be misrepresented; you must not
14 * claim that you wrote the original software. If you use this software
15 * in a product, an acknowledgment in the product documentation would be
16 * appreciated but is not required.
17 *
18 * 2. Altered source versions must be plainly marked as such, and must not be
19 * misrepresented as being the original software.
20 *
21 * 3. This notice may not be removed or altered from any source distribution.
22 */
23
24#pragma once
25
27#include <Objectively/Object.h>
29#include <Objectively/Thread.h>
30
36typedef struct OperationQueue OperationQueue;
37typedef struct OperationQueueInterface OperationQueueInterface;
38
45
50
55 OperationQueueInterface *interface;
56
60 struct {
61
66
71
76
77 } locals;
78
83};
84
88struct OperationQueueInterface {
89
93 ObjectInterface objectInterface;
94
102 void (*addOperation)(OperationQueue *self, Operation *operation);
103
110 void (*cancelAllOperations)(OperationQueue *self);
111
120 OperationQueue *(*currentQueue)(void);
121
129 OperationQueue *(*init)(OperationQueue *self);
130
137 size_t (*operationCount)(const OperationQueue *self);
138
145 Array *(*operations)(const OperationQueue *self);
146
154 void (*removeOperation)(OperationQueue *self, Operation *operation);
155
163};
164
POSIX Threads conditional variables.
Object is the root Class of The Objectively Class hierarchy.
An abstraction for discrete units of work, or tasks.
static void removeOperation(OperationQueue *self, Operation *operation)
static size_t operationCount(const OperationQueue *self)
static void addOperation(OperationQueue *self, Operation *operation)
static void waitUntilAllOperationsAreFinished(OperationQueue *self)
static void cancelAllOperations(OperationQueue *self)
POSIX Threads.
#define OBJECTIVELY_EXPORT
Definition: Types.h:36
Immutable arrays.
Definition: Array.h:56
The runtime representation of a Class.
Definition: Class.h:95
POSIX Threads conditional variables.
Definition: Condition.h:44
Mutable arrays.
Definition: MutableArray.h:40
Object is the root Class of The Objectively Class hierarchy.
Definition: Object.h:46
An abstraction for discrete units of work, or tasks.
Definition: Operation.h:50
OperationQueues provide a thread of execution for Operations.
Class * _OperationQueue(void)
The OperationQueue archetype.
_Bool isSuspended
When true, the queue will not start any new Operations.
OperationQueueInterface * interface
The interface.
Thread * thread
The backing Thread.
Object object
The superclass.
Condition * condition
A condition signaled on addOperation and removeOperation.
MutableArray * operations
The Operations.
POSIX Threads.
Definition: Thread.h:53