Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes

Base64Encoder Class Reference

Base64 Encoder Class. More...

#include <base64.h>

Inheritance diagram for Base64Encoder:
SimpleProxyFilter ProxyFilter FilterWithBufferedInput Filter BufferedTransformation NotCopyable Algorithm Waitable Clonable

List of all members.

Public Member Functions

 Base64Encoder (BufferedTransformation *attachment=NULL, bool insertLineBreaks=true, int maxLineLength=72)
void IsolatedInitialize (const NameValuePairs &parameters)
void FirstPut (const byte *)
void LastPut (const byte *, size_t)
bool IsolatedFlush (bool hardFlush, bool blocking)
void SetFilter (Filter *filter)
void NextPutMultiple (const byte *s, size_t len)
void NextPutModifiable (byte *inString, size_t length)
size_t Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
size_t PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
void ForceNextPut ()
bool Attachable ()
BufferedTransformation * AttachedTransformation ()
const BufferedTransformation * AttachedTransformation () const
void Detach (BufferedTransformation *newAttachment=NULL)
size_t TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
size_t CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const
void Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
bool Flush (bool hardFlush, int propagation=-1, bool blocking=true)
bool MessageSeriesEnd (int propagation=-1, bool blocking=true)
BufferedTransformation & Ref ()
 return a reference to this object, useful for passing a temporary object to a function that takes a non-const reference
virtual std::string AlgorithmName () const
 returns name of this algorithm, not universally implemented yet
virtual Clonable * Clone () const
 this is not implemented by most classes yet
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 wait on this object
SIGNALS

virtual bool IsolatedFlush (bool hardFlush, bool blocking)=0
virtual void IsolatedInitialize (const NameValuePairs &parameters)
virtual void Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
 initialize or reinitialize this object
virtual bool Flush (bool hardFlush, int propagation=-1, bool blocking=true)
 flush buffered input and/or output
virtual bool MessageSeriesEnd (int propagation=-1, bool blocking=true)
 mark end of a series of messages
virtual bool IsolatedMessageSeriesEnd (bool blocking)
virtual void SetAutoSignalPropagation (int propagation)
 set propagation of automatically generated and transferred signals
virtual int GetAutoSignalPropagation () const
INPUT

virtual size_t Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)=0
 input multiple bytes for blocking or non-blocking processing
virtual size_t PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
 input multiple bytes that may be modified by callee for blocking or non-blocking processing
size_t Put (byte inByte, bool blocking=true)
 input a byte for processing
size_t Put (const byte *inString, size_t length, bool blocking=true)
 input multiple bytes
size_t PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 input a 16-bit word
size_t PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 input a 32-bit word
virtual byte * CreatePutSpace (size_t &size)
 request space which can be written into by the caller, and then used as input to Put()
virtual bool CanModifyInput () const
size_t PutModifiable (byte *inString, size_t length, bool blocking=true)
 input multiple bytes that may be modified by callee
bool MessageEnd (int propagation=-1, bool blocking=true)
size_t PutMessageEnd (const byte *inString, size_t length, int propagation=-1, bool blocking=true)
ATTACHMENT

virtual bool Attachable ()
 returns whether this object allows attachment
virtual BufferedTransformation * AttachedTransformation ()
 returns the object immediately attached to this object or NULL for no attachment
virtual const
BufferedTransformation * 		AttachedTransformation () const
virtual void Detach (BufferedTransformation *newAttachment=0)
 delete the current attachment chain and replace it with newAttachment
virtual void Attach (BufferedTransformation *newAttachment)
 add newAttachment to the end of attachment chain
NON-BLOCKING TRANSFER OF OUTPUT

virtual size_t TransferTo2 (BufferedTransformation &target, lword &byteCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)=0
 upon return, byteCount contains number of bytes that have finished being transfered, and returns the number of bytes left in the current transfer block
virtual size_t CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const =0
 upon return, begin contains the start position of data yet to be finished copying, and returns the number of bytes left in the current transfer block
size_t TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 upon return, messageCount contains number of messages that have finished being transfered, and returns the number of bytes left in the current transfer block
size_t TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 returns the number of bytes left in the current transfer block
WAITING

unsigned int GetMaxWaitObjectCount () const
 maximum number of wait objects that this object can return
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 put wait objects into container
RETRIEVAL OF ONE MESSAGE

virtual lword MaxRetrievable () const
 returns number of bytes that is currently ready for retrieval
virtual bool AnyRetrievable () const
 returns whether any bytes are currently ready for retrieval
virtual size_t Get (byte &outByte)
 try to retrieve a single byte
virtual size_t Get (byte *outString, size_t getMax)
 try to retrieve multiple bytes
virtual size_t Peek (byte &outByte) const
 peek at the next byte without removing it from the output buffer
virtual size_t Peek (byte *outString, size_t peekMax) const
 peek at multiple bytes without removing them from the output buffer
size_t GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 try to retrieve a 16-bit word
size_t GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 try to retrieve a 32-bit word
size_t PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 try to peek at a 16-bit word
size_t PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 try to peek at a 32-bit word
lword TransferTo (BufferedTransformation &target, lword transferMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL)
 move transferMax bytes of the buffered output to target as input
