ZFThread_zfasyncIO.h File Reference

thread utility More...

#include "ZFThreadPool.h"

Go to the source code of this file.

Classes
class	ZFAsyncIOResumable
	resumable state for zfasyncIO More...
class	ZFThreadPoolForIO
	the thread pool for zfasyncIO More...

Functions
zfautoT< ZFTaskId >	zfasyncIOCustom (const ZFListener &callback, const ZFListener &finishCallback=(zft_zfnull))
	util to perform IO in ZFThreadPoolForIO
zfautoT< ZFTaskId >	zfasyncIO (const ZFOutput &output, const ZFInput &input, const ZFListener &finishCallback=(zft_zfnull), const ZFListener &progressCallback=(zft_zfnull), ZFAsyncIOResumable *resumable=(zft_zfnull))
	util to perform IO in ZFThreadPoolForIO

Detailed Description

thread utility

Function Documentation

zfasyncIOCustom()

zfautoT< ZFTaskId > zfasyncIOCustom ( const ZFListener & callback, const ZFListener & finishCallback = (zft_zfnull) )

extern

util to perform IO in ZFThreadPoolForIO

callback would run in new thread, finishCallback would run in ZFThread::mainThread

for the callback:

• ZFArgs::sender is the taskId returned from zfasyncIO
• ZFArgs::param0 is a ZFObject holds running task id, it's set to null if canceled, you may check it during thread running
• ZFArgs::result can be set to store the callback's result, which would passed to finishCallback as ZFArgs::param0

for the finishCallback:

• ZFArgs::sender is the taskId returned from zfasyncIO
• ZFArgs::param0 is the result object passed from callback

when ZFTaskId::stop called after this method, the callback may or may not be canceled, but finishCallback would be canceled

zfasyncIO()

zfautoT< ZFTaskId > zfasyncIO ( const ZFOutput & output, const ZFInput & input, const ZFListener & finishCallback = (zft_zfnull), const ZFListener & progressCallback = (zft_zfnull), ZFAsyncIOResumable * resumable = (zft_zfnull) )

extern

util to perform IO in ZFThreadPoolForIO

for the finishCallback:

• ZFArgs::sender is the taskId returned from zfasyncIO
• ZFArgs::param0 is a v_zfindex indicates size written, or zfindexMax if failed
• ZFArgs::param1 is the resumable object

for the progressCallback:

• ZFArgs::sender is the taskId returned from zfasyncIO
• ZFArgs::param0 is a v_zfindex indicates size written
• ZFArgs::param1 is a v_zfindex indicates total size, or zfindexMax if unknown

when ZFTaskId::stop called after this method, the callback may or may not be canceled, but finishCallback would be canceled

if you want to make the IO resumable:

• input and output must support ZFIOCallback::ioSeek
• first time:
  • pass a non-null resumable
  • when stopped failed or canceled, do not remove output file, and store or serialize the resumable object
• to resume state:
  • input and output's ZFCallback::callbackId must be same with first time
  • open output as v_ZFIOOpenOption::e_Modify (you must ensure the previous contents was kept)
  • restore or serialize the resumable object