<AGSOperation> Protocol Reference

Description

Protocol for objects that can be added to an AGSOperationQueue.

Since

100

Inheritance diagram for <AGSOperation>:

Instance Methods
(void)	- cancel
(void)	- execute

Properties
BOOL	canceled
void(^	internalCompletion )(void)
BOOL	startAsynchronously
AGSOperationState	state

Method Documentation

cancel

- (void) cancel

Cancels the operation.

Since

100

execute

- (void) execute

Starts the operation

Since

100

Property Documentation

canceled

- (BOOL) canceled

readnonatomicassign

Whether or not cancel has been called on the operation. "Canceled" is a modifier on the current state since:

1. The operation can be still "executing" until the cancel takes effect.
2. An operation can be canceled and in a completed state at the same time.

   Since

   100

internalCompletion

- (void(^ internalCompletion) (void))

readwritenonatomiccopy

The block the operation will call to signify to the operation queue that the operation is complete. This block is reserved for use by the AGSOperationQueue. Do not assign your own block to this.

Since

100

startAsynchronously

- (BOOL) startAsynchronously

readnonatomicassign

If an operation does all or most of it's work in the execute method it should return YES for this. If YES then the operation queue will dispatch this async to a global concurrent queue with the QOS that matches the qualityOfService specified on the AGSOperationQueue. If NO then the you are responsible for returning quickly from execute and doing the operation's work on a different queue. Either way the completion block must be called when the operation is finished or done being canceled.

Since

100

state

- (AGSOperationState) state

readnonatomicassign

The current state of the operation.

Since

100