virtual lword Skip (lword skipMax=LWORD_MAX)
 discard skipMax bytes from the output buffer
lword CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 copy copyMax bytes of the buffered output to target as input
lword CopyRangeTo (BufferedTransformation &target, lword position, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 copy copyMax bytes of the buffered output, starting at position (relative to current position), to target as input
RETRIEVAL OF MULTIPLE MESSAGES

virtual lword TotalBytesRetrievable () const
virtual unsigned int NumberOfMessages () const
 number of times MessageEnd() has been received minus messages retrieved or skipped
virtual bool AnyMessages () const
 returns true if NumberOfMessages() > 0
virtual bool GetNextMessage ()
 start retrieving the next message
virtual unsigned int SkipMessages (unsigned int count=UINT_MAX)
 skip count number of messages
unsigned int TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL)
unsigned int CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) const
virtual void SkipAll ()
void TransferAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL)
void CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const
virtual bool GetNextMessageSeries ()
virtual unsigned int NumberOfMessagesInThisSeries () const
virtual unsigned int NumberOfMessageSeries () const
CHANNELS

size_t ChannelPut (const std::string &channel, byte inByte, bool blocking=true)
size_t ChannelPut (const std::string &channel, const byte *inString, size_t length, bool blocking=true)
size_t ChannelPutModifiable (const std::string &channel, byte *inString, size_t length, bool blocking=true)
size_t ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
size_t ChannelPutWord32 (const std::string &channel, word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
bool ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true)
size_t ChannelPutMessageEnd (const std::string &channel, const byte *inString, size_t length, int propagation=-1, bool blocking=true)
virtual byte * ChannelCreatePutSpace (const std::string &channel, size_t &size)
virtual size_t ChannelPut2 (const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)
virtual size_t ChannelPutModifiable2 (const std::string &channel, byte *begin, size_t length, int messageEnd, bool blocking)
virtual bool ChannelFlush (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)
virtual bool ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true)
virtual void SetRetrievalChannel (const std::string &channel)

Static Public Attributes

static const std::string & NULL_CHANNEL = DEFAULT_CHANNEL

Protected Member Functions

