iPXE
job.c
Go to the documentation of this file.
00001 /*
00002  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
00003  *
00004  * This program is free software; you can redistribute it and/or
00005  * modify it under the terms of the GNU General Public License as
00006  * published by the Free Software Foundation; either version 2 of the
00007  * License, or any later version.
00008  *
00009  * This program is distributed in the hope that it will be useful, but
00010  * WITHOUT ANY WARRANTY; without even the implied warranty of
00011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012  * General Public License for more details.
00013  *
00014  * You should have received a copy of the GNU General Public License
00015  * along with this program; if not, write to the Free Software
00016  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
00017  * 02110-1301, USA.
00018  *
00019  * You can also choose to distribute this program under the terms of
00020  * the Unmodified Binary Distribution Licence (as given in the file
00021  * COPYING.UBDL), provided that you have satisfied its requirements.
00022  */
00023 
00024 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
00025 
00026 #include <string.h>
00027 #include <errno.h>
00028 #include <ipxe/job.h>
00029 
00030 /** @file
00031  *
00032  * Job control interfaces
00033  *
00034  */
00035 
00036 /**
00037  * Get job progress
00038  *
00039  * @v intf              Object interface
00040  * @v progress          Progress data to fill in
00041  * @ret ongoing_rc      Ongoing job status code (if known)
00042  */
00043 int job_progress ( struct interface *intf, struct job_progress *progress ) {
00044         struct interface *dest;
00045         job_progress_TYPE ( void * ) *op =
00046                 intf_get_dest_op ( intf, job_progress, &dest );
00047         void *object = intf_object ( dest );
00048         int ongoing_rc;
00049 
00050         DBGC ( INTF_COL ( intf ), "INTF " INTF_INTF_FMT " job_progress\n",
00051                INTF_INTF_DBG ( intf, dest ) );
00052 
00053         /* Initialise progress to zero */
00054         memset ( progress, 0, sizeof ( *progress ) );
00055 
00056         if ( op ) {
00057                 ongoing_rc = op ( object, progress );
00058         } else {
00059                 /* Default is to leave progress as zero and have no
00060                  * known return status code.
00061                  */
00062                 ongoing_rc = 0;
00063         }
00064 
00065         intf_put ( dest );
00066         return ongoing_rc;
00067 }