XSECBinTXFMInputStream Class Reference
[Classes that interface applications to XML Security C.]

#include <XSECBinTXFMInputStream.hpp>

Collaboration diagram for XSECBinTXFMInputStream:

[legend]List of all members.

---

Detailed Description

BinInputSource wrapper for a TXFMChain.

This class provides a wrapper for a TXFMChain. It can be used to either provide a nice interface to applications wishing to read the BYTESTREAM output of a TXFM chain, or, as it is derived from BinInputStream, provide an input to the Xerces Parser.

Interface
virtual unsigned int	curPos () const
	Current position in stream.
virtual unsigned int	readBytes (XMLByte *const toFill, const unsigned int maxToRead)
	Retrieve the required number of bytes and return.
Public Member Functions
Constructors and Destructors
	XSECBinTXFMInputStream (TXFMChain *lst, bool deleteWhenDone=true)
	Construct around an existing transform list.
virtual	~XSECBinTXFMInputStream ()
	Destructor.
Stream management methods
void	reset ()
	Reset the stream.

---

Constructor & Destructor Documentation

XSECBinTXFMInputStream::XSECBinTXFMInputStream (  TXFMChain *  lst, bool  deleteWhenDone = true )

Construct around an existing transform list. Parameters: lst  The input TXFM chain. deleteWhenDone  Flag to instruct the class to delete the chain when done. By default set to true.

virtual XSECBinTXFMInputStream::~XSECBinTXFMInputStream (   )  [virtual]

Destructor. Delete the object. If deleteWhenDone was set during construction, will delete the chain if it has not already been done.

---

Member Function Documentation

virtual unsigned int XSECBinTXFMInputStream::curPos (   )  const [virtual]

Current position in stream. Returns: Bytes already returned.

virtual unsigned int XSECBinTXFMInputStream::readBytes (  XMLByte *const   toFill, const unsigned int  maxToRead )  [virtual]

Retrieve the required number of bytes and return. Retrieve up to the requested number of bytes. Does not always retrieve as much as requested, but will always retrieve something until completed. Note: When complete, will return 0 and delete the TXFM chain if requested to do so in the constructor. Parameters: toFill  The buffer that will be read into. maxToRead  Maximum number of bytes to return Returns: The number of bytes read or 0 if complete.

void XSECBinTXFMInputStream::reset (   )

Reset the stream. Note: At this time simply deletes the TXFM chain - many TXFMs do not have an ability to reset.

---

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

• XSECBinTXFMInputStream.hpp

---