Class: Plist4r::PlistType::Launchd

Examples:

Reference

hard_resource_limits do
  core <integer>
  # The largest size (in bytes) core file that may be created.

  cpu <integer>
  # The maximum amount of cpu time (in seconds) to be used by each process.

  data <integer>
  # The maximum size (in bytes) of the data segment for a process; this defines how far a 
  # program may extend its break with the sbrk(2) system call.

  file_size <integer>
  # The largest size (in bytes) file that may be created.

  memory_lock <integer>
  # The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.

  number_of_files <integer>
  # The maximum number of open files for this process.  Setting this value in a system wide 
  # daemon will set the sysctl(3) kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc
  # (HardResourceLimits) value in addition to the setrlimit(2) values.

  number_of_processes <integer>
  # The maximum number of simultaneous processes for this user id.  Setting this value in a 
  # system wide daemon will set the sysctl(3) kern.maxproc (SoftResource-Limits) or 
  # kern.maxprocperuid (HardResourceLimits) value in addition to the setrlimit(2) values.

  resident_set_size <integer>
  # The maximum size (in bytes) to which a process's resident set size may grow.  This imposes 
  # a limit on the amount of physical memory to be given to a process; if memory is tight, the 
  # system will prefer to take memory from processes that are exceeding their declared resident 
  # set size.

  stack <integer>
  # The maximum size (in bytes) of the stack segment for a process; this defines how far a 
  # program's stack segment may be extended.  Stack extension is performed automatically 
  # by the system.
end

Example

# Set hard resource limits
hard_resource_limits do
  NumberOfProcesses 4
  NumberOfFiles 512
end

# Return hard resource limits
hard_resource_limits => { "NumberOfProcesses" => 4, "NumberOfFiles" => 512 }

Examples:

# set inetdCompatibility
launchd_plist.inetd_compatibility { wait true }

# return inetdCompatibility
launchd_plist.inetd_compatibility => hash or nil

Examples:

# set KeepAlive (boolean)

launchd_plist.keep_alive(true)
launchd_plist.keep_alive(false)

# return KeepAlive
launchd_plist.keep_alive => true, false, Hash, or nil

# set KeepAlive (hash of values)

launchd_plist.keep_alive do
  successful_exit true
  network_state false
  path_state { "/path1" => true, "/path2" => false }
  other_job_enabled { "notifyd" => true, "syslogd" => true }
end

Examples:

Reference

mach_services do
  reset_at_close <boolean>
  # If this boolean is false, the port is recycled, thus leaving clients to remain oblivious 
  # to the demand nature of job. If the value is set to true, clients receive port death 
  # notifications when the job lets go of the receive right. The port will be recreated 
  # atomically with respect to bootstrap_look_up() calls, so that clients can trust that 
  # after receiving a port death notification, the new port will have already been recreated. 
  # Setting the value to true should be done with care. Not all clients may be able to handle 
  # this behavior. The default value is false.

  hide_until_check_in <boolean>
  # Reserve the name in the namespace, but cause bootstrap_look_up() to fail until the job 
  # has checked in with launchd.
end

Example

# Set mach services
mach_services do
  add "com.apple.afpfs_checkafp", true
end

mach_services do
  add "com.apple.AppleFileServer" do
    hide_until_check_in true
    reset_at_close false
  end
end

Examples:

Reference

socket "socket_key" do
  sock_type <string>
  # This optional key tells launchctl what type of socket to create. The default is "stream" 
  # and other valid values for this key are "dgram" and "seqpacket" respectively.

  sock_passive <boolean>
  # This optional key specifies whether listen(2) or connect(2) should be called on the 
  # created file descriptor. The default is true ("to listen").

  sock_node_name <string>
  # This optional key specifies the node to connect(2) or bind(2) to.

  sock_service_name <string>
  # This optional key specifies the service on the node to connect(2) or bind(2) to.

  sock_family <string>
  # This optional key can be used to specifically request that "IPv4" or "IPv6" socket(s) be 
  # created.

  sock_protocol <string>
  # This optional key specifies the protocol to be passed to socket(2).  The only value 
  # understood by this key at the moment is "TCP".

  sock_path_name <string>
  # This optional key implies SockFamily is set to "Unix". It specifies the path to 
  # connect(2) or bind(2) to.

  secure_socket_with_key <string>
  # This optional key is a variant of SockPathName. Instead of binding to a known path, 
  # a securely generated socket is created and the path is assigned to the environment 
  # variable that is inherited by all jobs spawned by launchd.

  sock_path_mode <integer>
  # This optional key specifies the mode of the socket. Known bug: Property lists don't 
  # support octal, so please convert the value to decimal.

  bonjour <boolean or string or array of strings>
  # This optional key can be used to request that the service be registered with the 
  # mDNSResponder(8).  If the value is boolean, the service name is inferred from
  # the SockServiceName.

  multicast_group <string>
  # This optional key can be used to request that the datagram socket join a multicast 
  # group.  If the value is a hostname, then getaddrinfo(3) will be used to join the 
  # correct multicast address for a given socket family.  If an explicit IPv4 or IPv6 
  # address is given, it is required that the SockFamily family also be set, otherwise 
  # the results are undefined.
