epoc32/include/stdapis/spawn.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 /*
     2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:
    15 * Redistribution and use in source and binary forms, with or without 
    16 * modification, are permitted provided that the following conditions are met:
    17 * Redistributions of source code must retain the above copyright notice, this 
    18 * list of conditions and the following disclaimer. 
    19 * Redistributions in binary form must reproduce the above copyright notice, 
    20 * this list of conditions and the following disclaimer in the documentation 
    21 * and/or other materials provided with the distribution. 
    22 * Neither the name of the <ORGANIZATION> nor the names of its contributors 
    23 * may be used to endorse or promote products derived from this software 
    24 * without specific prior written permission. 
    25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
    26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
    27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
    28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
    29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
    30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
    31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
    32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
    34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    35 * 
    36 *
    37 */
    38 
    39 
    40 
    41 
    42 
    43 #ifndef	_SPAWN_H_
    44 #define	_SPAWN_H_
    45 
    46 #include <signal.h>
    47 #include <sys/types.h>
    48 #include <sched.h>
    49 
    50 typedef struct {
    51 	short _flags;
    52 	pid_t _pgrp;
    53 	sigset_t _sd;
    54 	sigset_t _sm;
    55 	struct sched_param _sp;
    56 	int _policy;
    57 } posix_spawnattr_t;
    58 
    59 /* Flags that can be set in posix_spawnattr_t */
    60 #define POSIX_SPAWN_RESETIDS		0x01
    61 #define POSIX_SPAWN_SETPGROUP		0x02
    62 #define POSIX_SPAWN_SETSIGDEF		0x04
    63 #define POSIX_SPAWN_SETSIGMASK		0x08
    64 #define POSIX_SPAWN_SETSCHEDPARAM	0x10
    65 #define POSIX_SPAWN_SETSCHEDULER	0x20
    66 
    67 // forward declaration
    68 struct file_actions_t;
    69 typedef struct {
    70 	int _cnt;
    71 	struct file_actions_t* _fa;
    72 } posix_spawn_file_actions_t;
    73 
    74 __BEGIN_DECLS
    75 
    76 IMPORT_C int posix_spawn(pid_t* pid, const char* path,
    77 				const posix_spawn_file_actions_t* file_actions,
    78 				const posix_spawnattr_t* attrp, char *const argv[],
    79 				char *const envp[]);
    80 				
    81 IMPORT_C int posix_spawn_file_actions_addclose(posix_spawn_file_actions_t* file_actions,
    82 				int fid);
    83 				
    84 IMPORT_C int posix_spawn_file_actions_adddup2(posix_spawn_file_actions_t* file_actions,
    85 				int fid1, int fid2);
    86 				
    87 IMPORT_C int posix_spawn_file_actions_addopen(posix_spawn_file_actions_t* file_actions,
    88           		int fid, const char* path, int oflag, mode_t mode);
    89           		
    90 IMPORT_C int posix_spawn_file_actions_destroy(posix_spawn_file_actions_t* file_actions);
    91 
    92 IMPORT_C int posix_spawn_file_actions_init(posix_spawn_file_actions_t* file_actions);
    93 
    94 IMPORT_C int posix_spawnattr_destroy(posix_spawnattr_t* attrp);
    95 
    96 IMPORT_C int posix_spawnattr_getsigdefault(const posix_spawnattr_t* attrp, 
    97 				sigset_t* sigdefault);
    98 									
    99 IMPORT_C int posix_spawnattr_getflags(const posix_spawnattr_t* attrp, short* flags);
   100 
   101 IMPORT_C int posix_spawnattr_getpgroup(const posix_spawnattr_t* attrp, pid_t* pgroup);
   102 
   103 IMPORT_C int posix_spawnattr_getschedparam(const posix_spawnattr_t* attrp,
   104           		struct sched_param* schedparam);
   105           		
   106 IMPORT_C int posix_spawnattr_getschedpolicy(const posix_spawnattr_t* attrp, int* policy);
   107 
   108 IMPORT_C int posix_spawnattr_getsigmask(const posix_spawnattr_t* attrp, sigset_t* sigmask);
   109 
   110 IMPORT_C int posix_spawnattr_init(posix_spawnattr_t* attrp);
   111 
   112 IMPORT_C int posix_spawnattr_setsigdefault(posix_spawnattr_t* attrp,
   113 				const sigset_t* sigdefault);
   114 
   115 IMPORT_C int posix_spawnattr_setflags(posix_spawnattr_t* attrp, short flags);
   116 
   117 IMPORT_C int posix_spawnattr_setpgroup(posix_spawnattr_t* attrp, pid_t pgroup);
   118 
   119 IMPORT_C int posix_spawnattr_setschedparam(posix_spawnattr_t* attrp,
   120 				const struct sched_param* schedparam);
   121 				
   122 IMPORT_C int posix_spawnattr_setschedpolicy(posix_spawnattr_t* attrp, int policy);
   123 
   124 IMPORT_C int posix_spawnattr_setsigmask(posix_spawnattr_t* attrp, const sigset_t* sigmask);
   125           
   126 __END_DECLS
   127 
   128 #endif /* _SPAWN_H_ */