[apple/launchd.git] / launchd / src / launch.h

/*
 * Copyright (c) 2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_APACHE_LICENSE_HEADER_START@
 * 
 * Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * @APPLE_APACHE_LICENSE_HEADER_END@
 */
#ifndef _LAUNCH_H_
#define _LAUNCH_H_

#include <mach/mach.h>
#include <sys/cdefs.h>
#include <stddef.h>
#include <stdbool.h>

#pragma GCC visibility push(default)

__BEGIN_DECLS

#ifdef __GNUC__
#define __ld_normal __attribute__((__nothrow__))
#define __ld_setter __attribute__((__nothrow__, __nonnull__))
#define __ld_getter __attribute__((__nothrow__, __nonnull__, __pure__, __warn_unused_result__))
#define __ld_iterator(x, y) __attribute__((__nonnull__(x, y)))
#define __ld_allocator __attribute__((__nothrow__, __malloc__, __nonnull__, __warn_unused_result__))
#else
#define __ld_normal
#define __ld_setter
#define __ld_getter
#define __ld_iterator(x, y)
#define __ld_allocator
#endif


#define LAUNCH_KEY_SUBMITJOB						"SubmitJob"
#define LAUNCH_KEY_REMOVEJOB						"RemoveJob"
#define LAUNCH_KEY_STARTJOB							"StartJob"
#define LAUNCH_KEY_STOPJOB							"StopJob"
#define LAUNCH_KEY_GETJOB							"GetJob"
#define LAUNCH_KEY_GETJOBS							"GetJobs"
#define LAUNCH_KEY_CHECKIN							"CheckIn"

