BodyWriterHandler Class Reference

Base class for partition candler callbacks. More...

#include <essence.h>

Inheritance diagram for BodyWriterHandler:

List of all members.

Public Member Functions
virtual	~BodyWriterHandler ()
	Virtual destructor to allow polymorphism.
virtual bool	HandlePartition (BodyWriterPtr Caller, UInt32 BodySID, UInt32 IndexSID)=0
	Handler called before writing a partition pack.

---

Detailed Description

Base class for partition candler callbacks.

---

Constructor & Destructor Documentation

virtual ~BodyWriterHandler

(

)

[virtual]

Virtual destructor to allow polymorphism.

---

Member Function Documentation

virtual bool HandlePartition	(	BodyWriterPtr	Caller,
		UInt32	BodySID,
		UInt32	IndexSID
	)			[pure virtual]

Handler called before writing a partition pack.

Parameters:

	Caller	- A pointer to the calling BodyWriter
	BodySID	- The Stream ID of the essence in this partition (0 if none)
	IndexSID	- The Stream ID of the index data in this partition (0 if none)

Note:

If metadata is to be written the partition type must be set accordingly by the handler - otherwise closed and complete will be used

If metadata is requested but the partition will contain index or essence data that is not permitted to share a partition with metadata an extra partition pack will be written with no metadata after writing the metadata

Returns:

true if metadata should be written with this partition pack

---

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

• essence.h

---