Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

PBase64 Class Reference

#include <cypher.h>

Inheritance diagram for PBase64:

PObject List of all members.

Public Member Functions

 PBase64 ()
void StartEncoding (BOOL useCRLFs=TRUE)
void ProcessEncoding (const PString &str)
void ProcessEncoding (const char *cstr)
void ProcessEncoding (const PBYTEArray &data)
void ProcessEncoding (const void *dataBlock, PINDEX length)
PString GetEncodedString ()
PString CompleteEncoding ()
void StartDecoding ()
BOOL ProcessDecoding (const PString &str)
BOOL ProcessDecoding (const char *cstr)
BOOL GetDecodedData (void *dataBlock, PINDEX length)
PBYTEArray GetDecodedData ()
BOOL IsDecodeOK ()

Static Public Member Functions

PString Encode (const PString &str)
PString Encode (const char *cstr)
PString Encode (const PBYTEArray &data)
PString Encode (const void *dataBlock, PINDEX length)
PString Decode (const PString &str)
BOOL Decode (const PString &str, PBYTEArray &data)
BOOL Decode (const PString &str, void *dataBlock, PINDEX length)

Detailed Description

This class is used to encode/decode data using the MIME standard base64 encoding mechanism as defined in RFC1521.

To encode a large block of data use the following seqeunce: {verbatim} PBase64 base; base.StartEncoding(); while (Read(dataChunk)) { base.ProcessEncoding(dataChunk); out << base.GetEncodedString(); } out << base.CompleteEncoding(); {verbatim}

if smaller blocks that fit easily in memory are to be encoded the #Encode()# functions can be used to everything in one go.

To decode a large block of data use the following sequence: {verbatim}

PBase64 base; base.StartDecoding(); while (Read(str) && ProcessDecoding(str)) Write(base.GetDecodedData()); Write(base.GetDecodedData()); {verbatim}

if smaller blocks that fit easily in memory are to be decoded the #Decode()# functions can be used to everything in one go.


Constructor & Destructor Documentation

PBase64::PBase64  ) 
 

Construct a base 64 encoder/decoder and initialise both encode and decode members as in #StartEncoding()# and StartDecoding()#.


Member Function Documentation

PString PBase64::CompleteEncoding  ) 
 

Complete the base 64 encoding and return the remainder of the encoded Base64 string. Previous data may have been already removed by the #GetInterim()# function.

Returns:
Base64 encoded string for the processed data.

BOOL PBase64::Decode const PString str,
void *  dataBlock,
PINDEX  length
[static]
 

BOOL PBase64::Decode const PString str,
PBYTEArray data
[static]
 

PString PBase64::Decode const PString str  )  [static]
 

Convert a printable text string to binary data using the Internet MIME standard base 64 content transfer encoding.

The base64 string is checked and TRUE returned if all perfectly correct. If FALSE is returned then the string had extraneous or illegal characters in it that were ignored. This does not mean that the data is not valid, only that it is suspect.

Returns:
Base 64 string decoded from input string.

PString PBase64::Encode const void *  dataBlock,
PINDEX  length
[static]
 

PString PBase64::Encode const PBYTEArray data  )  [static]
 

PString PBase64::Encode const char *  cstr  )  [static]
 

PString PBase64::Encode const PString str  )  [static]
 

PBYTEArray PBase64::GetDecodedData  ) 
 

BOOL PBase64::GetDecodedData void *  dataBlock,
PINDEX  length
 

Get the data decoded so far from the Base64 strings processed.

Returns:
Decoded data for the processed Base64 string.

PString PBase64::GetEncodedString  ) 
 

Get the partial Base64 string for the data encoded so far.

Returns:
Base64 encoded string for the processed data.

BOOL PBase64::IsDecodeOK  )  [inline]
 

Return a flag to indicate that the input was decoded without any extraneous or illegal characters in it that were ignored. This does not mean that the data is not valid, only that it is suspect.

Returns:
Decoded data for the processed Base64 string.

BOOL PBase64::ProcessDecoding const char *  cstr  ) 
 

BOOL PBase64::ProcessDecoding const PString str  ) 
 

Incorporate the specified data into the base 64 decoding.

Returns:
TRUE if block was last in the Base64 encoded string.

void PBase64::ProcessEncoding const void *  dataBlock,
PINDEX  length
 

void PBase64::ProcessEncoding const PBYTEArray data  ) 
 

void PBase64::ProcessEncoding const char *  cstr  ) 
 

void PBase64::ProcessEncoding const PString str  ) 
 

void PBase64::StartDecoding  ) 
 

void PBase64::StartEncoding BOOL  useCRLFs = TRUE  ) 
 


The documentation for this class was generated from the following file:
Generated on Sat Jul 24 15:35:57 2004 for PWLib by doxygen 1.3.7