Add start() event
[people/pcmattman/gpxe.git] / src / core / job.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <string.h>
20 #include <errno.h>
21 #include <gpxe/job.h>
22
23 /** @file
24  *
25  * Job control interfaces
26  *
27  */
28
29 void job_done ( struct job_interface *job, int rc ) {
30         struct job_interface *dest = job_dest ( job );
31
32         dest->op->done ( dest, rc );
33         job_unplug ( job );
34 }
35
36 /****************************************************************************
37  *
38  * Helper methods
39  *
40  * These functions are designed to be used as methods in the
41  * job_interface_operations table.
42  *
43  */
44
45 void ignore_job_start ( struct job_interface *job __unused ) {
46         /* Nothing to do */
47 }
48
49 void ignore_job_done ( struct job_interface *job __unused, int rc __unused ) {
50         /* Nothing to do */
51 }
52
53 void ignore_job_kill ( struct job_interface *job __unused ) {
54         /* Nothing to do */
55 }
56
57 void ignore_job_progress ( struct job_interface *job __unused,
58                            struct job_progress *progress ) {
59         memset ( progress, 0, sizeof ( *progress ) );
60 }
61
62 /** Null job control interface operations */
63 struct job_interface_operations null_job_ops = {
64         .start          = ignore_job_start,
65         .done           = ignore_job_done,
66         .kill           = ignore_job_kill,
67         .progress       = ignore_job_progress,
68 };
69
70 /**
71  * Null job control interface
72  *
73  * This is the interface to which job control interfaces are connected
74  * when unplugged.  It will never generate messages, and will silently
75  * absorb all received messages.
76  */
77 struct job_interface null_job = {
78         .intf = {
79                 .dest = &null_job.intf,
80                 .refcnt = NULL,
81         },
82         .op = &null_job_ops,
83 };