nsprpub/pr/include/prproces.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is the Netscape Portable Runtime (NSPR).
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998-2000
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef prproces_h___
  39 #define prproces_h___
  40
  41 #include "prtypes.h"
  42 #include "prio.h"
  43
  44 PR_BEGIN_EXTERN_C
  45
  46 /************************************************************************/
  47 /*****************************PROCESS OPERATIONS*************************/
  48 /************************************************************************/
  49
  50 typedef struct PRProcess PRProcess;
  51 typedef struct PRProcessAttr PRProcessAttr;
  52
  53 NSPR_API(PRProcessAttr *) PR_NewProcessAttr(void);
  54
  55 NSPR_API(void) PR_ResetProcessAttr(PRProcessAttr *attr);
  56
  57 NSPR_API(void) PR_DestroyProcessAttr(PRProcessAttr *attr);
  58
  59 NSPR_API(void) PR_ProcessAttrSetStdioRedirect(
  60     PRProcessAttr *attr,
  61     PRSpecialFD stdioFd,
  62     PRFileDesc *redirectFd
  63 );
  64
  65 /*
  66  * OBSOLETE -- use PR_ProcessAttrSetStdioRedirect instead.
  67  */
  68 NSPR_API(void) PR_SetStdioRedirect(
  69     PRProcessAttr *attr,
  70     PRSpecialFD stdioFd,
  71     PRFileDesc *redirectFd
  72 );
  73
  74 NSPR_API(PRStatus) PR_ProcessAttrSetCurrentDirectory(
  75     PRProcessAttr *attr,
  76     const char *dir
  77 );
  78
  79 NSPR_API(PRStatus) PR_ProcessAttrSetInheritableFD(
  80     PRProcessAttr *attr,
  81     PRFileDesc *fd,
  82     const char *name
  83 );
  84
  85 /*
  86 ** Create a new process
  87 **
  88 ** Create a new process executing the file specified as 'path' and with
  89 ** the supplied arguments and environment.
  90 **
  91 ** This function may fail because of illegal access (permissions),
  92 ** invalid arguments or insufficient resources.
  93 **
  94 ** A process may be created such that the creator can later synchronize its
  95 ** termination using PR_WaitProcess().
  96 */
  97
  98 NSPR_API(PRProcess*) PR_CreateProcess(
  99     const char *path,
 100     char *const *argv,
 101     char *const *envp,
 102     const PRProcessAttr *attr);
 103
 104 NSPR_API(PRStatus) PR_CreateProcessDetached(
 105     const char *path,
 106     char *const *argv,
 107     char *const *envp,
 108     const PRProcessAttr *attr);
 109
 110 NSPR_API(PRStatus) PR_DetachProcess(PRProcess *process);
 111
 112 NSPR_API(PRStatus) PR_WaitProcess(PRProcess *process, PRInt32 *exitCode);
 113
 114 NSPR_API(PRStatus) PR_KillProcess(PRProcess *process);
 115
 116 PR_END_EXTERN_C
 117
 118 #endif /* prproces_h___ */