SWIoutputStream.hpp
上传用户:xqtpzdz
上传日期:2022-05-21
资源大小:1764k
文件大小:4k
源码类别:

xml/soap/webservice

开发平台:

Visual C++

  1. #ifndef SWIOUTPUTSTREAM_HPP
  2. #define SWIOUTPUTSTREAM_HPP
  3. /****************License************************************************
  4.  * Vocalocity OpenVXI
  5.  * Copyright (C) 2004-2005 by Vocalocity, Inc. All Rights Reserved.
  6.  * This program is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU General Public License
  8.  * as published by the Free Software Foundation; either version 2
  9.  * of the License, or (at your option) any later version.
  10.  *  
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program; if not, write to the Free Software
  18.  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19.  * Vocalocity, the Vocalocity logo, and VocalOS are trademarks or 
  20.  * registered trademarks of Vocalocity, Inc. 
  21.  * OpenVXI is a trademark of Scansoft, Inc. and used under license 
  22.  * by Vocalocity.
  23.  ***********************************************************************/
  24. #include "SWIstream.hpp"
  25. /**
  26.  ** Abstract class representing output stream classes.
  27.  ** @doc <p>
  28.  **/
  29. class SWIUTIL_API_CLASS SWIoutputStream: public SWIstream
  30. {
  31.   // ................. CONSTRUCTORS, DESTRUCTOR  ............
  32.   //
  33.   // ------------------------------------------------------------
  34.   /// default constructor
  35. public:
  36.   SWIoutputStream();
  37.   // ------------------------------------------------------------
  38.   /// destructor
  39. public:
  40.   virtual ~SWIoutputStream();
  41.   //
  42.   // ......... METHODS ..........
  43.   //
  44.   /**
  45.    * Writes <code>bufferSize</code> bytes from the specified buffer.
  46.    *
  47.    * <p>
  48.    * If <code>buffer</code> is <code>null</code>,
  49.    * <code>SWI_STREAM_INVALID_ARGUMENT</code> is returned.
  50.    * <p>
  51.    *
  52.    * @param  buffer      [in] the data to be written.
  53.    * @param  bufferSize  [in] the number of bytes to write.
  54.    * @return the number of bytes written, or a negative number indicating failure.
  55.    **/
  56. public:
  57.   virtual int writeBytes(const void* buffer, int bufferSize) = 0;
  58.   /**
  59.    * Flushes this output stream and forces any buffered output bytes to be
  60.    * written out. The general contract of <code>flush</code> is that calling
  61.    * it is an indication that, if any bytes previously written have been
  62.    * buffered by the implementation of the output stream, such bytes should
  63.    * immediately be written to their intended destination.
  64.    * The default implementation does nothing returns
  65.    * <code>SWI_STREAM_SUCCESS</code> Sub-classes implementing buffering should
  66.    * re-implement this method.  <p>
  67.    *
  68.    *
  69.    * @return <code>SWI_STREAM_SUCCESS</code> if succes, negative value if
  70.    * failure.
  71.    **/
  72. public:
  73.   virtual SWIstream::Result flush();
  74.   /** Indicates whether this stream is buffered or not.  Default implementation
  75.    * returns false.  Sub classes using buffering should reimplemnent this mehod
  76.    * to return true.
  77.    **/
  78.  public:
  79.   virtual bool isBuffered() const;
  80.  public:
  81.   virtual SWIstream::Result printString(const char *s);
  82.  public:
  83.   virtual SWIstream::Result printChar(char c);
  84.  public:
  85.   virtual SWIstream::Result printInt(int i);
  86.   /**
  87.    * Waits until the stream is ready for writing bytes or the specified
  88.    * timeout expires.
  89.    *
  90.    * @param timeoutMs timeout, if less than 0, no timeout, a value of 0 means
  91.    * polling, verify the state of the stream and return immediately.
  92.    *
  93.    * Returns SUCCESS if the stream is ready, TIMED_OUT if the delay has
  94.    * expired or any other Stream::Result value to indicate a failure.
  95.    *
  96.    * Default implementation returns SWIstream::SUCCESS.
  97.    **/
  98.  public:
  99.   virtual SWIstream::Result waitReady(long timeoutMs = -1);
  100.   /**
  101.    * Closes this output stream and releases any system resources
  102.    * associated with this stream. The general contract of <code>close</code>
  103.    * is that it closes the output stream. A closed stream cannot perform
  104.    * output operations.
  105.    * <p>
  106.    * The default implementation just returns <code>SWI_STREAM_SUCCESS</code>
  107.    *
  108.    * @return SWI_STREAM_SUCCESS if success, negative value if failure.
  109.    **/
  110. public:
  111.   virtual Result close() = 0;
  112. };
  113. #endif