GDOperationsController Class Reference

The GDOperationsController is a controller you should use to expose methods to run GDBaseOperation instances. More...

#import <GDOperationsController.h>

Inheritance diagram for GDOperationsController:

List of all members.

Public Member Functions
(void)	- cancelAll
	Cancel's all operations in the "cancelables" property.
(void)	- addToCancelables:
	Add an object to the list of cancelables.
(void)	- removeFromCancelables:
	Remove an object from the list of cancelables.
Protected Attributes
BOOL	cancelingAll
	Whether or not the operation controller is currently canceling all operations; a flag for thread safety.
NSMutableArray *	cancelables
	An array used to store running operations or queues which can be canceled when cancelAll is called.

---

Detailed Description

The GDOperationsController is a controller you should use to expose methods to run GDBaseOperation instances.

This helps break apart logic by making sure your operations use libdispatch (GCD).

Generally you want to expose a method (with optional parameters) that just kick of an instance of an GDBaseOperation.

Set completion blocks on the operations which call a "complete" method on this operation controller, which in turn trigger the callback.

Here's an example:

 // these are inside of your subclassed GDOperationsController:
 - (void) runSomeOperationWithCallback:(GDCallback *) _callback {
        [_callback retain];
        GDBaseOperation * op = [[[GDBaseOperation alloc] init] autorelease];
        NSOperationQueue * q = [[NSOperationQueue alloc] init];
        [self addToCancelables:q];
        [op setCompletionBlock:^{
                [self removeFromCancelables:q];
                [q release];
                [self onMyOperationComplete:_callback];
                [_callback autorelease];
        }];
        [q addOperation:op];
 }
 
 - (void) onMyOperationComplete:(GDCallback) _callback {
        //...do something.
        [_callback execute];
 }
 
 // somewhere else:
 - (void) someMethod {
        GDCallback * cb = [[[GDCallback alloc] initWithTarget:self andAction:@selector(onOperationComplete)] autorelease];
        [cb setExecutesOnMainThread:true];
        [[gd operations] runSomeOperationWithCallback:cb];
 }
 
 - (void) onOperationComplete {
        NSLog(@"finished operation");
 }

You should also keep track of all running operations and queues and make sure they can be canceled. For a catch all generic way you can use the addToCancelables: and removeFromCancelables: methods. If you add more logic and canceling behavior make sure to override the cancelAll method, write your own logic, then call [super cancelAll].

---

Member Function Documentation

- (void) addToCancelables:

(id)

_obj

Add an object to the list of cancelables.

Parameters:

_obj

An NSOperation, or NSOperationQueue; or any subclasses like GDBaseOperation, etc.

- (void) removeFromCancelables:

(id)

_obj

Remove an object from the list of cancelables.

Parameters:

_obj

An NSOperation, or NSOperationQueue; or any subclasses like GDBaseOperation, etc.

---

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

• source/GDOperationsController.h
• source/GDOperationsController.m