#define LAUNCH_JOBKEY_LABEL							"Label"
#define LAUNCH_JOBKEY_DISABLED						"Disabled"
#define LAUNCH_JOBKEY_USERNAME						"UserName"
#define LAUNCH_JOBKEY_GROUPNAME						"GroupName"
#define LAUNCH_JOBKEY_TIMEOUT						"TimeOut"
#define LAUNCH_JOBKEY_EXITTIMEOUT					"ExitTimeOut"
#define LAUNCH_JOBKEY_INITGROUPS					"InitGroups"
#define LAUNCH_JOBKEY_SOCKETS						"Sockets"
#define LAUNCH_JOBKEY_MACHSERVICES					"MachServices"
#define LAUNCH_JOBKEY_MACHSERVICELOOKUPPOLICIES		"MachServiceLookupPolicies"
#define LAUNCH_JOBKEY_INETDCOMPATIBILITY			"inetdCompatibility"
#define LAUNCH_JOBKEY_ENABLEGLOBBING				"EnableGlobbing"
#define LAUNCH_JOBKEY_PROGRAMARGUMENTS				"ProgramArguments"
#define LAUNCH_JOBKEY_PROGRAM						"Program"
#define LAUNCH_JOBKEY_ONDEMAND						"OnDemand"
#define LAUNCH_JOBKEY_KEEPALIVE						"KeepAlive"
#define LAUNCH_JOBKEY_LIMITLOADTOHOSTS				"LimitLoadToHosts"
#define LAUNCH_JOBKEY_LIMITLOADFROMHOSTS			"LimitLoadFromHosts"
#define LAUNCH_JOBKEY_LIMITLOADTOSESSIONTYPE		"LimitLoadToSessionType"
#define LAUNCH_JOBKEY_RUNATLOAD						"RunAtLoad"
#define LAUNCH_JOBKEY_ROOTDIRECTORY					"RootDirectory"
#define LAUNCH_JOBKEY_WORKINGDIRECTORY				"WorkingDirectory"
#define LAUNCH_JOBKEY_ENVIRONMENTVARIABLES			"EnvironmentVariables"
#define LAUNCH_JOBKEY_USERENVIRONMENTVARIABLES		"UserEnvironmentVariables"
#define LAUNCH_JOBKEY_UMASK							"Umask"
#define LAUNCH_JOBKEY_NICE							"Nice"
#define LAUNCH_JOBKEY_HOPEFULLYEXITSFIRST	  		"HopefullyExitsFirst"
#define LAUNCH_JOBKEY_HOPEFULLYEXITSLAST   			"HopefullyExitsLast"
#define LAUNCH_JOBKEY_LOWPRIORITYIO					"LowPriorityIO"
#define LAUNCH_JOBKEY_SESSIONCREATE					"SessionCreate"
#define LAUNCH_JOBKEY_STARTONMOUNT					"StartOnMount"
#define LAUNCH_JOBKEY_SOFTRESOURCELIMITS			"SoftResourceLimits"
#define LAUNCH_JOBKEY_HARDRESOURCELIMITS			"HardResourceLimits"
#define LAUNCH_JOBKEY_STANDARDINPATH				"StandardInPath"
#define LAUNCH_JOBKEY_STANDARDOUTPATH				"StandardOutPath"
#define LAUNCH_JOBKEY_STANDARDERRORPATH				"StandardErrorPath"
#define LAUNCH_JOBKEY_DEBUG							"Debug"
#define LAUNCH_JOBKEY_WAITFORDEBUGGER				"WaitForDebugger"
#define LAUNCH_JOBKEY_QUEUEDIRECTORIES				"QueueDirectories"
#define LAUNCH_JOBKEY_WATCHPATHS					"WatchPaths"
#define LAUNCH_JOBKEY_STARTINTERVAL					"StartInterval"
#define LAUNCH_JOBKEY_STARTCALENDARINTERVAL			"StartCalendarInterval"
#define LAUNCH_JOBKEY_BONJOURFDS					"BonjourFDs"
#define LAUNCH_JOBKEY_LASTEXITSTATUS				"LastExitStatus"
#define LAUNCH_JOBKEY_PID							"PID"
#define LAUNCH_JOBKEY_THROTTLEINTERVAL				"ThrottleInterval"
#define LAUNCH_JOBKEY_LAUNCHONLYONCE				"LaunchOnlyOnce"
#define LAUNCH_JOBKEY_ABANDONPROCESSGROUP			"AbandonProcessGroup"
#define LAUNCH_JOBKEY_IGNOREPROCESSGROUPATSHUTDOWN	"IgnoreProcessGroupAtShutdown"
#define LAUNCH_JOBKEY_POLICIES						"Policies"
#define LAUNCH_JOBKEY_ENABLETRANSACTIONS			"EnableTransactions"

#define LAUNCH_JOBPOLICY_DENYCREATINGOTHERJOBS		"DenyCreatingOtherJobs"

#define LAUNCH_JOBINETDCOMPATIBILITY_WAIT			"Wait"

#define LAUNCH_JOBKEY_MACH_RESETATCLOSE				"ResetAtClose"
#define LAUNCH_JOBKEY_MACH_HIDEUNTILCHECKIN			"HideUntilCheckIn"
#define LAUNCH_JOBKEY_MACH_DRAINMESSAGESONCRASH		"DrainMessagesOnCrash"

#define LAUNCH_JOBKEY_KEEPALIVE_SUCCESSFULEXIT		"SuccessfulExit"
#define LAUNCH_JOBKEY_KEEPALIVE_NETWORKSTATE		"NetworkState"
#define LAUNCH_JOBKEY_KEEPALIVE_PATHSTATE			"PathState"
#define LAUNCH_JOBKEY_KEEPALIVE_OTHERJOBACTIVE		"OtherJobActive"
#define LAUNCH_JOBKEY_KEEPALIVE_OTHERJOBENABLED		"OtherJobEnabled"
#define LAUNCH_JOBKEY_KEEPALIVE_AFTERINITIALDEMAND	"AfterInitialDemand"

