-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathSKTaskGroup.h
More file actions
87 lines (76 loc) · 3.12 KB
/
Copy pathSKTaskGroup.h
File metadata and controls
87 lines (76 loc) · 3.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/*******************************************************************************
* The MIT License (MIT)
*
* Copyright (c) 2017 Jean-David Gadina - www.xs-labs.com
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
******************************************************************************/
/*!
* @header SKTaskGroup.h
* @copyright (c) 2017, Jean-David Gadina - www.xs-labs.com
*/
#import <Foundation/Foundation.h>
#import <ShellKit/SKObject.h>
#import <ShellKit/SKRunableObject.h>
NS_ASSUME_NONNULL_BEGIN
/*!
* @class SKTaskGroup
* @abstract Represents a group of tasks that may be run
* @see SKRunableObject
*/
@interface SKTaskGroup: SKObject < SKRunableObject >
/*!
* @property name
* @abstract The name of the task group
*/
@property( atomic, readonly ) NSString * name;
/*!
* @property tasks
* @abstract The tasks contained in the task group
* @see SKRunableObject
*/
@property( atomic, readonly ) NSArray< id< SKRunableObject > > * tasks;
/*!
* @property currentTask
* @abstract The task currently executing
* @discussion This property will be nil if the task group isn't running,
* or if no task is actually executing.
* @see SKRunableObject
*/
@property( atomic, readonly, nullable ) id< SKRunableObject > currentTask;
/*!
* @method taskGroupWithName:tasks:
* @abstract Creates a task group object
* @param name The name of the task group
* @param tasks The tasks to execute when the task group is run
* @result The task group object
* @see SKRunableObject
*/
+ ( instancetype )taskGroupWithName: ( NSString * )name tasks: ( NSArray< id< SKRunableObject > > * )tasks;
/*!
* @method initWithName:tasks:
* @abstract Creates a task group object
* @param name The name of the task group
* @param tasks The tasks to execute when the task group is run
* @result The task group object
* @see SKRunableObject
*/
- ( instancetype )initWithName: ( NSString * )name tasks: ( NSArray< id< SKRunableObject > > * )tasks NS_DESIGNATED_INITIALIZER;
@end
NS_ASSUME_NONNULL_END