From 4ca811957acd156cc5be679477007ad654035607 Mon Sep 17 00:00:00 2001 From: Tyler Dauwalder Date: Wed, 28 May 2003 21:39:56 +0000 Subject: [PATCH] DiskDeviceAPI Protocols v2.0 git-svn-id: file:///srv/svn/repos/haiku/trunk/current@3371 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- docs/develop/storage/DiskDeviceAPI_Protocols | 36 ++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/develop/storage/DiskDeviceAPI_Protocols diff --git a/docs/develop/storage/DiskDeviceAPI_Protocols b/docs/develop/storage/DiskDeviceAPI_Protocols new file mode 100644 index 0000000000..40ea51e571 --- /dev/null +++ b/docs/develop/storage/DiskDeviceAPI_Protocols @@ -0,0 +1,36 @@ +Disk Device Protocols +===================== + +disk device job progress update message + +target: Registered progress update BMessenger for the given job +message: B_DISK_DEVICE_JOB_UPDATE + "job_id": B_INT32_TYPE + "progress": B_UINT8_TYPE + [ "description": B_STRING_TYPE ] +reply: none (asynchronous message) + +message fields: +- job_id: Unique job identifier +- progress: Percent of job completed (0 to 100) +- description: Optional description of current action being taken, i.e. + "allocating inodes", "writing superblock", etc. + +----------------------------------------------------------------------- + +disk device job finished message + +target: Registered progress update BMessenger for the given job +message: B_DISK_DEVICE_JOB_FINISHED + "job_id": B_INT32_TYPE +reply: none (asynchronous message) + +message fields: +- job_id: Unique job identifier + +notes: +A separate job finished message is needed, as rounding error in +the computation of job progress may result in multiple +B_DISK_DEVICE_JOB_UPDATE messages with "progress" fields of 100. + +-----------------------------------------------------------------------