Objectively
Object oriented framework for C.
Loading...
Searching...
No Matches
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>
30
36typedef struct OperationQueue OperationQueue;
37typedef struct OperationQueueInterface OperationQueueInterface;
38
45
50
55 OperationQueueInterface *interface[0];
56
61 Condition *condition;
62
67 bool isCancelled;
68
75
80 Array *operations;
81
86 ThreadPool *threadPool;
87};
88
92struct OperationQueueInterface {
93
97 ObjectInterface objectInterface;
98
106 void (*addOperation)(OperationQueue *self, Operation *operation);
107
117 Operation *(*addOperationWithFunction)(OperationQueue *self, OperationFunction function, ident data);
118
125 void (*cancelAllOperations)(OperationQueue *self);
126
135 OperationQueue *(*currentQueue)(void);
136
146 OperationQueue *(*init)(OperationQueue *self);
147
157 OperationQueue *(*initWithMaxConcurrentOperations)(OperationQueue *self, size_t maxConcurrentOperations);
158
165 size_t (*operationCount)(const OperationQueue *self);
166
173 Array *(*operations)(const OperationQueue *self);
174
182 void (*removeOperation)(OperationQueue *self, Operation *operation);
183
190 void (*resume)(OperationQueue *self);
191
199 void (*suspend)(OperationQueue *self);
200
207 void (*waitUntilAllOperationsAreFinished)(OperationQueue *self);
208};
209
POSIX Threads conditional variables.
static Data * data(void)
Definition Data.c:286
Object is the root Class of The Objectively Class hierarchy.
An abstraction for discrete units of work, or tasks.
void(* OperationFunction)(Operation *operation)
The function type for Operation execution.
Definition Operation.h:45
OBJECTIVELY_EXPORT Class * _OperationQueue(void)
A fixed set of Threads that run ThreadFunctions on behalf of the caller.
void * ident
The identity type, similar to Objective-C id.
Definition Types.h:49
#define OBJECTIVELY_EXPORT
Definition Types.h:36
Arrays.
Definition Array.h:56
The runtime representation of a Class.
Definition Class.h:90
POSIX Threads conditional variables.
Definition Condition.h:44
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:53
OperationQueues provide threads of execution for Operations.
bool isSuspended
When true, the queue will not start any new Operations.
Object object
The superclass.
OperationQueueInterface * interface[0]
The interface type.
A fixed set of Threads that run ThreadFunctions on behalf of the caller.
Definition ThreadPool.h:64