end

Example

# Method construct
socket(socket_key="Listeners") { block_of_keys }
socket(socket_key="Listeners", socket_index) { block_of_keys }
socket -> hash or nil

# Write this socket to index [0]. Creates an *array* of sockets
# This array is held within the default sockets key name, "Listeners"
launchd_plist.socket 0 do
  sock_service_name "netbios-ssn"
end

# Add a new socket called "netbios". Creates a *dictionary* of sockets
launchd_plist.socket "netbios" do
  sock_service_name "netbios"
  bonjour ['smb']
end

# Inspect all the sockets structure afterward (recommended)
puts launchd_plist.socket.inspect

Correct Usage, and Erroneous usage

# scenario 1:
 socket do
   sock_service_name "netbios-ssn"
 end
# => Result: Ok. The default "Listeners" toplevel key is generated implicitly.

# scenario 2:
 socket do
   sock_service_name "netbios-ssn"
 end
 socket do
   sock_service_name "netbios"
   bonjour ['smb']
 end
# => Result: Exception error is raise the second time because the "Listeners" key already 
# exists. We can forcefully overwrite this existing sockets key with +socket "Listeners" do+.

# scenario 3:
 socket "netbios-ssn" do
   sock_service_name "netbios-ssn"
 end
 socket "netbios" do
   sock_service_name "netbios"
   bonjour ['smb']
 end
=> Result: Ok. Each Sockets entry has a unique key.

# scenario 4:
 socket 0 do
   sock_service_name "netbios-ssn"
 end
 socket 1 do
   sock_service_name "netbios"
   bonjour ['smb']
 end
# => Result: Ok. Each Sockets entry has a unique array index. The array of all these sockets 
# is held within the default "Listeners" key (implicit array or sockets).

# scenario 5:
 socket do
   sock_service_name "netbios-ssn"
 end
 socket[0] do
   sock_service_name "netbios"
   bonjour ['smb']
 end
# => Result: Exception error. because we cant mix and match types with the implicit 
# "Listeners" key. If in doubt then avoid using the arrays.

NOTE: Accessing the default sockets

# Sockets is a complex structure. When manupilating an existing Sockets entry, (the second
# time around), we must fully specify the key to modify. This is usually achieved simply 
# specifying the implicit "Listeners" key name.

# For example, if we created a socket with
socket do
  # ...
end

# is accessed as 
socket "Listeners" do
  # ...
end

# or if an array of sockets
socket 0 do
  # ...
end

# in reality becomes
socket "Listeners" 0 do
  # ...
end

Examples:

Reference

soft_resource_limits do
  core <integer>
  # The largest size (in bytes) core file that may be created.

  cpu <integer>
  # The maximum amount of cpu time (in seconds) to be used by each process.

  data <integer>
  # The maximum size (in bytes) of the data segment for a process; this defines how far a 
  # program may extend its break with the sbrk(2) system call.

  file_size <integer>
  # The largest size (in bytes) file that may be created.

  memory_lock <integer>
  # The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.

  number_of_files <integer>
  # The maximum number of open files for this process.  Setting this value in a system wide 
  # daemon will set the sysctl(3) kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc
  # (HardResourceLimits) value in addition to the setrlimit(2) values.

  number_of_processes <integer>
  # The maximum number of simultaneous processes for this user id.  Setting this value in a 
  # system wide daemon will set the sysctl(3) kern.maxproc (SoftResource-Limits) or 
  # kern.maxprocperuid (HardResourceLimits) value in addition to the setrlimit(2) values.

  resident_set_size <integer>
  # The maximum size (in bytes) to which a process's resident set size may grow.  This imposes 
  # a limit on the amount of physical memory to be given to a process; if memory is tight, the 
  # system will prefer to take memory from processes that are exceeding their declared resident 
  # set size.

  stack <integer>
  # The maximum size (in bytes) of the stack segment for a process; this defines how far a 
  # program's stack segment may be extended.  Stack extension is performed automatically 
  # by the system.
end

Example

# Set soft resource limits
soft_resource_limits do
  NumberOfProcesses 4
  NumberOfFiles 512
end

# Return soft resource limits
soft_resource_limits => { "NumberOfProcesses" => 4, "NumberOfFiles" => 512 }

Examples:

Reference

start_calendar_interval index=nil do
  minute <integer>
  # The minute on which this job will be run.

  hour <integer>
  # The hour on which this job will be run.

  day <integer>
  # The day on which this job will be run.

  weekday <integer>
  # The weekday on which this job will be run (0 and 7 are Sunday).

  month <integer>
  # The month on which this job will be run.
end

Example

# Set start calendar interval

launchd_plist.start_calendar_interval 0 do
  hour   02
  minute 05
  day    06
end

launchd_plist.start_calendar_interval 1 do
  hour   10
  minute 30
end

launchd_plist.start_calendar_interval do
  month 3
end

# Return start calendar interval
launchd_plist.start_calendar_interval[1] => { "Hour" => 10, "Minute" => 30 }
launchd_plist.start_calendar_interval.last => { "Month" => 3 }