Do not hold self-references. This then avoids the problem of having to
[people/dverkamp/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_get_dest ( job );
31
32         dest->op->done ( dest, rc );
33         job_unplug ( job );
34         job_put ( dest );
35 }
36
37 /****************************************************************************
38  *
39  * Helper methods
40  *
41  * These functions are designed to be used as methods in the
42  * job_interface_operations table.
43  *
44  */
45
46 void ignore_job_start ( struct job_interface *job __unused ) {
47         /* Nothing to do */
48 }
49
50 void ignore_job_done ( struct job_interface *job __unused, int rc __unused ) {
51         /* Nothing to do */
52 }
53
54 void ignore_job_kill ( struct job_interface *job __unused ) {
55         /* Nothing to do */
56 }
57
58 void ignore_job_progress ( struct job_interface *job __unused,
59                            struct job_progress *progress ) {
60         memset ( progress, 0, sizeof ( *progress ) );
61 }
62
63 /** Null job control interface operations */
64 struct job_interface_operations null_job_ops = {
65         .start          = ignore_job_start,
66         .done           = ignore_job_done,
67         .kill           = ignore_job_kill,
68         .progress       = ignore_job_progress,
69 };
70
71 /**
72  * Null job control interface
73  *
74  * This is the interface to which job control interfaces are connected
75  * when unplugged.  It will never generate messages, and will silently
76  * absorb all received messages.
77  */
78 struct job_interface null_job = {
79         .intf = {
80                 .dest = &null_job.intf,
81                 .refcnt = NULL,
82         },
83         .op = &null_job_ops,
84 };