Changeset 34435 in vbox for trunk/include

Timestamp:

Nov 28, 2010 2:58:25 PM (14 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

68208

Message:

ExtPack: Implemented unpacking (untested).

Location:

trunk/include/iprt

Files:

• file.h (modified) (1 diff)
• manifest.h (modified) (1 diff)
• vfs.h (modified) (2 diffs)
• vfslowlevel.h (modified) (2 diffs)

trunk/include/iprt/file.h

@@ -202 +202 @@
  *          On Windows the FILE_FLAG_NO_BUFFERING is used (see
  *          http://msdn.microsoft.com/en-us/library/cc644950(VS.85).aspx ).
- *          The buffer address, the transfer size and offset needs to be
- *          aligned to the sector size of the volume. Furthermore FILE_APPEND_DATA
- *          is disabled. To write beyond the size of file use RTFileSetSize prior
+ *          The buffer address, the transfer size and offset needs to be aligned
+ *          to the sector size of the volume.  Furthermore FILE_APPEND_DATA is
+ *          disabled.  To write beyond the size of file use RTFileSetSize prior
  *          writing the data to the file.
  *
- *          This flag does not work on Solaris if the target filesystem is ZFS. RTFileOpen will return an
- *          error with that configuration. When used with UFS the same alginment restrictions
- *          apply like Linux and Windows.
- *
- * @remarks This might not be implemented on all platforms,
- *          and will be ignored on those.
+ *          This flag does not work on Solaris if the target filesystem is ZFS.
+ *          RTFileOpen will return an error with that configuration.  When used
+ *          with UFS the same alginment restrictions apply like Linux and
+ *          Windows.
+ *
+ * @remarks This might not be implemented on all platforms, and will be ignored
+ *          on those.
  */
 #define RTFILE_O_NO_CACHE               UINT32_C(0x00080000)

trunk/include/iprt/manifest.h

@@ -211 +211 @@
 RTDECL(int) RTManifestEntryRemove(RTMANIFEST hManifest, const char *pszEntry);
 
+/**
+ * Add an entry for an I/O stream using a passthru stream.
+ *
+ * The passthru I/O stream will hash all the data read from or written to the
+ * stream and automatically add an entry to the manifest with the desired
+ * attributes when it is released.  Alternatively one can call
+ * RTManifestPtIosAddEntryNow() to have more control over exactly when this
+ * action is performed and which status it yields.
+ *
+ * @returns IPRT status code.
+ * @param   hManifest           The manifest to add the entry to.
+ * @param   hVfsIos             The I/O stream to pass thru to/from.
+ * @param   pszEntry            The entry name.
+ * @param   fAttrs              The attributes to create for this stream.
+ * @param   fReadOrWrite        Whether it's a read or write I/O stream.
+ * @param   phVfsIosPassthru    Where to return the new handle.
+ */
+RTDECL(int) RTManifestEntryAddPassthruIoStream(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos, const char *pszEntry,
+                                               uint32_t fAttrs, bool fReadOrWrite, PRTVFSIOSTREAM phVfsIosPassthru);
+
+/**
+ * Adds the entry to the manifest right now.
+ *
+ * @returns IPRT status code.
+ * @param   hVfsPtIos           The manifest passthru I/O stream returned by
+ *                              RTManifestEntryAddPassthruIoStream().
+ */
+RTDECL(int) RTManifestPtIosAddEntryNow(RTVFSIOSTREAM hVfsPtIos);
 
 /**

trunk/include/iprt/vfs.h

@@ -711 +711 @@
 
 
-/** @defgroup grp_vfs_file          VFS Miscellaneous
+/** @defgroup grp_vfs_misc          VFS Miscellaneous
  * @{
  */
@@ -729 +729 @@
 RTDECL(int) RTVfsMemorizeIoStreamAsFile(RTVFSIOSTREAM hVfsIos, uint32_t fFlags, PRTVFSFILE phVfsFile);
 
+
+/**
+ * Pumps data from one I/O stream to another.
+ *
+ * The data is read in chunks from @a hVfsIosSrc and written to @a hVfsIosDst
+ * until @hVfsIosSrc indicates end of stream.
+ *
+ * @returns IPRT status code
+ *
+ * @param   hVfsIosSrc  The input stream.
+ * @param   hVfsIosDst  The output stream.
+ * @param   cbBufHint   Hints at a good temporary buffer size, pass 0 if
+ *                      clueless.
+ */
+RTDECL(int) RTVfsUtilPumpIoStreams(RTVFSIOSTREAM hVfsIosSrc, RTVFSIOSTREAM hVfsIosDst, size_t cbBufHint);
+
 /** @}  */
 

trunk/include/iprt/vfslowlevel.h

@@ -750 +750 @@
 RTDECL(int) RTVfsNewIoStream(PCRTVFSIOSTREAMOPS pIoStreamOps, size_t cbInstance, uint32_t fOpen, RTVFS hVfs, RTVFSLOCK hLock,
                              PRTVFSIOSTREAM phVfsIos, void **ppvInstance);
+
+
+/**
+ * Gets the private data of an I/O stream.
+ *
+ * @returns Pointer to the private data.  NULL if the handle is invalid in some
+ *          way.
+ * @param   hVfsIos             The I/O stream handle.
+ * @param   pIoStreamOps        The I/O stream operations.  This servers as a
+ *                              sort of password.
+ */
+RTDECL(void *) RTVfsIoStreamToPrivate(RTVFSIOSTREAM hVfsIos, PCRTVFSIOSTREAMOPS pIoStreamOps);
 
 
@@ -926 +938 @@
 RTDECL(int) RTVfsUtilDummyPollOne(uint32_t fEvents, RTMSINTERVAL cMillies, bool fIntr, uint32_t *pfRetEvents);
 
-/**
- * Pumps data from one I/O stream to another.
- *
- * The data is read in chunks from @a hVfsIosSrc and written to @a hVfsIosDst
- * until @hVfsIosSrc indicates end of stream.
- *
- * @returns IPRT status code
- *
- * @param   hVfsIosSrc  The input stream.
- * @param   hVfsIosDst  The output stream.
- * @param   cbBufHint   Hints at a good temporary buffer size, pass 0 if
- *                      clueless.
- */
-RTDECL(int) RTVfsUtilPumpIoStreams(RTVFSIOSTREAM hVfsIosSrc, RTVFSIOSTREAM hVfsIosDst, size_t cbBufHint);
-
 /** @}  */