#define LAUNCH_JOBKEY_CAL_MINUTE					"Minute"
#define LAUNCH_JOBKEY_CAL_HOUR						"Hour"
#define LAUNCH_JOBKEY_CAL_DAY						"Day"
#define LAUNCH_JOBKEY_CAL_WEEKDAY					"Weekday"
#define LAUNCH_JOBKEY_CAL_MONTH						"Month"
                                            
#define LAUNCH_JOBKEY_RESOURCELIMIT_CORE			"Core"
#define LAUNCH_JOBKEY_RESOURCELIMIT_CPU				"CPU"
#define LAUNCH_JOBKEY_RESOURCELIMIT_DATA			"Data"
#define LAUNCH_JOBKEY_RESOURCELIMIT_FSIZE			"FileSize"
#define LAUNCH_JOBKEY_RESOURCELIMIT_MEMLOCK			"MemoryLock"
#define LAUNCH_JOBKEY_RESOURCELIMIT_NOFILE			"NumberOfFiles"
#define LAUNCH_JOBKEY_RESOURCELIMIT_NPROC			"NumberOfProcesses"
#define LAUNCH_JOBKEY_RESOURCELIMIT_RSS				"ResidentSetSize"
#define LAUNCH_JOBKEY_RESOURCELIMIT_STACK			"Stack"

#define LAUNCH_JOBKEY_DISABLED_MACHINETYPE			"MachineType"
#define LAUNCH_JOBKEY_DISABLED_MODELNAME			"ModelName"

#define LAUNCH_JOBSOCKETKEY_TYPE					"SockType"
#define LAUNCH_JOBSOCKETKEY_PASSIVE					"SockPassive"
#define LAUNCH_JOBSOCKETKEY_BONJOUR					"Bonjour"
#define LAUNCH_JOBSOCKETKEY_SECUREWITHKEY			"SecureSocketWithKey"
#define LAUNCH_JOBSOCKETKEY_PATHNAME				"SockPathName"
#define LAUNCH_JOBSOCKETKEY_PATHMODE				"SockPathMode"
#define LAUNCH_JOBSOCKETKEY_NODENAME				"SockNodeName"
#define LAUNCH_JOBSOCKETKEY_SERVICENAME				"SockServiceName"
#define LAUNCH_JOBSOCKETKEY_FAMILY					"SockFamily"
#define LAUNCH_JOBSOCKETKEY_PROTOCOL				"SockProtocol"
#define LAUNCH_JOBSOCKETKEY_MULTICASTGROUP			"MulticastGroup"

typedef struct _launch_data *launch_data_t;

typedef enum {
	LAUNCH_DATA_DICTIONARY = 1,
	LAUNCH_DATA_ARRAY,
	LAUNCH_DATA_FD,
	LAUNCH_DATA_INTEGER,
	LAUNCH_DATA_REAL,
	LAUNCH_DATA_BOOL,
	LAUNCH_DATA_STRING,
	LAUNCH_DATA_OPAQUE,
	LAUNCH_DATA_ERRNO,
	LAUNCH_DATA_MACHPORT,
} launch_data_type_t;

launch_data_t		launch_data_alloc(launch_data_type_t) __ld_allocator;
launch_data_t		launch_data_copy(launch_data_t) __ld_allocator;
launch_data_type_t	launch_data_get_type(const launch_data_t) __ld_getter;
void			launch_data_free(launch_data_t) __ld_setter;

/* Generic Dictionaries */
/* the value should not be changed while iterating */
bool		launch_data_dict_insert(launch_data_t, const launch_data_t, const char *) __ld_setter;
launch_data_t	launch_data_dict_lookup(const launch_data_t, const char *) __ld_getter;
bool		launch_data_dict_remove(launch_data_t, const char *) __ld_setter;
void		launch_data_dict_iterate(const launch_data_t, void (*)(const launch_data_t, const char *, void *), void *) __ld_iterator(1, 2);
size_t		launch_data_dict_get_count(const launch_data_t) __ld_getter;

