NetBase64Codec.h

Go to the documentation of this file.

//
// Copyright (C) 2005-2007 SIPfoundry Inc.
// License by SIPfoundry under the LGPL license.
// 
// Copyright (C) 2004 Pingtel Corp.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// Copyright (C) 2007 SIPez, LLC.
// Licensed to SIPfoundry under a Contributor Agreement.
//

#ifndef _NetBase64Codec_h_
#define _NetBase64Codec_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "utl/UtlString.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS



class NetBase64Codec
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
  public:

/* ============================ CREATORS ================================== */

   // ================================================================

   static void encode(int dataSize,         
                      const char data[],    
                      int& encodedDataSize, 
                      char encodedData[]    
                      );

   static void encode(int dataSize,          
                      const char data[],     
                      UtlString& encodedData 
                      );

   static void encode(const UtlString& data, 
                      UtlString& encodedData 
                      )
   {
      NetBase64Codec::encode(data.length(),data.data(),encodedData);
   };
   
   static int encodedSize(int dataSize);

   
   // ================================================================

   static bool isValid(int encodedDataSize,      
                       const char encodedData[]  
                       )
   {
      return validEncodingBytes(encodedDataSize, encodedData) > 0;
   }
   

   static bool isValid(const UtlString& encodedData 
                       )
   {
      return validEncodingBytes(encodedData.length(), encodedData.data()) > 0;
   }
   
   static bool decode(int encodedDataSize,      
                      const char encodedData[], 
                      int& dataSize,            
                      char data[]               
                      );

   static bool decode(const UtlString& encodedData, 
                      UtlString& data               
                      );
   
   static int decodedSize(int encodedDataSize,
                          const char encodedData[]
                          );

   static int decodedSize(const UtlString& encodedData  
                          )
   {
      return decodedSize(encodedData.length(), encodedData.data());
   }
   

  private:
   
   static const char* Base64Codes;

   inline static char decodeChar(const char encoded);

   static size_t validEncodingBytes(int encodedDataSize, 
                                    const char encodedData[]  
                                    );


   // @cond INCLUDENOCOPY
   NetBase64Codec();
   //:Default constructor (disabled)


   virtual
      ~NetBase64Codec();
   
   NetBase64Codec(const NetBase64Codec& rNetBase64Codec);
   //:Copy constructor (disabled)

   NetBase64Codec& operator=(const NetBase64Codec& rhs);
   //:Assignment operator (disabled)

   // @endcond     
};

#endif  // _NetBase64Codec_h_