Annotation of libelwix/inc/elwix/apio.h, revision 1.5.2.1

1.2       misho       1: /*************************************************************************
                      2: * (C) 2013 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
                      3: *  by Michael Pounov <misho@elwix.org>
                      4: *
                      5: * $Author: misho $
1.5.2.1 ! misho       6: * $Id: apio.h,v 1.5 2020/06/19 13:06:17 misho Exp $
1.2       misho       7: *
                      8: **************************************************************************
                      9: The ELWIX and AITNET software is distributed under the following
                     10: terms:
                     11: 
                     12: All of the documentation and software included in the ELWIX and AITNET
                     13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
                     14: 
1.5       misho      15: Copyright 2004 - 2020
1.2       misho      16:        by Michael Pounov <misho@elwix.org>.  All rights reserved.
                     17: 
                     18: Redistribution and use in source and binary forms, with or without
                     19: modification, are permitted provided that the following conditions
                     20: are met:
                     21: 1. Redistributions of source code must retain the above copyright
                     22:    notice, this list of conditions and the following disclaimer.
                     23: 2. Redistributions in binary form must reproduce the above copyright
                     24:    notice, this list of conditions and the following disclaimer in the
                     25:    documentation and/or other materials provided with the distribution.
                     26: 3. All advertising materials mentioning features or use of this software
                     27:    must display the following acknowledgement:
                     28: This product includes software developed by Michael Pounov <misho@elwix.org>
                     29: ELWIX - Embedded LightWeight unIX and its contributors.
                     30: 4. Neither the name of AITNET nor the names of its contributors
                     31:    may be used to endorse or promote products derived from this software
                     32:    without specific prior written permission.
                     33: 
                     34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
                     35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     44: SUCH DAMAGE.
                     45: */
                     46: #ifndef __APIO_H
                     47: #define __APIO_H
                     48: 
                     49: 
                     50: struct tagPIOPID {
                     51:        union {
                     52:                FILE            *fp;
                     53:                int             fd;
                     54:        } f;
                     55:        pid_t                   pid;
                     56:        int                     stat;
                     57: 
                     58:        SLIST_ENTRY(tagPIOPID)  next;
                     59: };
                     60: typedef SLIST_HEAD(, tagPIOPID) pio_pid_t;
                     61: 
                     62: 
                     63: extern pio_pid_t pio_pidlist;
                     64: 
                     65: 
                     66: /*
                     67:  * e_popen() - ELWIX replacement of standard popen
                     68:  *
                     69:  * @command = command
                     70:  * @type = type
                     71:  * @ppid = return pid of child program
1.5.2.1 ! misho      72:  *     If value of *ppid is -1 when invoke routine then child will be session leader
1.2       misho      73:  * return: NULL error or !=NULL open program
                     74:  */
                     75: #ifdef POPEN_STREAM
                     76: FILE *e_popen(const char *command, const char *type, pid_t *ppid);
                     77: #else
                     78: int e_popen(const char *command, const char *type, pid_t *ppid);
1.5       misho      79: #endif
                     80: /*
                     81:  * e_popen2() - ELWIX replacement of standard popen with post close of chosen handles
                     82:  *
                     83:  * @command = command
                     84:  * @type = type
                     85:  * @ppid = return pid of child program
1.5.2.1 ! misho      86:  *     If value of *ppid is -1 when invoke routine then child will be session leader
1.5       misho      87:  * @fds = file descriptor array for close when fork
                     88:  * @fdslen = fds number of descriptors
                     89:  * return: NULL error or !=NULL open program
                     90:  */
                     91: #ifdef POPEN_STREAM
                     92: FILE *e_popen2(const char *command, const char *type, pid_t *ppid, int *fds, size_t fdslen);
                     93: #else
                     94: int e_popen2(const char *command, const char *type, pid_t *ppid, int *fds, size_t fdslen);
1.2       misho      95: #endif
                     96: /*
                     97:  * e_pclose() - ELWIX replacement of standard pclose
                     98:  *
                     99:  * @iop = popen handle
                    100:  * return: -1 error or !=-1 pid status
                    101:  */
                    102: #ifdef POPEN_STREAM
                    103: int e_pclose(FILE *iop);
                    104: #else
                    105: int e_pclose(int iop);
                    106: #endif
                    107: 
                    108: /*
                    109:  * pio_pgetpid() - Get tagPIOPID structure from file handle
                    110:  *
                    111:  * @iop = popen handle
                    112:  * return: NULL error or !=NULL tagPIOPID structure
                    113:  */
                    114: #ifdef POPEN_STREAM
                    115: struct tagPIOPID *pio_pgetpid(FILE *iop);
                    116: #else
                    117: struct tagPIOPID *pio_pgetpid(int iop);
                    118: #endif
                    119: /*
                    120:  * pio_pchkpid() - Check exit status of child programs
                    121:  *
                    122:  * @pids = return tagPIOPID structures of exited programs, 
                    123:  *             if !=NULL must call array_Destroy()
                    124:  * return: -1 error or >-1 exited programs
                    125:  */
                    126: int pio_pchkpid(array_t ** __restrict pids);
                    127: 
                    128: 
                    129: #endif

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>