1/* 2 * Copyright 2020 Haiku, Inc. All rights reserved. 3 * Distributed under the terms of the MIT License. 4 * 5 * Authors: 6 * Name, email@email.com 7 * 8 * Corresponds to: 9 * headers/os/support/Job.h hrev49696 10 * src/kits/support/Job.cpp hrev49696 11 */ 12 13 14//! \cond INTERNAL 15 16 17/*! 18 \file Job.h 19 \ingroup support 20 \brief Undocumented file. 21 22 \since Haiku R1 23*/ 24 25 26/*! 27 \struct BSupportKit::BJobStateListener 28 \ingroup support 29 \ingroup libbe 30 \brief Undocumented class. 31 32 \since Haiku R1 33*/ 34 35 36/*! 37 \fn virtual BSupportKit::BJobStateListener::~BJobStateListener() 38 \brief Undocumented destructor 39 40 \return Undocumented 41 \retval <value> Undocumented 42 43 \since Haiku R1 44*/ 45 46 47/*! 48 \fn virtual void BSupportKit::BJobStateListener::JobAborted(BJob *job) 49 \brief Undocumented public method 50 51 \param job Undocumented 52 53 \since Haiku R1 54*/ 55 56 57/*! 58 \fn virtual void BSupportKit::BJobStateListener::JobFailed(BJob *job) 59 \brief Undocumented public method 60 61 \param job Undocumented 62 63 \since Haiku R1 64*/ 65 66 67/*! 68 \fn virtual void BSupportKit::BJobStateListener::JobProgress(BJob *job) 69 \brief Undocumented public method 70 71 \param job Undocumented 72 73 \since Haiku R1 74*/ 75 76 77/*! 78 \fn virtual void BSupportKit::BJobStateListener::JobStarted(BJob *job) 79 \brief Undocumented public method 80 81 \param job Undocumented 82 83 \since Haiku R1 84*/ 85 86 87/*! 88 \fn virtual void BSupportKit::BJobStateListener::JobSucceeded(BJob *job) 89 \brief Undocumented public method 90 91 \param job Undocumented 92 93 \since Haiku R1 94*/ 95 96 97/*! 98 \enum BSupportKit::BJobState 99 \brief Undocumented enum 100*/ 101 102 103/*! 104 \var BJobState BSupportKit::B_JOB_STATE_WAITING_TO_RUN 105 \brief Undocumented 106*/ 107 108 109/*! 110 \var BJobState BSupportKit::B_JOB_STATE_STARTED 111 \brief Undocumented 112*/ 113 114 115/*! 116 \var BJobState BSupportKit::B_JOB_STATE_IN_PROGRESS 117 \brief Undocumented 118*/ 119 120 121/*! 122 \var BJobState BSupportKit::B_JOB_STATE_SUCCEEDED 123 \brief Undocumented 124*/ 125 126 127 128/*! 129 \var BJobState BSupportKit::B_JOB_STATE_FAILED 130 \brief Undocumented 131*/ 132 133 134/*! 135 \var BJobState BSupportKit::B_JOB_STATE_ABORTED 136 \brief Undocumented 137*/ 138 139 140/*! 141 \class BSupportKit::BJob 142 \ingroup support 143 \ingroup libbe 144 \brief Undocumented class. 145 146 \since Haiku R1 147*/ 148 149 150/*! 151 \fn BSupportKit::BJob::BJob(const BString &title) 152 \brief Undocumented constructor 153 154 \param title Undocumented 155 156 \return Undocumented 157 \retval <value> Undocumented 158 159 \since Haiku R1 160*/ 161 162 163/*! 164 \fn virtual BSupportKit::BJob::~BJob() 165 \brief Undocumented destructor 166 167 \return Undocumented 168 \retval <value> Undocumented 169 170 \since Haiku R1 171*/ 172 173 174/*! 175 \fn status_t BSupportKit::BJob::AddDependency(BJob *job) 176 \brief Undocumented public method 177 178 \param job Undocumented 179 180 \return Undocumented 181 \retval <value> Undocumented 182 183 \since Haiku R1 184*/ 185 186 187/*! 188 \fn status_t BSupportKit::BJob::AddStateListener(BJobStateListener *listener) 189 \brief Undocumented public method 190 191 \param listener Undocumented 192 193 \return Undocumented 194 \retval <value> Undocumented 195 196 \since Haiku R1 197*/ 198 199 200/*! 201 \fn int32 BSupportKit::BJob::CountDependencies() const 202 \brief Undocumented public method 203 204 \return Undocumented 205 \retval <value> Undocumented 206 207 \since Haiku R1 208*/ 209 210 211/*! 212 \fn BJob* BSupportKit::BJob::DependantJobAt(int32 index) const 213 \brief Undocumented public method 214 215 \param index Undocumented 216 217 \return Undocumented 218 \retval <value> Undocumented 219 220 \since Haiku R1 221*/ 222 223 224/*! 225 \fn const BString& BSupportKit::BJob::ErrorString() const 226 \brief Undocumented public method 227 228 \return Undocumented 229 \retval <value> Undocumented 230 231 \since Haiku R1 232*/ 233 234 235/*! 236 \fn status_t BSupportKit::BJob::InitCheck() const 237 \brief Undocumented public method 238 239 \return Undocumented 240 \retval <value> Undocumented 241 242 \since Haiku R1 243*/ 244 245 246/*! 247 \fn bool BSupportKit::BJob::IsRunnable() const 248 \brief Undocumented public method 249 250 \return Undocumented 251 \retval <value> Undocumented 252 253 \since Haiku R1 254*/ 255 256 257/*! 258 \fn status_t BSupportKit::BJob::RemoveDependency(BJob *job) 259 \brief Undocumented public method 260 261 \param job Undocumented 262 263 \return Undocumented 264 \retval <value> Undocumented 265 266 \since Haiku R1 267*/ 268 269 270/*! 271 \fn status_t BSupportKit::BJob::RemoveStateListener(BJobStateListener *listener) 272 \brief Undocumented public method 273 274 \param listener Undocumented 275 276 \return Undocumented 277 \retval <value> Undocumented 278 279 \since Haiku R1 280*/ 281 282 283/*! 284 \fn status_t BSupportKit::BJob::Result() const 285 \brief Undocumented public method 286 287 \return Undocumented 288 \retval <value> Undocumented 289 290 \since Haiku R1 291*/ 292 293 294/*! 295 \fn virtual status_t BSupportKit::BJob::Run() 296 \brief Undocumented public method 297 298 \return Undocumented 299 \retval <value> Undocumented 300 301 \since Haiku R1 302*/ 303 304 305/*! 306 \fn BJobState BSupportKit::BJob::State() const 307 \brief Undocumented public method 308 309 \return Undocumented 310 \retval <value> Undocumented 311 312 \since Haiku R1 313*/ 314 315 316/*! 317 \fn uint32 BSupportKit::BJob::TicketNumber() const 318 \brief Undocumented public method 319 320 \return Undocumented 321 \retval <value> Undocumented 322 323 \since Haiku R1 324*/ 325 326 327/*! 328 \fn const BString& BSupportKit::BJob::Title() const 329 \brief Undocumented public method 330 331 \return Undocumented 332 \retval <value> Undocumented 333 334 \since Haiku R1 335*/ 336 337 338/*! 339 \fn virtual void BSupportKit::BJob::Cleanup(status_t jobResult) 340 \brief Undocumented protected method 341 342 \param jobResult Undocumented 343 344 \since Haiku R1 345*/ 346 347 348/*! 349 \fn virtual status_t BSupportKit::BJob::Execute()=0 350 \brief Undocumented protected method 351 352 \return Undocumented 353 \retval <value> Undocumented 354 355 \since Haiku R1 356*/ 357 358 359/*! 360 \fn void BSupportKit::BJob::NotifyStateListeners() 361 \brief Undocumented protected method 362 363 \since Haiku R1 364*/ 365 366 367/*! 368 \fn void BSupportKit::BJob::SetErrorString(const BString &) 369 \brief Undocumented protected method 370 371 \since Haiku R1 372*/ 373 374 375/*! 376 \fn void BSupportKit::BJob::SetState(BJobState state) 377 \brief Undocumented protected method 378 379 \param state Undocumented 380 381 \since Haiku R1 382*/ 383 384 385//! \endcond INTERNAL 386