OdAsyncIORequestHandler Class Reference

#include <OdAsyncIORequestHandler.h>

Inheritance diagram for OdAsyncIORequestHandler:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdAsyncIORequestHandler)
virtual	~OdAsyncIORequestHandler ()
virtual OdUInt64	newRequestDescriptor ()=0
virtual void	openFile (const OdAsyncOpenFileRequest &request)=0
virtual void	closeFile (OdUInt64 fileDescriptor)=0
virtual void	read (const OdAsyncIORequest &request)=0
virtual void	write (const OdAsyncIORequest &request)=0
virtual OdAsyncIO::OdAsyncIOResult	returnResult (OdUInt64 requestDescriptor, OdUInt64 *pOpenedFileDescriptor=NULL, OdUInt8 **pDataPtr=NULL, OdUInt32 *pActualDataSize=NULL)=0
virtual void	cancel (OdUInt64 requestDescriptor)=0
virtual void	responseParsed (OdUInt64 requestDescriptor)=0
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
static void	rxInit ()
static void	rxUninit ()

Detailed Description

<group OdAsyncIO_Classes>

This is an interface class to implement asynchronous I/O operations.

Definition at line 41 of file OdAsyncIORequestHandler.h.

Constructor & Destructor Documentation

~OdAsyncIORequestHandler()

virtual OdAsyncIORequestHandler::~OdAsyncIORequestHandler ( )

inlinevirtual

Destructor for the OdAsyncIORequestHandler class.

Definition at line 49 of file OdAsyncIORequestHandler.h.

Member Function Documentation

cancel()

virtual void OdAsyncIORequestHandler::cancel ( OdUInt64 requestDescriptor )

pure virtual

Method to cancel request.

Parameters

requestDescriptor

[in] Request descriptor.

closeFile()

virtual void OdAsyncIORequestHandler::closeFile ( OdUInt64 fileDescriptor )

pure virtual

Closes the file corresponding to the file descriptor value.

Parameters

fileDescriptor

[in] File descriptor.

newRequestDescriptor()

virtual OdUInt64 OdAsyncIORequestHandler::newRequestDescriptor ( )

pure virtual

Registers new request and returns a descriptor to be set in the field m_requestDescriptor of request data structure.

ODRX_DECLARE_MEMBERS()

OdAsyncIORequestHandler::ODRX_DECLARE_MEMBERS

(

OdAsyncIORequestHandler

)

openFile()

virtual void OdAsyncIORequestHandler::openFile ( const OdAsyncOpenFileRequest & request )

pure virtual

Executes a request to open a file.

Parameters

request

[in] Request data structure.

read()

virtual void OdAsyncIORequestHandler::read ( const OdAsyncIORequest & request )

pure virtual

Executes a request to read data.

Parameters

request

[in] Request data structure.

responseParsed()

virtual void OdAsyncIORequestHandler::responseParsed ( OdUInt64 requestDescriptor )

pure virtual

Method to confirm that the response to the request has been received.

Parameters

requestDescriptor

[in] Request descriptor.

returnResult()

virtual OdAsyncIO::OdAsyncIOResult OdAsyncIORequestHandler::returnResult ( OdUInt64 requestDescriptor, OdUInt64 * pOpenedFileDescriptor = NULL, OdUInt8 ** pDataPtr = NULL, OdUInt32 * pActualDataSize = NULL )

pure virtual

Synchronous method for getting the request result. Intended to be used if the flag m_bAsyncNotification in request data structure was set to false.

Parameters

requestDescriptor	[in] Request descriptor.
pOpenedFileDescriptor	[out] Descriptor of successfully opened file if a request to open a file is made. When calling the method, pass 0 if the result of a read/write request is being checked.
pDataPtr	[out] Pointer to the data if the read request was successful.
pActualDataSize	[out] The actual size of the data that was read.

Returns

The status of the request as OdAsyncIO::OdAsyncIOResult value.

write()

virtual void OdAsyncIORequestHandler::write ( const OdAsyncIORequest & request )

pure virtual

Executes a request to write data.

Parameters

request

[in] Request data structure.

---

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

• OdAsyncIORequestHandler.h