Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Member Functions | Public Attributes | List of all members
FilterPutSpaceHelper Class Reference

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

+ Inheritance diagram for FilterPutSpaceHelper:

Public Member Functions

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.
 

Detailed Description

Create a working space in a BufferedTransformation.

Definition at line 163 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
targetBufferedTransformation for the working space
channelchannel for the working space
minSizeminimum size of the allocation, in bytes
desiredSizepreferred size of the allocation, in bytes
bufferSizeactual 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 178 of file filters.h.

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

Create a working space in a BufferedTransformation.

Parameters
targetthe BufferedTransformation for the working space
channelchannel for the working space
minSizeminimum 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 201 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
targetthe BufferedTransformation for the working space
channelchannel for the working space
minSizeminimum size of the allocation, in bytes
bufferSizethe 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 210 of file filters.h.


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