Add (and use) generic reference counter, to improve signal:noise ratio
[people/holger/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 done ( struct job_interface *job, int rc ) {
30         struct job_interface *dest = job_dest ( job );
31
32         dest->op->done ( dest, rc );
33 }
34
35 /****************************************************************************
36  *
37  * Helper methods
38  *
39  * These functions are designed to be used as methods in the
40  * job_interface_operations table.
41  *
42  */
43
44 void ignore_done ( struct job_interface *job __unused, int rc __unused ) {
45         /* Nothing to do */
46 }
47
48 void ignore_kill ( struct job_interface *job __unused ) {
49         /* Nothing to do */
50 }
51
52 void ignore_progress ( struct job_interface *job __unused,
53                        struct job_progress *progress ) {
54         memset ( progress, 0, sizeof ( *progress ) );
55 }
56
57 /** Null job control interface operations */
58 struct job_interface_operations null_job_ops = {
59         .done           = ignore_done,
60         .kill           = ignore_kill,
61         .progress       = ignore_progress,
62 };
63
64 /**
65  * Null job control interface
66  *
67  * This is the interface to which job control interfaces are connected
68  * when unplugged.  It will never generate messages, and will silently
69  * absorb all received messages.
70  */
71 struct job_interface null_job = {
72         .intf = {
73                 .dest = &null_job.intf,
74                 .refcnt = NULL,
75         },
76         .op = &null_job_ops,
77 };