/* Generic Arrays */
bool		launch_data_array_set_index(launch_data_t, const launch_data_t, size_t) __ld_setter;
launch_data_t	launch_data_array_get_index(const launch_data_t, size_t) __ld_getter;
size_t		launch_data_array_get_count(const launch_data_t) __ld_getter;

launch_data_t	launch_data_new_fd(int) __ld_allocator;
launch_data_t	launch_data_new_machport(mach_port_t) __ld_allocator;
launch_data_t	launch_data_new_integer(long long) __ld_allocator;
launch_data_t	launch_data_new_bool(bool) __ld_allocator;
launch_data_t	launch_data_new_real(double) __ld_allocator;
launch_data_t	launch_data_new_string(const char *) __ld_allocator;
launch_data_t	launch_data_new_opaque(const void *, size_t) __ld_allocator;

bool		launch_data_set_fd(launch_data_t, int) __ld_setter;
bool		launch_data_set_machport(launch_data_t, mach_port_t) __ld_setter;
bool		launch_data_set_integer(launch_data_t, long long) __ld_setter;
bool		launch_data_set_bool(launch_data_t, bool) __ld_setter;
bool		launch_data_set_real(launch_data_t, double) __ld_setter;
bool		launch_data_set_string(launch_data_t, const char *) __ld_setter;
bool		launch_data_set_opaque(launch_data_t, const void *, size_t) __ld_setter;

int		launch_data_get_fd(const launch_data_t) __ld_getter;
mach_port_t	launch_data_get_machport(const launch_data_t) __ld_getter;
long long	launch_data_get_integer(const launch_data_t) __ld_getter;
bool		launch_data_get_bool(const launch_data_t) __ld_getter;
double		launch_data_get_real(const launch_data_t) __ld_getter;
const char *	launch_data_get_string(const launch_data_t) __ld_getter;
void *		launch_data_get_opaque(const launch_data_t) __ld_getter;
size_t		launch_data_get_opaque_size(const launch_data_t) __ld_getter;
int		launch_data_get_errno(const launch_data_t) __ld_getter;


/* launch_get_fd()
 *
 * Use this to get the FD if you're doing asynchronous I/O with select(),
 * poll() or kevent().
 */
int launch_get_fd(void) __ld_normal;

/* launch_msg()
 *
 * Use this API to send and receive messages.
 * Calling launch_msg() with no message to send is a valid way to get
 * asynchronously received messages.
 *
 * If a message was to be sent, it returns NULL and errno on failure.
 *
 * If no messages were to be sent, it returns NULL and errno is set to zero if
 * no more asynchronous messages are available.
 */
launch_data_t launch_msg(const launch_data_t) __ld_normal;

__END_DECLS

#pragma GCC visibility pop

#endif
Commit	Line	Data
e91b9f68 A	1	/*
	2	* Copyright (c) 2005 Apple Computer, Inc. All rights reserved.
	3	*
ed34e3c3	4	* @APPLE_APACHE_LICENSE_HEADER_START@
e91b9f68	5	*
ed34e3c3 A	6	* Licensed under the Apache License, Version 2.0 (the "License");
	7	* you may not use this file except in compliance with the License.
	8	* You may obtain a copy of the License at
e91b9f68	9	*
ed34e3c3 A	10	* http://www.apache.org/licenses/LICENSE-2.0
	11	*
	12	* Unless required by applicable law or agreed to in writing, software
	13	* distributed under the License is distributed on an "AS IS" BASIS,
	14	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	15	* See the License for the specific language governing permissions and
e91b9f68 A	16	* limitations under the License.
e91b9f68 A	17	*
ed34e3c3	18	* @APPLE_APACHE_LICENSE_HEADER_END@
e91b9f68 A	19	*/
	20	#ifndef _LAUNCH_H_
	21	#define _LAUNCH_H_
	22
ed34e3c3 A	23	#include <mach/mach.h>
ed34e3c3 A	24	#include <sys/cdefs.h>
e91b9f68 A	25	#include <stddef.h>
	26	#include <stdbool.h>
	27
