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