topical media & game development

talk show tell print

lib-of-vs-libs-Poco-include-Poco-Net-MultipartWriter.h / h



  //
  // MultipartWriter.h
  //
  // Id: //poco/1.3/Net/include/Poco/Net/MultipartWriter.h#2 
  //
  // Library: Net
  // Package: Messages
  // Module:  MultipartWriter
  //
  // Definition of the MultipartWriter class.
  //
  // Copyright (c) 2005-2006, Applied Informatics Software Engineering GmbH.
  // and Contributors.
  //
  // Permission is hereby granted, free of charge, to any person or organization
  // obtaining a copy of the software and accompanying documentation covered by
  // this license (the "Software") to use, reproduce, display, distribute,
  // execute, and transmit the Software, and to prepare derivative works of the
  // Software, and to permit third-parties to whom the Software is furnished to
  // do so, all subject to the following:
  // 
  // The copyright notices in the Software and this entire statement, including
  // the above license grant, this restriction and the following disclaimer,
  // must be included in all copies of the Software, in whole or in part, and
  // all derivative works of the Software, unless such copies or derivative
  // works are solely in the form of machine-executable object code generated by
  // a source language processor.
  // 
  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
  // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
  // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
  // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  // DEALINGS IN THE SOFTWARE.
  //
  
  ifndef Net_MultipartWriter_INCLUDED
  define Net_MultipartWriter_INCLUDED
  
  include "Poco/Net/Net.h"
  include <ostream>
  
  namespace Poco {
  namespace Net {
  
  class MessageHeader;
  
  class Net_API MultipartWriter
  
This class is used to write MIME multipart messages to an output stream. The format of multipart messages is described in section 5.1 of RFC 2046. To create a multipart message, first create a MultipartWriter object. Then, for each part, call nextPart() and write the content to the output stream. Repeat for all parts. After the last part has been written, call close() to finish the multipart message. { public: explicit MultipartWriter(std::ostream& ostr); Creates the MultipartWriter, using the given output stream. Creates a random boundary string.

          MultipartWriter(std::ostream& ostr, const std::string& boundary);
  
Creates the MultipartWriter, using the given output stream and boundary string.

          ~MultipartWriter();
  
Destroys the MultipartWriter. void nextPart(const MessageHeader& header); Opens a new message part and writes the message boundary string, followed by the message header to the stream. void close(); Closes the multipart message and writes the terminating boundary string. Does not close the underlying stream.

          std::ostream& stream();
  
Returns the writer's stream.

          const std::string& boundary() const;
  
Returns the multipart boundary used by this writer.

          static std::string createBoundary();
  
Creates a random boundary string. The string always has the form MIME_boundary_XXXXXXXXXXXX, where XXXXXXXXXXXX is a random hexadecimal number. private: MultipartWriter(); MultipartWriter(const MultipartWriter&); MultipartWriter& operator = (const MultipartWriter&);

          std::ostream& _ostr;
          std::string   _boundary;
          bool          _firstPart;
  };
  
  //
  // inlines
  //
  inline std::ostream& MultipartWriter::stream()
  {
          return _ostr;
  }
  
  } } // namespace Poco::Net
  
  endif // Net_MultipartWriter_INCLUDED
  


(C) Æliens 04/09/2009

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.