IFmsServerContext Class Reference

An interface to access the server from the plug-in. More...

#include <FmsAdaptor.h>

Inheritance diagram for IFmsServerContext:

List of all members.

Public Types

enum MessageType { kError, kWarning, kInformation }

Public Member Functions

virtual U32 getVersion ()=0

virtual int getConfig (const char *pstrKey, char **pstrVal, int iBufSize)=0

virtual void log (const char *pstrMsg, U16 suType, bool boolToEventLog=false)=0

virtual ~IFmsServerContext ()

Detailed Description

The server context is provided to an plug-in when the plug-in is created. The plug-in can use this to query information from the server.

Type of message to log.

Enumerator:

virtual IFmsServerContext::~IFmsServerContext ( ) [virtual]

Called by the server to destroy an object.

virtual U32 IFmsServerContext::getVersion ( ) [pure virtual]

Returns the server version: -HIWORD = major version. -LOWORD = minor version.

virtual int IFmsServerContext::getConfig	(	const char *	pstrKey,
		char **	pstrVal,
		int	iBufSize
	)			`[pure virtual]`

Returns the configuration value associated with a filter.

Parameters:

	pstrKey	Configuration key name. This must be a UTF-8 string. All configuration keys specified here must be located in Server.xml under the respective plug-in's tag, such as the Server/AsyncFileIo XML tag for the File plug-in. (Currently, FileAdaptor is the only complete implementation of `getConfig()`.) For example, `cpstrKey` would be "Foo" to find a key in Server.xml: `<Server> <AsyncFileIo> <Foo>value</Foo> </AsyncFileIo> </Server>`
	pstrVal	The buffer to return the value of the configuration key.
	iBufSize	Size of the buffer, `pstrVal`, in bytes.

virtual void IFmsServerContext::log	(	const char *	pstrMsg,
		U16	suType,
		bool	boolToEventLog = `false`
	)			`[pure virtual]`

Called from a library to dump a message into the system log.

Parameters:

	pstrMsg	Log message; this must be a UTF-8 string.
	suType	IFmsServerContext::MessageType.
	boolToEventLog	Whether to log to the system event log.

The documentation for this class was generated from the following file:

FMS Adaptors Footer


Public Types
enum	MessageType { kError, kWarning, kInformation }
Public Member Functions
virtual U32	getVersion ()=0
virtual int	getConfig (const char pstrKey, char *pstrVal, int iBufSize)=0
virtual void	log (const char *pstrMsg, U16 suType, bool boolToEventLog=false)=0
virtual	~IFmsServerContext ()