5b0a4722 A	28	#pragma GCC visibility push(default)
5b0a4722 A	29
ed34e3c3 A	30	__BEGIN_DECLS
	31
	32	#ifdef __GNUC__
	33	#define __ld_normal __attribute__((__nothrow__))
	34	#define __ld_setter __attribute__((__nothrow__, __nonnull__))
	35	#define __ld_getter __attribute__((__nothrow__, __nonnull__, __pure__, __warn_unused_result__))
	36	#define __ld_iterator(x, y) __attribute__((__nonnull__(x, y)))
	37	#define __ld_allocator __attribute__((__nothrow__, __malloc__, __nonnull__, __warn_unused_result__))
	38	#else
	39	#define __ld_normal
	40	#define __ld_setter
	41	#define __ld_getter
	42	#define __ld_iterator(x, y)
	43	#define __ld_allocator
	44	#endif
	45
e91b9f68	46
ddbbfbc1 A	47	#define LAUNCH_KEY_SUBMITJOB "SubmitJob"
	48	#define LAUNCH_KEY_REMOVEJOB "RemoveJob"
	49	#define LAUNCH_KEY_STARTJOB "StartJob"
	50	#define LAUNCH_KEY_STOPJOB "StopJob"
	51	#define LAUNCH_KEY_GETJOB "GetJob"
	52	#define LAUNCH_KEY_GETJOBS "GetJobs"
	53	#define LAUNCH_KEY_CHECKIN "CheckIn"
	54
	55	#define LAUNCH_JOBKEY_LABEL "Label"
	56	#define LAUNCH_JOBKEY_DISABLED "Disabled"
	57	#define LAUNCH_JOBKEY_USERNAME "UserName"
	58	#define LAUNCH_JOBKEY_GROUPNAME "GroupName"
	59	#define LAUNCH_JOBKEY_TIMEOUT "TimeOut"
	60	#define LAUNCH_JOBKEY_EXITTIMEOUT "ExitTimeOut"
	61	#define LAUNCH_JOBKEY_INITGROUPS "InitGroups"
	62	#define LAUNCH_JOBKEY_SOCKETS "Sockets"
	63	#define LAUNCH_JOBKEY_MACHSERVICES "MachServices"
	64	#define LAUNCH_JOBKEY_MACHSERVICELOOKUPPOLICIES "MachServiceLookupPolicies"
	65	#define LAUNCH_JOBKEY_INETDCOMPATIBILITY "inetdCompatibility"
	66	#define LAUNCH_JOBKEY_ENABLEGLOBBING "EnableGlobbing"
	67	#define LAUNCH_JOBKEY_PROGRAMARGUMENTS "ProgramArguments"
	68	#define LAUNCH_JOBKEY_PROGRAM "Program"
	69	#define LAUNCH_JOBKEY_ONDEMAND "OnDemand"
	70	#define LAUNCH_JOBKEY_KEEPALIVE "KeepAlive"
	71	#define LAUNCH_JOBKEY_LIMITLOADTOHOSTS "LimitLoadToHosts"
	72	#define LAUNCH_JOBKEY_LIMITLOADFROMHOSTS "LimitLoadFromHosts"
	73	#define LAUNCH_JOBKEY_LIMITLOADTOSESSIONTYPE "LimitLoadToSessionType"
	74	#define LAUNCH_JOBKEY_RUNATLOAD "RunAtLoad"
	75	#define LAUNCH_JOBKEY_ROOTDIRECTORY "RootDirectory"
	76	#define LAUNCH_JOBKEY_WORKINGDIRECTORY "WorkingDirectory"
	77	#define LAUNCH_JOBKEY_ENVIRONMENTVARIABLES "EnvironmentVariables"
	78	#define LAUNCH_JOBKEY_USERENVIRONMENTVARIABLES "UserEnvironmentVariables"
	79	#define LAUNCH_JOBKEY_UMASK "Umask"
	80	#define LAUNCH_JOBKEY_NICE "Nice"
	81	#define LAUNCH_JOBKEY_HOPEFULLYEXITSFIRST "HopefullyExitsFirst"
	82	#define LAUNCH_JOBKEY_HOPEFULLYEXITSLAST "HopefullyExitsLast"
	83	#define LAUNCH_JOBKEY_LOWPRIORITYIO "LowPriorityIO"
	84	#define LAUNCH_JOBKEY_SESSIONCREATE "SessionCreate"
	85	#define LAUNCH_JOBKEY_STARTONMOUNT "StartOnMount"
	86	#define LAUNCH_JOBKEY_SOFTRESOURCELIMITS "SoftResourceLimits"
	87	#define LAUNCH_JOBKEY_HARDRESOURCELIMITS "HardResourceLimits"
	88	#define LAUNCH_JOBKEY_STANDARDINPATH "StandardInPath"
	89	#define LAUNCH_JOBKEY_STANDARDOUTPATH "StandardOutPath"
	90	#define LAUNCH_JOBKEY_STANDARDERRORPATH "StandardErrorPath"
	91	#define LAUNCH_JOBKEY_DEBUG "Debug"
	92	#define LAUNCH_JOBKEY_WAITFORDEBUGGER "WaitForDebugger"
	93	#define LAUNCH_JOBKEY_QUEUEDIRECTORIES "QueueDirectories"
	94	#define LAUNCH_JOBKEY_WATCHPATHS "WatchPaths"
	95	#define LAUNCH_JOBKEY_STARTINTERVAL "StartInterval"
	96	#define LAUNCH_JOBKEY_STARTCALENDARINTERVAL "StartCalendarInterval"
	97	#define LAUNCH_JOBKEY_BONJOURFDS "BonjourFDs"
	98	#define LAUNCH_JOBKEY_LASTEXITSTATUS "LastExitStatus"
	99	#define LAUNCH_JOBKEY_PID "PID"
	100	#define LAUNCH_JOBKEY_THROTTLEINTERVAL "ThrottleInterval"
	101	#define LAUNCH_JOBKEY_LAUNCHONLYONCE "LaunchOnlyOnce"
	102	#define LAUNCH_JOBKEY_ABANDONPROCESSGROUP "AbandonProcessGroup"
	103	#define LAUNCH_JOBKEY_IGNOREPROCESSGROUPATSHUTDOWN "IgnoreProcessGroupAtShutdown"
	104	#define LAUNCH_JOBKEY_POLICIES "Policies"
	105	#define LAUNCH_JOBKEY_ENABLETRANSACTIONS "EnableTransactions"
	106
	107	#define LAUNCH_JOBPOLICY_DENYCREATINGOTHERJOBS "DenyCreatingOtherJobs"
	108
	109	#define LAUNCH_JOBINETDCOMPATIBILITY_WAIT "Wait"
	110
