OSXMLEncodeBuffer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2022 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/
#ifndef _OSXMLENCODEBUFFER_H_
#define _OSXMLENCODEBUFFER_H_

#include "rtxmlsrc/OSXMLMessageBuffer.h"

class EXTXMLCLASS OSXMLEncodeBuffer : public OSXMLEncodeBase {
 protected:
   OSXMLEncodeBuffer (OSRTContext* pContext) :
      OSXMLEncodeBase (pContext) {}
 public:
   EXTXMLMETHOD OSXMLEncodeBuffer ();

   EXTXMLMETHOD OSXMLEncodeBuffer (OSOCTET* pMsgBuf, size_t msgBufLen);

   int addXMLHeader (const OSUTF8CHAR* version = OSUTF8("1.0"),
                     const OSUTF8CHAR* encoding = OSUTF8(OSXMLHDRUTF8),
                     OSBOOL newLine = TRUE);

   EXTXMLMETHOD int addXMLText (const OSUTF8CHAR* text);

   virtual size_t getMsgLen () {
      return getByteIndex();
   }

   EXTXMLMETHOD virtual int init ();

   virtual OSBOOL isA (Type bufferType) {
      return bufferType == XMLEncode;
   }

   inline void nullTerminate () {
      OSRTZTERM (getCtxtPtr());
   }

   EXTXMLMETHOD void setFragment (OSBOOL value = TRUE);

   EXTXMLMETHOD virtual long write (const char* filename);

   EXTXMLMETHOD virtual long write (FILE* fp);
} ;

#endif