From fc14e784610a3bb2a5aeada8f92537aab2e8116a Mon Sep 17 00:00:00 2001 From: Tyler Dauwalder Date: Wed, 28 May 2003 21:40:29 +0000 Subject: [PATCH] DiskDeviceAPI Protocols v2.3 git-svn-id: file:///srv/svn/repos/haiku/trunk/current@3372 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- docs/develop/storage/DiskDeviceAPI_Protocols | 72 +++++++++++++++++--- 1 file changed, 63 insertions(+), 9 deletions(-) diff --git a/docs/develop/storage/DiskDeviceAPI_Protocols b/docs/develop/storage/DiskDeviceAPI_Protocols index 40ea51e571..fa64a90eaf 100644 --- a/docs/develop/storage/DiskDeviceAPI_Protocols +++ b/docs/develop/storage/DiskDeviceAPI_Protocols @@ -1,32 +1,54 @@ Disk Device Protocols ===================== -disk device job progress update message +disk device job scheduled message -target: Registered progress update BMessenger for the given job -message: B_DISK_DEVICE_JOB_UPDATE +target: Registered job update BMessengers +message: B_DISK_DEVICE_JOB_SCHEDULED + "job_id": B_INT32_TYPE +reply: none (asynchronous message) + +message fields: +- job_id: Unique job identifier + +----------------------------------------------------------------------- + +disk device job initiated message + +target: Registered job update BMessengers +message: B_DISK_DEVICE_JOB_INITIATED + "job_id": B_INT32_TYPE +reply: none (asynchronous message) + +message fields: +- job_id: Unique job identifier + +----------------------------------------------------------------------- + +disk device job canceled message + +target: Registered job update BMessengers +message: B_DISK_DEVICE_JOB_CANCELED "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 +target: Registered job update BMessengers message: B_DISK_DEVICE_JOB_FINISHED "job_id": B_INT32_TYPE + "succeeded": B_BOOL_TYPE + [ "info": B_STRING_TYPE ] reply: none (asynchronous message) message fields: - job_id: Unique job identifier +- info: Optional description of success or failure notes: A separate job finished message is needed, as rounding error in @@ -34,3 +56,35 @@ the computation of job progress may result in multiple B_DISK_DEVICE_JOB_UPDATE messages with "progress" fields of 100. ----------------------------------------------------------------------- + +disk device job simple progress update message + +target: Registered job simple progress update BMessengers +message: B_DISK_DEVICE_JOB_SIMPLE_PROGRESS + "job_id": B_INT32_TYPE + "progress": B_UINT8_TYPE + "info": B_STRING_TYPE +reply: none (asynchronous message) + +message fields: +- job_id: Unique job identifier +- progress: Percent of job completed (0 to 100) +- info: Description of current action being taken, i.e. + "allocating inodes", "writing superblock", etc. + +----------------------------------------------------------------------- + +disk device job extra progress update message + +target: Registered job extra progress update BMessengers +message: B_DISK_DEVICE_JOB_EXTRA_PROGRESS + "job_id": B_INT32_TYPE + "info": B_STRING_TYPE +reply: none (asynchronous message) + +message fields: +- job_id: Unique job identifier +- info: Extended progress info string, i.e. "block 123: found + invalid inode; fixing" + +-----------------------------------------------------------------------