job.h File Reference

Job control interfaces. More...

#include <ipxe/interface.h>

Go to the source code of this file.

Data Structures
struct	job_progress
	Job progress. More...

Macros
#define	job_progress_TYPE(object_type)

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	job_progress (struct interface *intf, struct job_progress *progress)
	Get job progress.

Detailed Description

Job control interfaces.

Definition in file job.h.

Macro Definition Documentation

job_progress_TYPE

#define job_progress_TYPE

(

object_type

)

Value:

        typeof ( int ( object_type, struct job_progress *progress ) )

Definition at line 38 of file job.h.

#define job_progress_TYPE( object_type ) \
        typeof ( int ( object_type, struct job_progress *progress ) )

Referenced by job_progress().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

job_progress()

int job_progress ( struct interface * intf, struct job_progress * progress )

extern

Get job progress.

Parameters

intf	Object interface
progress	Progress data to fill in

Return values

ongoing_rc

Ongoing job status code (if known)

Definition at line 44 of file job.c.

                                                                           {
        struct interface *dest;
        job_progress_TYPE ( void * ) *op =
                intf_get_dest_op ( intf, job_progress, &dest );
        void *object = intf_object ( dest );
        int ongoing_rc;
 
        DBGC ( INTF_COL ( intf ), "INTF " INTF_INTF_FMT " job_progress\n",
               INTF_INTF_DBG ( intf, dest ) );
 
        /* Initialise progress to zero */
        memset ( progress, 0, sizeof ( *progress ) );
 
        if ( op ) {
                ongoing_rc = op ( object, progress );
        } else {
                /* Default is to leave progress as zero and have no
                 * known return status code.
                 */
                ongoing_rc = 0;
        }
 
        intf_put ( dest );
        return ongoing_rc;
}

References DBGC, dest, interface::intf, INTF_COL, intf_get_dest_op, INTF_INTF_DBG, INTF_INTF_FMT, intf_object(), intf_put(), job_progress_TYPE, memset(), and op.

Referenced by monojob_wait(), and tls_progress().