FilterPutSpaceHelper Class Reference

Create a working space in a BufferedTransformation. More...

#include <filters.h>

Inheritance diagram for FilterPutSpaceHelper:

Collaboration diagram for FilterPutSpaceHelper:

Public Member Functions
virtual	~FilterPutSpaceHelper ()
byte *	HelpCreatePutSpace (BufferedTransformation &target, const std::string &channel, size_t minSize, size_t desiredSize, size_t &bufferSize)
	Create a working space in a BufferedTransformation. More...
byte *	HelpCreatePutSpace (BufferedTransformation &target, const std::string &channel, size_t minSize)
	Create a working space in a BufferedTransformation. More...
byte *	HelpCreatePutSpace (BufferedTransformation &target, const std::string &channel, size_t minSize, size_t bufferSize)
	Create a working space in a BufferedTransformation. More...

Public Attributes
SecByteBlock	m_tempSpace
	Temporay working space. More...

Detailed Description

Create a working space in a BufferedTransformation.

Definition at line 160 of file filters.h.

Constructor & Destructor Documentation

virtual FilterPutSpaceHelper::~FilterPutSpaceHelper ( )

inlinevirtual

Definition at line 162 of file filters.h.

Member Function Documentation

byte* FilterPutSpaceHelper::HelpCreatePutSpace ( BufferedTransformation &  target, const std::string &  channel, size_t  minSize, size_t  desiredSize, size_t &  bufferSize  )

inline

Create a working space in a BufferedTransformation.

Parameters

target	BufferedTransformation for the working space
channel	channel for the working space
minSize	minimum size of the allocation, in bytes
desiredSize	preferred size of the allocation, in bytes
bufferSize	actual size of the allocation, in bytes

Precondition

desiredSize >= minSize and bufferSize >= minSize.

bufferSize is an IN and OUT parameter. If HelpCreatePutSpace() returns a non-NULL value, then bufferSize is valid and provides the size of the working space created for the caller.

Internally, HelpCreatePutSpace() calls ChannelCreatePutSpace() using desiredSize. If the target returns desiredSize with a size less than minSize (i.e., the request could not be fulfilled), then an internal SecByteBlock called m_tempSpace is resized and used for the caller.

Definition at line 177 of file filters.h.

Here is the call graph for this function:

Here is the caller graph for this function:

byte* FilterPutSpaceHelper::HelpCreatePutSpace ( BufferedTransformation &  target, const std::string &  channel, size_t  minSize  )

inline

Create a working space in a BufferedTransformation.

Parameters

target	the BufferedTransformation for the working space
channel	channel for the working space
minSize	minimum size of the allocation, in bytes

Internally, the overload calls HelpCreatePutSpace(BufferedTransformation &target, const std::string &channel, size_t minSize, size_t desiredSize, size_t &bufferSize) using minSize for missing arguments.

Definition at line 200 of file filters.h.

byte* FilterPutSpaceHelper::HelpCreatePutSpace ( BufferedTransformation &  target, const std::string &  channel, size_t  minSize, size_t  bufferSize  )

inline

Create a working space in a BufferedTransformation.

Parameters

target	the BufferedTransformation for the working space
channel	channel for the working space
minSize	minimum size of the allocation, in bytes
bufferSize	the actual size of the allocation, in bytes

Internally, the overload calls HelpCreatePutSpace(BufferedTransformation &target, const std::string &channel, size_t minSize, size_t desiredSize, size_t &bufferSize) using minSize for missing arguments.

Definition at line 209 of file filters.h.

Member Data Documentation

SecByteBlock FilterPutSpaceHelper::m_tempSpace

Temporay working space.

Definition at line 213 of file filters.h.

---

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

• src/cryptopp/filters.h