UnnamedPipe.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 
*     * Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of 
*       Vintela, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees may be used to 
*       endorse or promote products derived from this software without 
*       specific prior written permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/


#ifndef BLOCXX_UNNAMEDPIPE_HPP_
#define BLOCXX_UNNAMEDPIPE_HPP_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/IntrusiveCountableBase.hpp"
#include "blocxx/Exception.hpp"
#include "blocxx/IntrusiveReference.hpp"
#include "blocxx/IOIFC.hpp"
#include "blocxx/CommonFwd.hpp"
#include "blocxx/Timeout.hpp"
#include "blocxx/AutoDescriptor.hpp"
#include "blocxx/NetworkTypes.hpp"

namespace BLOCXX_NAMESPACE
{


BLOCXX_DECLARE_APIEXCEPTION(UnnamedPipe, BLOCXX_COMMON_API);

class BLOCXX_COMMON_API UnnamedPipe : public IOIFC, public IntrusiveCountableBase
{
public:
   virtual ~UnnamedPipe();

   int writeInt(int value);

   int writeString(const String& strData);

   int readInt(int* value);

   int readString(String& strData);

   static const int INFINITE_TIMEOUT = -1;
   void setReadTimeout(const Timeout& timeout) { m_readTimeout = timeout; }
   BLOCXX_DEPRECATED void setReadTimeout(int seconds) { m_readTimeout = Timeout::relative(seconds); }
   Timeout getReadTimeout() { return m_readTimeout; }
   void setWriteTimeout(const Timeout& timeout) { m_writeTimeout = timeout; }
   BLOCXX_DEPRECATED void setWriteTimeout(int seconds) { m_writeTimeout = Timeout::relative(seconds); }
   Timeout getWriteTimeout() { return m_writeTimeout; }
   void setTimeouts(const Timeout& timeout) { m_readTimeout = m_writeTimeout = timeout; }
   BLOCXX_DEPRECATED void setTimeouts(int seconds) { m_readTimeout = m_writeTimeout = Timeout::relative(seconds); }

   String readAll();

   virtual void open() = 0;

   virtual int close() = 0;

   virtual bool isOpen() const = 0;

   virtual Select_t getReadSelectObj() const = 0;

   virtual Select_t getWriteSelectObj() const = 0;


   enum EBlockingMode
   {
      E_NONBLOCKING, //<! Non-Blocking mode flag.
      E_BLOCKING  //<! Blocking mode flag.
   };
   virtual void setBlocking(EBlockingMode isBlocking=E_BLOCKING) = 0;

   virtual void setWriteBlocking(EBlockingMode isBlocking=E_BLOCKING) = 0;

   virtual void setReadBlocking(EBlockingMode isBlocking=E_BLOCKING) = 0;

   virtual EBlockingMode getReadBlocking() const = 0;

   virtual EBlockingMode getWriteBlocking() const = 0;

   virtual Descriptor getInputDescriptor() const = 0;
   
   virtual Descriptor getOutputDescriptor() const = 0;

   virtual void passDescriptor(Descriptor h, const UnnamedPipeRef& ackPipe = 0, const ProcessRef& targetProcess = 0) = 0;

   virtual AutoDescriptor receiveDescriptor(const UnnamedPipeRef& ackPipe = 0) = 0;

   virtual int closeInputHandle() = 0;
   virtual int closeOutputHandle() = 0;


   enum EOpen
   {
      E_DONT_OPEN,
      E_OPEN
   };
   static UnnamedPipeRef createUnnamedPipe(EOpen doOpen=E_OPEN);
   static UnnamedPipeRef createUnnamedPipeFromDescriptor(AutoDescriptor inputAndOutput);
   static UnnamedPipeRef createUnnamedPipeFromDescriptor(AutoDescriptor input, AutoDescriptor output);

   static void createConnectedPipes(UnnamedPipeRef& first,
                                    UnnamedPipeRef& second);

   static UnnamedPipeRef createStdin();
   static UnnamedPipeRef createStdout();
   static UnnamedPipeRef createStdinStdout();
   static UnnamedPipeRef createStderr();

protected:
   UnnamedPipe()
      : m_readTimeout(Timeout::infinite)
      , m_writeTimeout(Timeout::infinite)
   {}
private:
   Timeout m_readTimeout;
   Timeout m_writeTimeout;
};
BLOCXX_EXPORT_TEMPLATE(BLOCXX_COMMON_API, IntrusiveReference, UnnamedPipe);

} // end namespace BLOCXX_NAMESPACE

#endif   // BLOCXX_UNNAMEDPIPE_HPP_