blob: be87b370546fdd6a89e4ca4bb56accf5b9495f8b (
plain)
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/* IQueueManager.cs $
This file is part of the HandBrake source code.
Homepage: <http://handbrake.fr/>.
It may be used under the terms of the GNU General Public License. */
namespace HandBrake.ApplicationServices.Services.Interfaces
{
using System;
using System.Collections.ObjectModel;
using HandBrake.ApplicationServices.Model;
/// <summary>
/// The Queue Manager Interface
/// </summary>
public interface IQueueManager
{
/// <summary>
/// Fires when a job is Added, Removed or Re-Ordered.
/// Should be used for triggering an update of the Queue Window.
/// </summary>
event EventHandler QueueChanged;
/// <summary>
/// Gets or sets Last Processed Job.
/// This is set when the job is poped of the queue by GetNextJobForProcessing();
/// </summary>
QueueTask LastProcessedJob { get; set; }
/// <summary>
/// Gets The current queue.
/// </summary>
ReadOnlyCollection<QueueTask> Queue { get; }
/// <summary>
/// Gets the number of jobs in the queue
/// </summary>
int Count { get; }
/// <summary>
/// Add a job to the Queue.
/// This method is Thread Safe.
/// </summary>
/// <param name="job">
/// The encode Job object.
/// </param>
void Add(QueueTask job);
/// <summary>
/// Remove a job from the Queue.
/// This method is Thread Safe
/// </summary>
/// <param name="job">
/// The job.
/// </param>
void Remove(QueueTask job);
/// <summary>
/// Reset a Queued Item from Error or Completed to Waiting
/// </summary>
/// <param name="job">
/// The job.
/// </param>
void ResetJobStatusToWaiting(QueueTask job);
/// <summary>
/// Clear down the Queue�s completed items
/// </summary>
void ClearCompleted();
/// <summary>
/// Get the first job on the queue for processing.
/// This also removes the job from the Queue and sets the LastProcessedJob
/// </summary>
/// <returns>
/// An encode Job object.
/// </returns>
QueueTask GetNextJobForProcessing();
/// <summary>
/// Moves an item up one position in the queue.
/// </summary>
/// <param name="index">The zero-based location of the job in the queue.</param>
void MoveUp(int index);
/// <summary>
/// Moves an item down one position in the queue.
/// </summary>
/// <param name="index">The zero-based location of the job in the queue.</param>
void MoveDown(int index);
/// <summary>
/// Backup any changes to the queue file
/// </summary>
/// <param name="exportPath">
/// If this is not null or empty, this will be used instead of the standard backup location.
/// </param>
void BackupQueue(string exportPath);
/// <summary>
/// Restore a Queue from file or from the queue backup file.
/// </summary>
/// <param name="importPath">
/// The import path. String.Empty or null will result in the default file being loaded.
/// </param>
void RestoreQueue(string importPath);
/// <summary>
/// Checks the current queue for an existing instance of the specified destination.
/// </summary>
/// <param name="destination">The destination of the encode.</param>
/// <returns>Whether or not the supplied destination is already in the queue.</returns>
bool CheckForDestinationPathDuplicates(string destination);
/// <summary>
/// Create a batch script from the queue
/// </summary>
/// <param name="path">
/// The path to the location for the script to be saved.
/// </param>
/// <returns>
/// True if sucessful
/// </returns>
bool WriteBatchScriptToFile(string path);
}
}
|
