pipechan.h

Go to the documentation of this file.

/*
 * pipechan.h
 *
 * Sub-process with communications using pipe I/O channel class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 */

#ifndef PTLIB_PIPECHANNEL_H
#define PTLIB_PIPECHANNEL_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#if P_PIPECHAN

#include <ptlib/channel.h>


class PChannel;


class PPipeChannel : public PChannel
{
  PCLASSINFO(PPipeChannel, PChannel);

  public:
    enum OpenMode {
      ReadOnly,   
      WriteOnly,  
      ReadWrite,  
      ReadWriteStd
    };

    PPipeChannel();
    PPipeChannel(
      const PString & subProgram,  
      OpenMode mode = ReadWrite,   
      PBoolean searchPath = true,      
      PBoolean stderrSeparate = false  
    );
    PPipeChannel(
      const PString & subProgram,  
      const PStringArray & argumentList, 
      OpenMode mode = ReadWrite,   
      PBoolean searchPath = true,      
      PBoolean stderrSeparate = false  
    );
    PPipeChannel(
      const PString & subProgram,  
      const PStringToString & environment, 
      OpenMode mode = ReadWrite,   
      PBoolean searchPath = true,      
      PBoolean stderrSeparate = false  
    );
    PPipeChannel(
      const PString & subProgram,  
      const PStringArray & argumentList, 
      const PStringToString & environment, 
      OpenMode mode = ReadWrite,   
      PBoolean searchPath = true,      
      PBoolean stderrSeparate = false  
    );

    ~PPipeChannel();

    Comparison Compare(
      const PObject & obj   
    ) const;


    virtual PString GetName() const;

    virtual PBoolean Read(
      void * buf,   
      PINDEX len    
    );

    virtual PBoolean Write(
      const void * buf, 
      PINDEX len        
    );

    virtual PBoolean Close();

    PBoolean Open(
      const PString & subProgram,  
      OpenMode mode = ReadWrite,   
      PBoolean searchPath = true,      
      PBoolean stderrSeparate = false  
    );
    PBoolean Open(
      const PString & subProgram,  
      const PStringArray & argumentList, 
      OpenMode mode = ReadWrite,   
      PBoolean searchPath = true,      
      PBoolean stderrSeparate = false  
    );
    PBoolean Open(
      const PString & subProgram,  
      const PStringToString & environment, 
      OpenMode mode = ReadWrite,   
      PBoolean searchPath = true,      
      PBoolean stderrSeparate = false  
    );
    PBoolean Open(
      const PString & subProgram,  
      const PStringArray & argumentList, 
      const PStringToString & environment, 
      OpenMode mode = ReadWrite,   
      PBoolean searchPath = true,      
      PBoolean stderrSeparate = false  
    );

    const PFilePath & GetSubProgram() const;

    PBoolean Execute();

    PBoolean IsRunning() const;

    int GetReturnCode() const;

    int WaitForTermination();
    
    int WaitForTermination(
      const PTimeInterval & timeout  
    );

    PBoolean Kill(
      int signal = 9  
    );

    PBoolean ReadStandardError(
      PString & errors,   
      PBoolean wait = false   
    );

    static int Run(
        const PString & command,    
        PString & output,           
        bool includeStderr = true,  
        const PTimeInterval & timeout = PMaxTimeInterval  
    );

    static PBoolean CanReadAndWrite();


  protected:
    // Member variables
    PFilePath subProgName;


  private:
    PBoolean PlatformOpen(const PString & subProgram,
                      const PStringArray & arguments,
                      OpenMode mode,
                      PBoolean searchPath,
                      PBoolean stderrSeparate,
                      const PStringToString * environment);


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/pipechan.h"
#else
#include "unix/ptlib/pipechan.h"
#endif
};


#endif // P_PIPECHAN

#endif // PTLIB_PIPECHANNEL_H


// End Of File ///////////////////////////////////////////////////////////////