111	#define LAUNCH_JOBKEY_MACH_RESETATCLOSE "ResetAtClose"
112	#define LAUNCH_JOBKEY_MACH_HIDEUNTILCHECKIN "HideUntilCheckIn"
113	#define LAUNCH_JOBKEY_MACH_DRAINMESSAGESONCRASH "DrainMessagesOnCrash"
114
115	#define LAUNCH_JOBKEY_KEEPALIVE_SUCCESSFULEXIT "SuccessfulExit"
116	#define LAUNCH_JOBKEY_KEEPALIVE_NETWORKSTATE "NetworkState"
117	#define LAUNCH_JOBKEY_KEEPALIVE_PATHSTATE "PathState"
118	#define LAUNCH_JOBKEY_KEEPALIVE_OTHERJOBACTIVE "OtherJobActive"
119	#define LAUNCH_JOBKEY_KEEPALIVE_OTHERJOBENABLED "OtherJobEnabled"
120	#define LAUNCH_JOBKEY_KEEPALIVE_AFTERINITIALDEMAND "AfterInitialDemand"
121
122	#define LAUNCH_JOBKEY_CAL_MINUTE "Minute"
123	#define LAUNCH_JOBKEY_CAL_HOUR "Hour"
124	#define LAUNCH_JOBKEY_CAL_DAY "Day"
125	#define LAUNCH_JOBKEY_CAL_WEEKDAY "Weekday"
126	#define LAUNCH_JOBKEY_CAL_MONTH "Month"
127
128	#define LAUNCH_JOBKEY_RESOURCELIMIT_CORE "Core"
129	#define LAUNCH_JOBKEY_RESOURCELIMIT_CPU "CPU"
130	#define LAUNCH_JOBKEY_RESOURCELIMIT_DATA "Data"
131	#define LAUNCH_JOBKEY_RESOURCELIMIT_FSIZE "FileSize"
132	#define LAUNCH_JOBKEY_RESOURCELIMIT_MEMLOCK "MemoryLock"
133	#define LAUNCH_JOBKEY_RESOURCELIMIT_NOFILE "NumberOfFiles"
134	#define LAUNCH_JOBKEY_RESOURCELIMIT_NPROC "NumberOfProcesses"
135	#define LAUNCH_JOBKEY_RESOURCELIMIT_RSS "ResidentSetSize"
136	#define LAUNCH_JOBKEY_RESOURCELIMIT_STACK "Stack"
137
138	#define LAUNCH_JOBKEY_DISABLED_MACHINETYPE "MachineType"
139	#define LAUNCH_JOBKEY_DISABLED_MODELNAME "ModelName"
140
141	#define LAUNCH_JOBSOCKETKEY_TYPE "SockType"
142	#define LAUNCH_JOBSOCKETKEY_PASSIVE "SockPassive"
143	#define LAUNCH_JOBSOCKETKEY_BONJOUR "Bonjour"
144	#define LAUNCH_JOBSOCKETKEY_SECUREWITHKEY "SecureSocketWithKey"
145	#define LAUNCH_JOBSOCKETKEY_PATHNAME "SockPathName"
146	#define LAUNCH_JOBSOCKETKEY_PATHMODE "SockPathMode"
147	#define LAUNCH_JOBSOCKETKEY_NODENAME "SockNodeName"
148	#define LAUNCH_JOBSOCKETKEY_SERVICENAME "SockServiceName"
149	#define LAUNCH_JOBSOCKETKEY_FAMILY "SockFamily"
150	#define LAUNCH_JOBSOCKETKEY_PROTOCOL "SockProtocol"
151	#define LAUNCH_JOBSOCKETKEY_MULTICASTGROUP "MulticastGroup"
e91b9f68 A	152
	153	typedef struct _launch_data *launch_data_t;
	154
	155	typedef enum {
	156	LAUNCH_DATA_DICTIONARY = 1,
	157	LAUNCH_DATA_ARRAY,
	158	LAUNCH_DATA_FD,
	159	LAUNCH_DATA_INTEGER,
	160	LAUNCH_DATA_REAL,
	161	LAUNCH_DATA_BOOL,
	162	LAUNCH_DATA_STRING,
	163	LAUNCH_DATA_OPAQUE,
	164	LAUNCH_DATA_ERRNO,
ed34e3c3	165	LAUNCH_DATA_MACHPORT,
e91b9f68 A	166	} launch_data_type_t;
e91b9f68 A	167
ed34e3c3 A	168	launch_data_t launch_data_alloc(launch_data_type_t) __ld_allocator;
	169	launch_data_t launch_data_copy(launch_data_t) __ld_allocator;
	170	launch_data_type_t launch_data_get_type(const launch_data_t) __ld_getter;
	171	void launch_data_free(launch_data_t) __ld_setter;