bool DidFirstPut ()
virtual void InitializeDerivedAndReturnNewSizes (const NameValuePairs &parameters, size_t &firstSize, size_t &blockSize, size_t &lastSize)
virtual void InitializeDerived (const NameValuePairs &parameters)
virtual void NextPutSingle (const byte *inString)
virtual void FlushDerived ()
size_t PutMaybeModifiable (byte *begin, size_t length, int messageEnd, bool blocking, bool modifiable)
void NextPutMaybeModifiable (byte *inString, size_t length, bool modifiable)
virtual int NextPut (const byte *inString, size_t length)
virtual BufferedTransformation * NewDefaultAttachment () const
void Insert (Filter *nextFilter)
virtual bool ShouldPropagateMessageEnd () const
virtual bool ShouldPropagateMessageSeriesEnd () const
void PropagateInitialize (const NameValuePairs &parameters, int propagation)
size_t Output (int outputSite, const byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
size_t OutputModifiable (int outputSite, byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
bool OutputMessageEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
bool OutputFlush (int outputSite, bool hardFlush, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
bool OutputMessageSeriesEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)

Static Protected Member Functions

static int DecrementPropagation (int propagation)

Protected Attributes

member_ptr
< BufferedTransformation > 		m_filter
size_t m_firstSize
size_t m_blockSize
size_t m_lastSize
bool m_firstInputDone
BlockQueue m_queue
size_t m_inputPosition
int m_continueAt

Detailed Description

Base64 Encoder Class.

Definition at line 9 of file base64.h.

Member Function Documentation

bool ProxyFilter::IsolatedFlush ( bool  hardFlush,
bool  blocking 
) [inherited]

calls ForceNextPut() if hardFlush is true

Reimplemented from FilterWithBufferedInput.

Definition at line 468 of file filters.cpp.

virtual size_t BufferedTransformation::Put2 ( const byte *  inString,
size_t  length,
int  messageEnd,
bool  blocking 
) [pure virtual, inherited]

input multiple bytes for blocking or non-blocking processing

Parameters:
messageEnd means how many filters to signal MessageEnd to, including this one

Implemented in Redirector, OutputProxy, StringSinkTemplate< T >, RandomNumberSink, ArraySink, ArrayXorSink, MessageQueue, ByteQueue, MaurerRandomnessTest, BitBucket, and FilterTester.

virtual size_t BufferedTransformation::PutModifiable2 ( byte *  inString,
size_t  length,
int  messageEnd,
bool  blocking 
) [inline, virtual, inherited]

input multiple bytes that may be modified by callee for blocking or non-blocking processing

Parameters:
messageEnd means how many filters to signal MessageEnd to, including this one

Reimplemented in OutputProxy.

Definition at line 817 of file cryptlib.h.

void FilterWithBufferedInput::ForceNextPut (  )  [inherited]

The input buffer may contain more than blockSize bytes if lastSize != 0. ForceNextPut() forces a call to NextPut() if this is the case.

Definition at line 418 of file filters.cpp.

Referenced by FilterWithBufferedInput::IsolatedFlush().

virtual bool BufferedTransformation::Attachable (  )  [inline, virtual, inherited]

returns whether this object allows attachment

Some BufferedTransformation objects (e.g. Filter objects) allow other BufferedTransformation objects to be attached. When this is done, the first object instead of buffering its output, sents that output to the attached object as input. The entire attachment chain is deleted when the anchor object is destructed.

Definition at line 1009 of file cryptlib.h.

Referenced by BufferedTransformation::Attach().

bool BufferedTransformation::Flush ( bool  hardFlush,
int  propagation = -1,
bool  blocking = true 
) [virtual, inherited]

flush buffered input and/or output

Parameters:
hardFlush is used to indicate whether all data should be flushed
Note:
Hard flushes must be used with care. It means try to process and output everything, even if there may not be enough data to complete the action. For example, hard flushing a HexDecoder would cause an error if you do it after inputing an odd number of hex encoded characters. For some types of filters, for example ZlibDecompressor, hard flushes can only be done at "synchronization points". These synchronization points are positions in the data stream that are created by hard flushes on the corresponding reverse filters, in this example ZlibCompressor. This is useful when zlib compressed data is moved across a network in packets and compression state is preserved across packets, as in the ssh2 protocol.

Reimplemented in Redirector, and OutputProxy.

Definition at line 334 of file cryptlib.cpp.

References BufferedTransformation::AttachedTransformation().

bool BufferedTransformation::MessageSeriesEnd ( int  propagation = -1,
bool  blocking = true 
) [virtual, inherited]

mark end of a series of messages

There should be a MessageEnd immediately before MessageSeriesEnd.

Reimplemented in Redirector, and OutputProxy.

Definition at line 340 of file cryptlib.cpp.

References BufferedTransformation::AttachedTransformation().

virtual byte* BufferedTransformation::CreatePutSpace ( size_t &  size  )  [inline, virtual, inherited]

request space which can be written into by the caller, and then used as input to Put()

Parameters:
size is requested size (as a hint) for input, and size of the returned space for output
Note:
The purpose of this method is to help avoid doing extra memory allocations.

Reimplemented in Redirector, OutputProxy, ArraySink, ArrayXorSink, and ByteQueue.

Definition at line 799 of file cryptlib.h.

Referenced by ArrayXorSink::CreatePutSpace().

void BufferedTransformation::GetWaitObjects ( WaitObjectContainer &  container,
CallStack const &  callStack 
) [virtual, inherited]

put wait objects into container

Parameters:
callStack is used for tracing no wait loops, example: something.GetWaitObjects(c, CallStack("my func after X", 0));

  • or in an outer GetWaitObjects() method that itself takes a callStack parameter: innerThing.GetWaitObjects(c, CallStack("MyClass::GetWaitObjects at X", &callStack));

Implements Waitable.

Reimplemented in Redirector.

Definition at line 321 of file cryptlib.cpp.

References BufferedTransformation::AttachedTransformation(), and BufferedTransformation::GetWaitObjects().

Referenced by BufferedTransformation::GetWaitObjects().

virtual void BufferedTransformation::SetAutoSignalPropagation ( int  propagation  )  [inline, virtual, inherited]

set propagation of automatically generated and transferred signals

propagation == 0 means do not automaticly generate signals

Definition at line 857 of file cryptlib.h.

lword BufferedTransformation::MaxRetrievable (  )  const [virtual, inherited]

returns number of bytes that is currently ready for retrieval

All retrieval functions return the actual number of bytes retrieved, which is the lesser of the request number and MaxRetrievable().

Reimplemented in RandomNumberStore, NullStore, MessageQueue, ByteQueue, and ByteQueue::Walker.

Definition at line 386 of file cryptlib.cpp.

References BufferedTransformation::AttachedTransformation(), BufferedTransformation::CopyTo(), and BufferedTransformation::MaxRetrievable().

Referenced by RandomNumberStore::AnyRetrievable(), Integer::BERDecode(), and BufferedTransformation::MaxRetrievable().

bool BufferedTransformation::GetNextMessage (  )  [virtual, inherited]

start retrieving the next message

Returns false if no more messages exist or this message is not completely retrieved.

Reimplemented in MessageQueue, and Store.

Definition at line 475 of file cryptlib.cpp.

References BufferedTransformation::AnyMessages(), BufferedTransformation::AttachedTransformation(), and BufferedTransformation::GetNextMessage().

Referenced by BufferedTransformation::GetNextMessage(), and BufferedTransformation::TransferMessagesTo2().

bool Waitable::Wait ( unsigned long  milliseconds,
CallStack const &  callStack 
) [inherited]

wait on this object

same as creating an empty container, calling GetWaitObjects(), and calling Wait() on the container

Definition at line 388 of file wait.cpp.

References Waitable::GetWaitObjects().

The documentation for this class was generated from the following files:
Generated on Mon Aug 9 2010 15:56:48 for Crypto++ by  doxygen 1.7.1