API: SPCaches.h Source File

00001 /***********************************************************************/
00002 /*                                                                     */
00003 /* SPCaches.h                                                          */
00004 /*                                                                     */
00005 /* ADOBE SYSTEMS INCORPORATED                                          */
00006 /* Copyright 1995-2007 Adobe Systems Incorporated.                     */
00007 /* All Rights Reserved.                                                */
00008 /*                                                                     */
00009 /* NOTICE:  Adobe permits you to use, modify, and distribute this file */
00010 /* in accordance with the terms of the Adobe license agreement         */
00011 /* accompanying it. If you have received this file from a source other */
00012 /* than Adobe, then your use, modification, or distribution of it      */
00013 /* requires the prior written permission of Adobe.                     */
00014 /*                                                                     */
00015 /* Patents Pending                                                     */
00016 /*                                                                     */
00017 /*                                                                     */
00018 /***********************************************************************/
00019 
00020 #ifndef __SPCaches__
00021 #define __SPCaches__
00022 
00023 
00024 /*******************************************************************************
00025  **
00026  **     Imports
00027  **
00028  **/
00029 
00030 #include "SPTypes.h"
00031 #include "SPMData.h"
00032 
00033 #include "SPHeaderBegin.h"
00034 
00035 #ifdef __cplusplus
00036 extern "C" {
00037 #endif
00038 
00039 
00040 /*******************************************************************************
00041  **
00042  **     Constants
00043  **
00044  **/
00046 #define kSPCachesSuite                          "SP Caches Suite"
00047 
00048 #define kSPCachesSuiteVersion           2
00049 
00050 /* To receive these, an PIConditionalMessages property must be present
00051  * with the PIAcceptsPurgeCachesMessage flag set. */
00054 #define kSPCacheCaller                                  "SP Cache"
00055 
00062 #define kSPPluginPurgeCachesSelector    "Plug-in Purge"
00063 
00064 // The plug-in should return one of these two responses when it receives the kSPPluginPurgeCachesSelector
00065 // <<defined in SPErrorCodes.h>>
00066 //#define kSPPluginCachesFlushResponse  'pFls'
00067 //#define kSPPluginCouldntFlushResponse kSPNoError;
00068 #include "SPErrorCodes.h"
00069 
00070 /*******************************************************************************
00071  **
00072  **     Types
00073  **
00074  **/
00085 typedef SPErr (*SPFlushCachesProc)( const char *type, void *data, ai::int32 *flushed );
00086 
00088 typedef struct SPPurgeCachesMessage {
00090         SPMessageData d;
00091 } SPPurgeCachesMessage;
00092 
00093 
00094 /*******************************************************************************
00095  **
00096  **     Suite
00097  **
00098  **/
00112 typedef struct SPCachesSuite {
00120         SPAPI SPErr (*SPFlushCaches)( SPFlushCachesProc flushProc, ai::int32 *flushed );
00121 
00122 } SPCachesSuite;
00123 
00125 SPAPI SPErr SPFlushCaches( SPFlushCachesProc flushProc, ai::int32 *flushed );
00126 
00127 
00128 #ifdef __cplusplus
00129 }
00130 #endif
00131 
00132 #include "SPHeaderEnd.h"
00133 
00134 #endif