summaryrefslogtreecommitdiffstats
path: root/src/include/gpxe
diff options
context:
space:
mode:
authorMichael Brown2007-05-01 02:07:57 +0200
committerMichael Brown2007-05-01 02:07:57 +0200
commite3dcb9a1ade50f24c3ac5e9e11dce0b4de229d1f (patch)
tree67bb8c9db128d0d81d3f8b9bd7d55dc8b4f931b5 /src/include/gpxe
parentClarify behaviour of plug() by using intf_put() and intf_get(). (diff)
downloadipxe-e3dcb9a1ade50f24c3ac5e9e11dce0b4de229d1f.tar.gz
ipxe-e3dcb9a1ade50f24c3ac5e9e11dce0b4de229d1f.tar.xz
ipxe-e3dcb9a1ade50f24c3ac5e9e11dce0b4de229d1f.zip
Add start() event
Add "xfer" to all xfer functions and "job" to all job functions.
Diffstat (limited to 'src/include/gpxe')
-rw-r--r--src/include/gpxe/job.h47
-rw-r--r--src/include/gpxe/xfer.h63
2 files changed, 83 insertions, 27 deletions
diff --git a/src/include/gpxe/job.h b/src/include/gpxe/job.h
index ded6c8460..23077e7a6 100644
--- a/src/include/gpxe/job.h
+++ b/src/include/gpxe/job.h
@@ -33,6 +33,11 @@ struct job_interface;
/** Job control interface operations */
struct job_interface_operations {
+ /** Start job
+ *
+ * @v job Job control interface
+ */
+ void ( * start ) ( struct job_interface *job );
/** Job completed
*
* @v job Job control interface
@@ -64,12 +69,13 @@ struct job_interface {
extern struct job_interface null_job;
extern struct job_interface_operations null_job_ops;
-extern void done ( struct job_interface *job, int rc );
+extern void job_done ( struct job_interface *job, int rc );
-extern void ignore_done ( struct job_interface *job, int rc );
-extern void ignore_kill ( struct job_interface *job );
-extern void ignore_progress ( struct job_interface *job,
- struct job_progress *progress );
+extern void ignore_job_start ( struct job_interface *job );
+extern void ignore_job_done ( struct job_interface *job, int rc );
+extern void ignore_job_kill ( struct job_interface *job );
+extern void ignore_job_progress ( struct job_interface *job,
+ struct job_progress *progress );
/**
* Initialise a job control interface
@@ -109,6 +115,37 @@ job_dest ( struct job_interface *job ) {
}
/**
+ * Plug a job control interface into a new destination interface
+ *
+ * @v job Job control interface
+ * @v dest New destination interface
+ */
+static inline void job_plug ( struct job_interface *job,
+ struct job_interface *dest ) {
+ plug ( &job->intf, &dest->intf );
+}
+
+/**
+ * Plug two job control interfaces together
+ *
+ * @v a Job control interface A
+ * @v b Job control interface B
+ */
+static inline void job_plug_plug ( struct job_interface *a,
+ struct job_interface *b ) {
+ plug_plug ( &a->intf, &b->intf );
+}
+
+/**
+ * Unplug a job control interface
+ *
+ * @v job Job control interface
+ */
+static inline void job_unplug ( struct job_interface *job ) {
+ plug ( &job->intf, &null_job.intf );
+}
+
+/**
* Stop using a job control interface
*
* @v job Job control interface
diff --git a/src/include/gpxe/xfer.h b/src/include/gpxe/xfer.h
index 2423c03c4..3c46cdf2d 100644
--- a/src/include/gpxe/xfer.h
+++ b/src/include/gpxe/xfer.h
@@ -21,15 +21,17 @@ struct xfer_interface_operations {
*
* notification of non-close status - e.g. connected/opened, ...
*
- * seek
- *
* prompt for data delivery
*
* I/O buffer preparation
*
*/
-
+ /** Start data transfer
+ *
+ * @v xfer Data transfer interface
+ */
+ void ( * start ) ( struct xfer_interface *xfer );
/** Close interface
*
* @v xfer Data transfer interface
@@ -60,7 +62,7 @@ struct xfer_interface_operations {
*
* A data transfer interface that wishes to support only raw
* data delivery should set this method to
- * deliver_as_raw().
+ * xfer_deliver_as_raw().
*/
int ( * deliver ) ( struct xfer_interface *xfer,
struct io_buffer *iobuf );
@@ -73,7 +75,7 @@ struct xfer_interface_operations {
*
* A data transfer interface that wishes to support only I/O
* buffer delivery should set this method to
- * deliver_as_iobuf().
+ * xfer_deliver_as_iobuf().
*/
int ( * deliver_raw ) ( struct xfer_interface *xfer,
const void *data, size_t len );
@@ -90,24 +92,30 @@ struct xfer_interface {
extern struct xfer_interface null_xfer;
extern struct xfer_interface_operations null_xfer_ops;
-extern void close ( struct xfer_interface *xfer, int rc );
-extern int seek ( struct xfer_interface *xfer, size_t pos );
-extern int vredirect ( struct xfer_interface *xfer, int type, va_list args );
-extern int redirect ( struct xfer_interface *xfer, int type, ... );
-extern int deliver ( struct xfer_interface *xfer, struct io_buffer *iobuf );
-extern int deliver_raw ( struct xfer_interface *xfer,
- const void *data, size_t len );
-
-extern void ignore_close ( struct xfer_interface *xfer, int rc );
-extern int ignore_vredirect ( struct xfer_interface *xfer,
- int type, va_list args );
-extern int ignore_seek ( struct xfer_interface *xfer, size_t pos );
-extern int deliver_as_raw ( struct xfer_interface *xfer,
- struct io_buffer *iobuf );
-extern int deliver_as_iobuf ( struct xfer_interface *xfer,
+extern void xfer_start ( struct xfer_interface *xfer );
+extern void xfer_close ( struct xfer_interface *xfer, int rc );
+extern int xfer_seek ( struct xfer_interface *xfer, size_t pos );
+extern int xfer_vredirect ( struct xfer_interface *xfer, int type,
+ va_list args );
+extern int xfer_redirect ( struct xfer_interface *xfer, int type, ... );
+extern int xfer_deliver ( struct xfer_interface *xfer,
+ struct io_buffer *iobuf );
+extern int xfer_deliver_raw ( struct xfer_interface *xfer,
const void *data, size_t len );
-extern int ignore_deliver_raw ( struct xfer_interface *xfer,
- const void *data __unused, size_t len );
+
+extern void ignore_xfer_start ( struct xfer_interface *xfer );
+extern void ignore_xfer_close ( struct xfer_interface *xfer, int rc );
+extern int ignore_xfer_vredirect ( struct xfer_interface *xfer,
+ int type, va_list args );
+extern int default_xfer_vredirect ( struct xfer_interface *xfer,
+ int type, va_list args );
+extern int ignore_xfer_seek ( struct xfer_interface *xfer, size_t pos );
+extern int xfer_deliver_as_raw ( struct xfer_interface *xfer,
+ struct io_buffer *iobuf );
+extern int xfer_deliver_as_iobuf ( struct xfer_interface *xfer,
+ const void *data, size_t len );
+extern int ignore_xfer_deliver_raw ( struct xfer_interface *xfer,
+ const void *data __unused, size_t len );
/**
* Initialise a data transfer interface
@@ -158,6 +166,17 @@ static inline void xfer_plug ( struct xfer_interface *xfer,
}
/**
+ * Plug two data transfer interfaces together
+ *
+ * @v a Data transfer interface A
+ * @v b Data transfer interface B
+ */
+static inline void xfer_plug_plug ( struct xfer_interface *a,
+ struct xfer_interface *b ) {
+ plug_plug ( &a->intf, &b->intf );
+}
+
+/**
* Unplug a data transfer interface
*
* @v xfer Data transfer interface