e91b9f68 A	172
	173	/* Generic Dictionaries */
	174	/* the value should not be changed while iterating */
ed34e3c3 A	175	bool launch_data_dict_insert(launch_data_t, const launch_data_t, const char *) __ld_setter;
	176	launch_data_t launch_data_dict_lookup(const launch_data_t, const char *) __ld_getter;
	177	bool launch_data_dict_remove(launch_data_t, const char *) __ld_setter;
	178	void launch_data_dict_iterate(const launch_data_t, void ()(const launch_data_t, const char , void ), void ) __ld_iterator(1, 2);
	179	size_t launch_data_dict_get_count(const launch_data_t) __ld_getter;
e91b9f68 A	180
e91b9f68 A	181	/* Generic Arrays */
ed34e3c3 A	182	bool launch_data_array_set_index(launch_data_t, const launch_data_t, size_t) __ld_setter;
	183	launch_data_t launch_data_array_get_index(const launch_data_t, size_t) __ld_getter;
	184	size_t launch_data_array_get_count(const launch_data_t) __ld_getter;
	185
	186	launch_data_t launch_data_new_fd(int) __ld_allocator;
	187	launch_data_t launch_data_new_machport(mach_port_t) __ld_allocator;
	188	launch_data_t launch_data_new_integer(long long) __ld_allocator;
	189	launch_data_t launch_data_new_bool(bool) __ld_allocator;
	190	launch_data_t launch_data_new_real(double) __ld_allocator;
	191	launch_data_t launch_data_new_string(const char *) __ld_allocator;
	192	launch_data_t launch_data_new_opaque(const void *, size_t) __ld_allocator;
	193
	194	bool launch_data_set_fd(launch_data_t, int) __ld_setter;
	195	bool launch_data_set_machport(launch_data_t, mach_port_t) __ld_setter;
	196	bool launch_data_set_integer(launch_data_t, long long) __ld_setter;
	197	bool launch_data_set_bool(launch_data_t, bool) __ld_setter;
	198	bool launch_data_set_real(launch_data_t, double) __ld_setter;
	199	bool launch_data_set_string(launch_data_t, const char *) __ld_setter;
	200	bool launch_data_set_opaque(launch_data_t, const void *, size_t) __ld_setter;
	201
	202	int launch_data_get_fd(const launch_data_t) __ld_getter;
	203	mach_port_t launch_data_get_machport(const launch_data_t) __ld_getter;
	204	long long launch_data_get_integer(const launch_data_t) __ld_getter;
	205	bool launch_data_get_bool(const launch_data_t) __ld_getter;
	206	double launch_data_get_real(const launch_data_t) __ld_getter;
	207	const char * launch_data_get_string(const launch_data_t) __ld_getter;
	208	void * launch_data_get_opaque(const launch_data_t) __ld_getter;
	209	size_t launch_data_get_opaque_size(const launch_data_t) __ld_getter;
	210	int launch_data_get_errno(const launch_data_t) __ld_getter;
e91b9f68 A	211
	212
	213	/* launch_get_fd()
	214	*
	215	* Use this to get the FD if you're doing asynchronous I/O with select(),
	216	* poll() or kevent().
	217	*/
ed34e3c3	218	int launch_get_fd(void) __ld_normal;
e91b9f68 A	219
	220	/* launch_msg()
	221	*
	222	* Use this API to send and receive messages.
	223	* Calling launch_msg() with no message to send is a valid way to get
	224	* asynchronously received messages.
	225	*
	226	* If a message was to be sent, it returns NULL and errno on failure.
	227	*
	228	* If no messages were to be sent, it returns NULL and errno is set to zero if
	229	* no more asynchronous messages are available.
	230	*/
ed34e3c3 A	231	launch_data_t launch_msg(const launch_data_t) __ld_normal;
	232
	233	__END_DECLS
e91b9f68	234
5b0a4722 A	235	#pragma GCC visibility pop
5b0a4722 A	236
e91b9f68	237	#endif