OW_UnnamedPipe.hpp

Go to the documentation of this file.
00001 /*******************************************************************************
00002 * Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
00003 *
00004 * Redistribution and use in source and binary forms, with or without
00005 * modification, are permitted provided that the following conditions are met:
00006 *
00007 *  - Redistributions of source code must retain the above copyright notice,
00008 *    this list of conditions and the following disclaimer.
00009 *
00010 *  - Redistributions in binary form must reproduce the above copyright notice,
00011 *    this list of conditions and the following disclaimer in the documentation
00012 *    and/or other materials provided with the distribution.
00013 *
00014 *  - Neither the name of Vintela, Inc. nor the names of its
00015 *    contributors may be used to endorse or promote products derived from this
00016 *    software without specific prior written permission.
00017 *
00018 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00019 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00020 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00021 * ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
00022 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00023 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00024 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00025 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00026 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00027 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00028 * POSSIBILITY OF SUCH DAMAGE.
00029 *******************************************************************************/
00030 
00035 #ifndef OW_UNNAMEDPIPE_HPP_
00036 #define OW_UNNAMEDPIPE_HPP_
00037 #include "OW_config.h"
00038 #include "OW_SelectableIFC.hpp"
00039 #include "OW_Exception.hpp"
00040 #include "OW_IntrusiveReference.hpp"
00041 #include "OW_IOIFC.hpp"
00042 #include "OW_CommonFwd.hpp"
00043 
00044 namespace OW_NAMESPACE
00045 {
00046 
00047 
00048 OW_DECLARE_APIEXCEPTION(UnnamedPipe, OW_COMMON_API);
00049 
00054 class OW_COMMON_API UnnamedPipe : public SelectableIFC, public IOIFC
00055 {
00056 public:
00057    virtual ~UnnamedPipe();
00058    
00067    int writeInt(int value);
00068 
00078    int writeString(const String& strData);
00079 
00088    int readInt(int* value);
00089 
00101    int readString(String& strData);
00102 
00109    void setReadTimeout(int seconds) { m_readTimeout = seconds; }
00116    int getReadTimeout() { return m_readTimeout; }
00123    void setWriteTimeout(int seconds) { m_writeTimeout = seconds; }
00130    int getWriteTimeout() { return m_writeTimeout; }
00137    void setTimeouts(int seconds) { m_readTimeout = m_writeTimeout = seconds; }
00138 
00147    String readAll();
00148 
00152    virtual void open() = 0;
00153 
00158    virtual int close() = 0;
00159 
00163    virtual bool isOpen() const = 0;
00164 
00168    virtual Select_t getWriteSelectObj() const = 0;
00169 
00170 
00171    enum EBlockingMode
00172    {
00173       E_NONBLOCKING,
00174       E_BLOCKING
00175    };
00181    virtual void setBlocking(EBlockingMode outputIsBlocking=E_BLOCKING) = 0;
00182    virtual void setOutputBlocking(bool outputIsBlocking=true) OW_DEPRECATED = 0; // in 3.0.0
00183 
00184    
00185    enum EOpen
00186    {
00187       E_DONT_OPEN,
00188       E_OPEN
00189    };
00195    static UnnamedPipeRef createUnnamedPipe(EOpen doOpen=E_OPEN);
00196 
00197 protected:
00198    UnnamedPipe()
00199       : SelectableIFC()
00200    {}
00201    int m_readTimeout;
00202    int m_writeTimeout;
00203 };
00204 OW_EXPORT_TEMPLATE(OW_COMMON_API, IntrusiveReference, UnnamedPipe);
00205 
00206 } // end namespace OW_NAMESPACE
00207 
00208 #endif   // OW_UNNAMEDPIPE_HPP_

Generated on Thu Feb 9 08:48:17 2006 for openwbem by  doxygen 1.4.6