AsyncWork.h

//========================================================================================
// 
// $File$
// 
// Owner: Paul Messmer
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __ASYNCWORK__
#define __ASYNCWORK__

//--------------------------------------------------------------------------------------
class AsyncWorkPacket
{ 
public:

 enum Priority
 {
 kLowestPriority = 0,
 
 kLowPriority = 0,
 kNormalPriority = 1,
 kHighPriority = 2,

 kHighestPriority = 2,

 kReservedForceCompletionPriority = 3, // clients shouldn't use; this level is used by IAsyncWorkManager::WaitForCompletion
 };
 virtual ~AsyncWorkPacket () {} 
};

//--------------------------------------------------------------------------------------

typedef uint64 AsyncWorkPacketID;
typedef void (*AsyncWorkCompletionCallback) (AsyncWorkPacket *completedPacket);

const AsyncWorkPacketID kInvalidAsyncWorkPacketID((uint64) -1);

//--------------------------------------------------------------------------------------

class AsyncWorkProcessor
{ 
public:

 virtual ~AsyncWorkProcessor () {} // virtual destructor because the architecture deletes these

 virtual void ProcessPacket (AsyncWorkPacket *packetToProcess) = 0;
};

//--------------------------------------------------------------------------------------

#endif // __ASYNCWORK__