Operation.h

Go to the documentation of this file.

/*
 * Objectively: Ultra-lightweight object oriented framework for GNU C.
 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#pragma once
 
#include <Objectively/Condition.h>
#include <Objectively/Object.h>
#include <Objectively/MutableArray.h>
 
typedef struct Operation Operation;
typedef struct OperationInterface OperationInterface;
 
typedef void (*OperationFunction)(Operation *operation);
 
struct Operation {
 
    Object object;
 
    OperationInterface *interface;
 
    struct {
 
        Condition *condition;
 
        MutableArray *dependencies;
 
    } locals;
 
    _Bool asynchronous;
 
    ident data;
 
    OperationFunction function;
 
    _Bool isCancelled;
 
    _Bool isExecuting;
 
    _Bool isFinished;
};
 
struct OperationInterface {
 
    ObjectInterface objectInterface;
 
    void (*addDependency)(Operation *self, Operation *dependency);
 
    void (*cancel)(Operation *self);
 
    Array *(*dependencies)(const Operation *self);
 
    Operation *(*init)(Operation *self);
 
    Operation *(*initWithFunction)(Operation *self, OperationFunction function, ident data);
 
    _Bool (*isReady)(const Operation *self);
 
    void (*removeDependency)(Operation *self, Operation *dependency);
 
    void (*start)(Operation *self);
 
    void (*waitUntilFinished)(const Operation *self);
};
 
OBJECTIVELY_EXPORT Class *_Operation(void);