FCL/sf/os/kernelhwsrv: comparison userlibandfileserver/fileserver/inc/F32plugin.h

equal deleted inserted replaced

-:f497542af8e4
+:538db54a451d
 const TInt KPluginMessageComplete = 2; ///< Returned from ::Dispatch() to indicate that a request has been processed synchronously and should be passed back up the stack.
 const TInt KCountNeeded=KMinTInt;
 /**
 List of file server operations
 */
 enum TFsMessage
 	{
 	EFsAddFileSystem,           ///< Adds a file system
 	EFsRemoveFileSystem,        ///< Removes a file system
 	EFsGetDriveName,            ///<  Gets the name of a drive
 	EFsSetDriveName,            ///< Sets the name of a drive
 	EFsFormatSubClose,          ///< Closes the Format subsession
 	EFsDirSubClose,             ///< Closes the directory.
 	EFsFileSubClose,            ///< Closes the file
 	EFsRawSubClose,             ///< Closes the direct access channel to the disk
 	EFsFileOpen,				///< -- 30 Opens file
 	EFsFileCreate,				///< Creates and opens a new file
 	EFsFileReplace,             ///< Replaces a file of the same name or creates a new file
 	EFsFileTemp,				///< Creates and opens a temporary file
 	EFsFileRead,                ///< Reads from the file
 	EFsFileDuplicate,           ///< Makes a duplicate of this file handle
 	EFsFileAdopt,               ///< Adopts an already open file
 	EFsSwapFileSystem,          ///< Swaps file systems
 	EFsErasePassword,           ///< Erase the password from the locked MultiMedia card
 	EFsReserveDriveSpace,		///< -- 100 Reserves an area of a drive
 	EFsGetReserveAccess,        ///< Get exclusive access to reserved area
 	EFsReleaseReserveAccess,    ///< Release exclusive access to reserved area
 	EFsFileName,                ///< Gets the final part of a filename
 EFsGetMediaSerialNumber,    ///<  Gets the serial number of media
 	EFsFileFullName,            ///< Gets the full filename
 	EFsAddPlugin,               ///< Adds the specified plugin
 	EFsRemovePlugin,            ///< Removes the specified plugin
 	EFsMountPlugin,			    ///< Mounts the specified plugin
 	EFsDismountPlugin,	        ///< Dismounts the specified plugin
 	EFsPluginName,				///<-- 110 Gets a plugin's name in specific position and drive
 	EFsPluginOpen,              ///< Opens the plugin
 	EFsPluginSubClose,          ///< Closes the plugin
 	EFsPluginDoRequest,         ///< Issues an asynchronous plugin request
 	EFsPluginDoControl,         ///< Issues a synchronous plugin request
 	EFsPluginDoCancel,          ///< Cancels an synchronous plugin request
 	EFsRemoveProxyDrive,		///< Unloads a proxy drive
 	EFsMountProxyDrive,			///< Mounts a proxy drive
 	EFsDismountProxyDrive,		///< Dismounts a proxy drive
 	EFsNotificationOpen,		///< Opens the notification
 	EFsNotificationBuffer,		///< Communicates buffer to file server
 	EFsNotificationRequest,		///< Sends the notification request
 	EFsNotificationCancel,		///< Cancels the notification request
-	EFsNotificationSubClose,	///< -- 140 Closes the notification
+	EFsNotificationSubClose,	///< Closes the notification
-	EFsNotificationAdd,			///< Adds filter to the server, comprising a path and notification type
+	EFsNotificationAdd,			///< -- 140 Adds filter to the server, comprising a path and notification type
 	EFsNotificationRemove,		///< Removes filters from Server-Side
 	EFsLoadCodePage,			///< Loads a code page library
 	EMaxClientOperations		///< This must always be the last operation insert above
 	};
 class CFsRequest;
 /**
 Request wrapper for plugins
 */
 class TFsPluginRequest
 	{
 public:
 		EAtt,
 		EAttMask,
 		EUid,
 		EEntryArray,
 		ENewPosition,
+		EVolumeInfo
 		};
 	IMPORT_C TFsPluginRequest(CFsRequest* aRequest);
 	/**
 	IMPORT_C virtual TInt Remove();
 	IMPORT_C void SetLibrary(RLibrary aLib);
 	IMPORT_C RLibrary Library() const;
 public:
 	/**
 	@internalTechnology
 	Installs the plugin factory
 	@return KErrNone or one of the system wide errors
 	*/
 	virtual TInt Install()=0;
 	/**
 	@internalTechnology
 	Creates a new plugin
 	@return plugin object
 	*/
 	virtual CFsPlugin* NewPluginL()=0;
 	/**
 	@internalTechnology
 	Returns unique position of the plugin
 	@return unique position of the plugin
 	*/
 	virtual TInt UniquePosition()=0;
 	inline TInt Drive();
 	inline void SetDrive(TInt aDrive);
 	inline virtual TInt SessionDisconnect(CSessionFs* aSession);
 protected:
 	IMPORT_C virtual void InitialiseL();
 	IMPORT_C virtual TInt Deliver(TFsPluginRequest& aRequest);
 	virtual TInt DoRequestL(TFsPluginRequest& aRequest) = 0;
 	IMPORT_C virtual CFsPluginConn* NewPluginConnL();
 	IMPORT_C TInt RegisterIntercept(TInt aMessage, TInterceptAtts aInterceptAtts);
 	/**
 	The remaining space in this base class in release 9.1 is defined as follows:
 		TUint8 iRegisteredIntercepts[EMaxClientOperations << 1];	244 bytes
 		TInt iUniquePos;											  4 bytes
 															TOTAL	248 bytes
 	where EMaxClientOperations = 122.
 	Unfortunately, the remaining space in release 9.2+ WAS defined as follows:
 	    enum {KIntcArrSize = 123*2};
 	    TUint8  iRegisteredIntercepts[KIntcArrSize];				246 bytes
 																	  2 bytes (padding)
 		TInt iUniquePos;											  4 bytes
 															TOTAL:	252 bytes
-	This meant that a 9.1-compiled plugin running on 9.2+ would have it's first data
+	This meant that a 9.1-compiled plugin running on 9.2+ would have its first data
 	member overwritten when the base class (CFsPlugin) wrote to iUniquePos.
 	To maintain Binary Compatibility (BC), we need to preserve both the (smaller) 9.1
 	and (larger) 9.2+ class sizes.
 	To allow 9.1 plugins to work unchanged on 9.2+ iUniquePos has been moved to BEFORE
 	the iRegisteredIntercepts byte array
 	N.B. - the iRegisteredIntercepts array uses only 2 bits per function, so the
 	array size only needs to be >= EMaxClientOperations/4.
 	*/
 enum {KIntcArrSize = 132};
 	TInt iUniquePos;									//			  4 bytes
 TUint8 iRegisteredIntercepts[KIntcArrSize];			//			132 bytes
 	TInt iLastError;									//            4 bytes
 	TFsPluginRequest* iRequest;
 	TUint iSpare[4];
 	};
 /**
+A class for making file server request internally from within a
+file server plugin.
+See also RFilePlugin and RDirPlugin.
 @publishedPartner
 @released
 */
 class RFsPlugin : private RFs
 {
 	IMPORT_C TInt Rename(const TDesC& anOldName,const TDesC& aNewName);
 	IMPORT_C TInt Replace(const TDesC& anOldName,const TDesC& aNewName);
 	IMPORT_C TInt Entry(const TDesC& aName,TEntry& anEntry) const;
 	IMPORT_C TInt SetEntry(const TDesC& aName,const TTime& aTime,TUint aSetAttMask,TUint aClearAttMask);
 	IMPORT_C TInt ReadFileSection(const TDesC& aName,TInt64 aPos,TDes8& aDes,TInt aLength) const;
+	IMPORT_C TInt Volume(TVolumeInfo &aVol,TInt aDrive=KDefaultDrive) const;
 protected:
 	TInt SendReceive(TInt aFunction,const TIpcArgs& aArgs) const;
 private:
 // open a NEW file using same session as passed request
 	IMPORT_C TInt Open(const TDesC& aName,TUint aMode);
 	IMPORT_C TInt Create(const TDesC& aName,TUint aFileMode);
 IMPORT_C TInt Replace(const TDesC& aName,TUint aFileMode);
 IMPORT_C TInt Temp(const TDesC& aPath,TFileName& aName,TUint aFileMode);
 // re-open SAME file as client's request
 IMPORT_C TInt AdoptFromClient();
 // Transfer the plugin's open file to the client
 	IMPORT_C TInt TransferToClient();
 	IMPORT_C void Close();
 // RFile overloads
 IMPORT_C TInt Read(TInt64 aPos,TDes8& aDes) const;
 	IMPORT_C TInt Read(TInt64 aPos,TDes8& aDes,TInt aLength) const;
 	void DoRequest();
 	inline void Complete(TInt aError);
 public:
 	TInt InitControl(CFsRequest* aRequest);
 	TInt InitRequest(CFsRequest* aRequest);
 private:
 	TDblQueLink iLink;
 	CFsPluginConn& iPluginConn;
 	TInt iFunction;
 	TDes8* iParam1;
 	TDes8* iParam2;

changeset 36	538db54a451d
parent 0	a41df078684a
child 243	c7a0ce20c48c