MimeBodyPart.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2007 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#ifndef _MimeBodyPart_h_
#define _MimeBodyPart_h_

// SYSTEM INCLUDES
//#include <...>
#include "utl/UtlDList.h"

// APPLICATION INCLUDES
#include <net/HttpBody.h>


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

//:One part of a multipart Mime body
// This is a child part of a multipart MIME body
class MimeBodyPart : public HttpBody
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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

   MimeBodyPart(const HttpBody* parent = NULL,
                int parentBodyStartIndex = 0,
                int rawBodyLength = 0);
     //:Default constructor

   MimeBodyPart(const HttpBody& httpBody,
                //< Provides the bytes of the body.
                const UtlDList& parameters
                //< Provides the parameters.
      );
   MimeBodyPart(const MimeBodyPart& rMimeBodyPart);
     //:Copy constructor

   virtual
   ~MimeBodyPart();
     //:Destructor

/* ============================ MANIPULATORS ============================== */

   MimeBodyPart& operator=(const MimeBodyPart& rhs);
     //:Assignment operator

   void attach(HttpBody* parent,
               int rawPartStart, int rawPartLength,
               int partStart, int partLength);

/* ============================ ACCESSORS ================================= */

   // Get the various indexes from the object.
   int getRawStart() const;
   int getRawLength() const;
   int getStart() const;
   int getLength() const;

   virtual void getBytes(const char** bytes, int* length) const;

   UtlBoolean getPartHeaderValue(const char* headerName,
                                 UtlString& headerValue) const;

   UtlDList* getParameters();

/* ============================ INQUIRY =================================== */

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
    UtlDList mNameValues;
    const HttpBody* mpParentBody;
    int mParentBodyRawStartIndex;
    int mRawBodyLength;
    int mParentBodyStartIndex;
    int mBodyLength;

};

/* ============================ INLINE METHODS ============================ */

inline int MimeBodyPart::getRawStart() const
{
   return mParentBodyRawStartIndex;
}

inline int MimeBodyPart::getRawLength() const
{
   return mRawBodyLength;
}

inline int MimeBodyPart::getStart() const
{
   return mParentBodyStartIndex;
}

inline int MimeBodyPart::getLength() const
{
   return mBodyLength;
}

inline UtlDList* MimeBodyPart::getParameters()
{
   return &mNameValues;
}

#endif  // _MimeBodyPart_h_