File plug-in

Classes
struct	FmsFileAttribute
	Structure for holding file attribute values. More...
class	IFmsFileAdaptor
	The interface to an asynchronous File plug-in. More...
class	IFmsFileResponse
	The response interface provided to the File plug-in. More...
Functions
void FCExport	FmsCreateFileAdaptor (IFmsServerContext *pServerCtx, IFmsFileResponse *pResponse, IFmsFileAdaptor *&pFileAdaptor)
void FCExport	FmsDestroyFileAdaptor (IFmsFileAdaptor *pFileAdaptor)

---

Detailed Description

Use the File plug-in interface to create a custom file plug-in to handle file I/O in place of the server's default operating system-based file system I/O. The File plug-in interface supports a fully asynchronous model for file operations, making it easier to implement network-based file I/O. Currently, this mechanism only supports stream data sources.

By default, the server uses a built-in plug-in that talks to the standard operating system file system interface and preserves backward compatibility to previous server versions.

---

Function Documentation

void FCExport FmsCreateFileAdaptor	(	IFmsServerContext *	pServerCtx,
		IFmsFileResponse *	pResponse,
		IFmsFileAdaptor *&	pFileAdaptor
	)

Called by the server to create an instance of the File plug-in.

Parameters:

	pServerCtx	A pointer to the server context object (see FmsAdaptor.h) that the plug-in can hold on to and call to query configuration information, perform logging, and so on. This pointer is valid through the lifetime of the plug-in and can be stored and used at any time.
	pResponse	A pointer to a response object that can be used by the plug-in to report the completion status of various asynchronous operations. This is done by calling the appropriate IFmsFileResponse function, such as onOpen(), on the response object. The response object is valid only during the lifetime of the plug-in instance and must not be used after the plug-in has been destroyed.
	pFileAdaptor	A pointer to a valid IFmsFileAdaptor instance or null in case of an error.

void FCExport FmsDestroyFileAdaptor

(

IFmsFileAdaptor *

pFileAdaptor

)

Called when a previously created instance of the file plug-in is destroyed. Before returning from this call, the plug-in implementation must guarantee that all pending operations have been completed or aborted. After returning from the function, the plug-in should never implement a callback function on the response object.

The server does not request any more operations after it calls this function.

Parameters:

pFileAdaptor

A pointer to a previously created File plug-in instance.

©2007 Adobe Systems Incorporated.  All Rights Reserved.