blocxx

PosixUnnamedPipe.hpp

Go to the documentation of this file.
00001 /*******************************************************************************
00002 * Copyright (C) 2005, Vintela, Inc. All rights reserved.
00003 * Copyright (C) 2006, Novell, Inc. All rights reserved.
00004 * 
00005 * Redistribution and use in source and binary forms, with or without
00006 * modification, are permitted provided that the following conditions are met:
00007 * 
00008 *     * Redistributions of source code must retain the above copyright notice,
00009 *       this list of conditions and the following disclaimer.
00010 *     * Redistributions in binary form must reproduce the above copyright
00011 *       notice, this list of conditions and the following disclaimer in the
00012 *       documentation and/or other materials provided with the distribution.
00013 *     * Neither the name of 
00014 *       Vintela, Inc., 
00015 *       nor Novell, Inc., 
00016 *       nor the names of its contributors or employees may be used to 
00017 *       endorse or promote products derived from this software without 
00018 *       specific prior written permission.
00019 * 
00020 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00021 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00022 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00023 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00024 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00025 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00026 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00027 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00028 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00029 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00030 * POSSIBILITY OF SUCH DAMAGE.
00031 *******************************************************************************/
00032 
00033 
00038 #ifndef BLOCXX_POSIX_UNNAMED_PIPE_HPP_
00039 #define BLOCXX_POSIX_UNNAMED_PIPE_HPP_
00040 #include "blocxx/BLOCXX_config.h"
00041 #include "blocxx/UnnamedPipe.hpp"
00042 #include "blocxx/IntrusiveReference.hpp"
00043 
00044 // The classes and functions defined in this file are not meant for general
00045 // use, they are internal implementation details.  They may change at any time.
00046 
00047 namespace BLOCXX_NAMESPACE
00048 {
00049 
00050 class BLOCXX_COMMON_API PosixUnnamedPipe : public UnnamedPipe
00051 {
00052 public:
00053    PosixUnnamedPipe(EOpen doOpen=E_OPEN);
00056    //
00057    PosixUnnamedPipe(AutoDescriptor inputfd, AutoDescriptor outputfd);
00058    virtual ~PosixUnnamedPipe();
00059    virtual int write(const void* data, int dataLen, ErrorAction errorAsException = E_RETURN_ON_ERROR);
00060    virtual int read(void* buffer, int bufferLen, ErrorAction errorAsException = E_RETURN_ON_ERROR);
00061    Descriptor getInputHandle() const { return m_fds[0]; }
00062    Descriptor getOutputHandle() const { return m_fds[1]; }
00063    virtual void open();
00064    virtual int close();
00065    virtual bool isOpen() const;
00066    virtual int closeInputHandle();
00067    virtual int closeOutputHandle();
00068    virtual void setBlocking(EBlockingMode outputIsBlocking=E_BLOCKING);
00069    virtual void setWriteBlocking(EBlockingMode isBlocking=E_BLOCKING);
00070    virtual void setReadBlocking(EBlockingMode isBlocking=E_BLOCKING);
00071    virtual EBlockingMode getReadBlocking() const;
00072    virtual EBlockingMode getWriteBlocking() const;
00073    virtual Select_t getReadSelectObj() const;
00074    virtual Select_t getWriteSelectObj() const;
00075    virtual Descriptor getInputDescriptor() const;
00076    virtual Descriptor getOutputDescriptor() const;
00077    virtual void passDescriptor(Descriptor h, const UnnamedPipeRef& ackPipe = 0, const ProcessRef& targetProcess = 0);
00078    virtual AutoDescriptor receiveDescriptor(const UnnamedPipeRef& ackPipe);
00079 
00080 private:
00081    // unimplemented
00082    PosixUnnamedPipe(const PosixUnnamedPipe& x);
00083    PosixUnnamedPipe& operator=(const PosixUnnamedPipe& x);
00084 
00085 
00086    Descriptor m_fds[2];
00087    EBlockingMode m_blocking[2];
00088 };
00089 typedef IntrusiveReference<PosixUnnamedPipe> PosixUnnamedPipeRef;
00090 
00091 } // end namespace BLOCXX_NAMESPACE
00092 
00093 #endif