XPC objects | Uğur Toprakdeviren

API Collection | XPC

Encapsulate data in objects that represent primitive types, collections, and more.

Objects

xpc_object_t typealias xpc_object_t — A type that can describe all XPC objects, including dictionaries, arrays, strings, and numbers.
xpc_type_t typealias xpc_type_t — A type that describes XPC object types.
OS_xpc_object protocol OS_xpc_object — The interface for an XPC object.
OS_xpc_listener class OS_xpc_listener —

Identity

xpc_get_type(_:)) func xpc_get_type(xpc_object_t) -> xpc_type_t — Returns the type of an object.
xpc_type_get_name(_:)) func xpc_type_get_name(xpc_type_t) -> UnsafePointer<CChar> — Returns a string that describes an XPC object type.
xpc_hash(_:)) func xpc_hash(xpc_object_t) -> Int — Calculates a hash value for the specified object.

Comparison

xpc_equal(_:_:)) func xpc_equal(xpc_object_t, xpc_object_t) -> Bool — Compares two objects for equality.

Copying

xpc_copy(_:)) func xpc_copy(xpc_object_t) -> xpc_object_t? — Creates a copy of the object.
xpc_copy_description(_:)) func xpc_copy_description(xpc_object_t) -> UnsafeMutablePointer<CChar> — Copies a debug string that describes the object.

Boolean objects

xpc_bool_create(_:)) func xpc_bool_create(Bool) -> xpc_object_t — Creates an XPC Boolean object.
xpc_bool_get_value(_:)) func xpc_bool_get_value(xpc_object_t) -> Bool — Returns the underlying Boolean value from the object.
XPC_BOOL_TRUE var XPC_BOOL_TRUE: xpc_object_t — A constant that represents a Boolean value of true.
XPC_BOOL_FALSE var XPC_BOOL_FALSE: xpc_object_t — A constant that represents a Boolean value of false.

Data objects

xpc_data_create(_:_:)) func xpc_data_create(UnsafeRawPointer?, Int) -> xpc_object_t — Creates an XPC object that represents a buffer of bytes.
xpc_data_create_with_dispatch_data(_:)) func xpc_data_create_with_dispatch_data(dispatch_data_t) -> xpc_object_t — Creates an XPC object that represents a buffer of bytes that the specified GCD data object describes.
xpc_data_get_bytes(_:_:_:_:)) func xpc_data_get_bytes(xpc_object_t, UnsafeMutableRawPointer, Int, Int) -> Int — Copies the bytes in a data object into the specified buffer.
xpc_data_get_bytes_ptr(_:)) func xpc_data_get_bytes_ptr(xpc_object_t) -> UnsafeRawPointer? — Returns a pointer to the internal storage of a data object.
xpc_data_get_length(_:)) func xpc_data_get_length(xpc_object_t) -> Int — Returns the length of the data that an XPC data object encapsulates.

Number objects

xpc_double_create(_:)) func xpc_double_create(Double) -> xpc_object_t — Creates an XPC double object.
xpc_double_get_value(_:)) func xpc_double_get_value(xpc_object_t) -> Double — Returns the underlying double-precision floating point value from an object.
xpc_int64_create(_:)) func xpc_int64_create(Int64) -> xpc_object_t — Creates an XPC signed integer object.
xpc_int64_get_value(_:)) func xpc_int64_get_value(xpc_object_t) -> Int64 — Returns the underlying signed 64-bit integer value from an object.
xpc_uint64_create(_:)) func xpc_uint64_create(UInt64) -> xpc_object_t — Creates an XPC unsigned integer object.
xpc_uint64_get_value(_:)) func xpc_uint64_get_value(xpc_object_t) -> UInt64 — Returns the underlying unsigned 64-bit integer value from an object.

Array objects

XPCArray struct XPCArray — An ordered random-access collection of XPC objects.
xpc_array_create(_:_:)) func xpc_array_create(UnsafePointer<xpc_object_t>?, Int) -> xpc_object_t — Creates an XPC object that represents an array of XPC objects.
xpc_array_create_empty()) func xpc_array_create_empty() -> xpc_object_t — Creates an XPC object that represents an array of XPC objects.
xpc_array_create_connection(_:_:)) func xpc_array_create_connection(xpc_object_t, Int) -> xpc_connection_t? — Creates a connection object from an array directly.
xpc_array_set_value(_:_:_:)) func xpc_array_set_value(xpc_object_t, Int, xpc_object_t) — Inserts the specified object into the array at the specified index.
xpc_array_get_value(_:_:)) func xpc_array_get_value(xpc_object_t, Int) -> xpc_object_t — Returns the value at the specified index in the array.
xpc_array_append_value(_:_:)) func xpc_array_append_value(xpc_object_t, xpc_object_t) — Appends an object to an XPC array.
xpc_array_get_count(_:)) func xpc_array_get_count(xpc_object_t) -> Int — Returns the count of values in the array.
xpc_array_apply(_:_:)) func xpc_array_apply(xpc_object_t, (Int, xpc_object_t) -> Bool) -> Bool — Invokes the specified block for every value in the array.
xpc_array_dup_fd(_:_:)) func xpc_array_dup_fd(xpc_object_t, Int) -> Int32 — Gets a file descriptor from an array directly.
xpc_array_get_array(_:_:)) func xpc_array_get_array(xpc_object_t, Int) -> xpc_object_t? — Returns the array at the specified index in the array.
xpc_array_get_bool(_:_:)) func xpc_array_get_bool(xpc_object_t, Int) -> Bool — Gets a Boolean primitive value from an array directly.
xpc_array_get_data(_:_:_:)) func xpc_array_get_data(xpc_object_t, Int, UnsafeMutablePointer<Int>?) -> UnsafeRawPointer? — Gets a pointer to the raw bytes of a data object from an array directly.
xpc_array_get_date(_:_:)) func xpc_array_get_date(xpc_object_t, Int) -> Int64 — Gets a date interval from an array directly.
xpc_array_get_dictionary(_:_:)) func xpc_array_get_dictionary(xpc_object_t, Int) -> xpc_object_t? — Returns the dictionary at the specified index in the array.
xpc_array_get_double(_:_:)) func xpc_array_get_double(xpc_object_t, Int) -> Double — Gets a double-precision floating point primitive value from an array directly.
xpc_array_get_int64(_:_:)) func xpc_array_get_int64(xpc_object_t, Int) -> Int64 — Gets a 64-bit integer primitive value from an array directly.
xpc_array_get_string(_:_:)) func xpc_array_get_string(xpc_object_t, Int) -> UnsafePointer<CChar>? — Gets a C-string value from an array directly.
xpc_array_get_uint64(_:_:)) func xpc_array_get_uint64(xpc_object_t, Int) -> UInt64 — Gets a 64-bit unsigned integer primitive value from an array directly.
xpc_array_get_uuid(_:_:)) func xpc_array_get_uuid(xpc_object_t, Int) -> UnsafePointer<UInt8>? — Gets a UUID value from an array directly.
xpc_array_set_bool(_:_:_:)) func xpc_array_set_bool(xpc_object_t, Int, Bool) — Inserts a Boolean primitive value into an array.
xpc_array_set_connection(_:_:_:)) func xpc_array_set_connection(xpc_object_t, Int, xpc_connection_t) — Inserts a connection into an array.
xpc_array_set_data(_:_:_:_:)) func xpc_array_set_data(xpc_object_t, Int, UnsafeRawPointer?, Int) — Inserts a raw data value into an array.
xpc_array_set_date(_:_:_:)) func xpc_array_set_date(xpc_object_t, Int, Int64) — Inserts a date value into an array.
xpc_array_set_double(_:_:_:)) func xpc_array_set_double(xpc_object_t, Int, Double) — Inserts a double-precision floating point primitive value into an array.
xpc_array_set_fd(_:_:_:)) func xpc_array_set_fd(xpc_object_t, Int, Int32) — Inserts a file descriptor into an array.
xpc_array_set_int64(_:_:_:)) func xpc_array_set_int64(xpc_object_t, Int, Int64) — Inserts a 64-bit integer primitive value into an array.
xpc_array_set_string(_:_:_:)) func xpc_array_set_string(xpc_object_t, Int, UnsafePointer<CChar>) — Inserts a C-string into an array.
xpc_array_set_uint64(_:_:_:)) func xpc_array_set_uint64(xpc_object_t, Int, UInt64) — Inserts a 64-bit unsigned integer primitive value into an array.
xpc_array_set_uuid(_:_:_:)) func xpc_array_set_uuid(xpc_object_t, Int, UnsafePointer<UInt8>) — Inserts a UUID primitive value into an array.
xpc_array_applier_t typealias xpc_array_applier_t — A block to invoke for every value in the array.
XPC_ARRAY_APPEND var XPC_ARRAY_APPEND: size_t — A constant to pass as the destination index to the class of primitive XPC array setters indicating that the specified primitive needs to append to the array.

Dictionary objects

XPCDictionary struct XPCDictionary — A type that contains key-value pairs, notably used as the container of messages between a client and listener.
xpc_dictionary_create(_:_:_:)) func xpc_dictionary_create(UnsafePointer<UnsafePointer<CChar>>?, UnsafePointer<xpc_object_t?>?, Int) -> xpc_object_t — Creates an XPC object that represents a dictionary of XPC objects keyed to C-strings.
xpc_dictionary_create_empty()) func xpc_dictionary_create_empty() -> xpc_object_t — Creates an XPC object that represents a dictionary of XPC objects keyed to C-strings.
xpc_dictionary_create_connection(_:_:)) func xpc_dictionary_create_connection(xpc_object_t, UnsafePointer<CChar>) -> xpc_connection_t? — Creates a connection from a dictionary directly.
xpc_dictionary_create_reply(_:)) func xpc_dictionary_create_reply(xpc_object_t) -> xpc_object_t? — Creates a dictionary that is in reply to the specified dictionary.
xpc_dictionary_set_value(_:_:_:)) func xpc_dictionary_set_value(xpc_object_t, UnsafePointer<CChar>, xpc_object_t?) — Sets the value for the specified key to the specified object.
xpc_dictionary_get_count(_:)) func xpc_dictionary_get_count(xpc_object_t) -> Int — Returns the number of values in the dictionary.
xpc_dictionary_get_value(_:_:)) func xpc_dictionary_get_value(xpc_object_t, UnsafePointer<CChar>) -> xpc_object_t? — Returns the value for the specified key.
xpc_dictionary_apply(_:_:)) func xpc_dictionary_apply(xpc_object_t, (UnsafePointer<CChar>, xpc_object_t) -> Bool) -> Bool — Invokes the specified block for every key-value pair in the dictionary.
xpc_dictionary_dup_fd(_:_:)) func xpc_dictionary_dup_fd(xpc_object_t, UnsafePointer<CChar>) -> Int32 — Creates a file descriptor from a dictionary directly.
xpc_dictionary_get_array(_:_:)) func xpc_dictionary_get_array(xpc_object_t, UnsafePointer<CChar>) -> xpc_object_t? — Returns the array value for the specified key.
xpc_dictionary_get_bool(_:_:)) func xpc_dictionary_get_bool(xpc_object_t, UnsafePointer<CChar>) -> Bool — Gets a Boolean primitive value from a dictionary directly.
xpc_dictionary_get_data(_:_:_:)) func xpc_dictionary_get_data(xpc_object_t, UnsafePointer<CChar>, UnsafeMutablePointer<Int>?) -> UnsafeRawPointer? — Gets a raw data value from a dictionary directly.
xpc_dictionary_get_date(_:_:)) func xpc_dictionary_get_date(xpc_object_t, UnsafePointer<CChar>) -> Int64 — Gets a date value from a dictionary directly.
xpc_dictionary_get_dictionary(_:_:)) func xpc_dictionary_get_dictionary(xpc_object_t, UnsafePointer<CChar>) -> xpc_object_t? — Returns the dictionary value for the specified key.
xpc_dictionary_get_double(_:_:)) func xpc_dictionary_get_double(xpc_object_t, UnsafePointer<CChar>) -> Double — Gets a double-precision floating point primitive value from a dictionary directly.
xpc_dictionary_get_int64(_:_:)) func xpc_dictionary_get_int64(xpc_object_t, UnsafePointer<CChar>) -> Int64 — Gets a 64-bit integer primitive value from a dictionary directly.
xpc_dictionary_get_remote_connection(_:)) func xpc_dictionary_get_remote_connection(xpc_object_t) -> xpc_connection_t? — Returns the connection that receives the dictionary.
xpc_dictionary_get_string(_:_:)) func xpc_dictionary_get_string(xpc_object_t, UnsafePointer<CChar>) -> UnsafePointer<CChar>? — Gets a C-string value from a dictionary directly.
xpc_dictionary_get_uint64(_:_:)) func xpc_dictionary_get_uint64(xpc_object_t, UnsafePointer<CChar>) -> UInt64 — Gets a 64-bit unsigned integer primitive value from a dictionary directly.
xpc_dictionary_get_uuid(_:_:)) func xpc_dictionary_get_uuid(xpc_object_t, UnsafePointer<CChar>) -> UnsafePointer<UInt8>? — Gets a UUID value from a dictionary directly.
xpc_dictionary_set_bool(_:_:_:)) func xpc_dictionary_set_bool(xpc_object_t, UnsafePointer<CChar>, Bool) — Inserts a Boolean primitive value into a dictionary.
xpc_dictionary_set_connection(_:_:_:)) func xpc_dictionary_set_connection(xpc_object_t, UnsafePointer<CChar>, xpc_connection_t) — Inserts a connection into a dictionary.
xpc_dictionary_set_data(_:_:_:_:)) func xpc_dictionary_set_data(xpc_object_t, UnsafePointer<CChar>, UnsafeRawPointer?, Int) — Inserts a raw data value into a dictionary.
xpc_dictionary_set_date(_:_:_:)) func xpc_dictionary_set_date(xpc_object_t, UnsafePointer<CChar>, Int64) — Inserts a date primitive value into a dictionary.
xpc_dictionary_set_double(_:_:_:)) func xpc_dictionary_set_double(xpc_object_t, UnsafePointer<CChar>, Double) — Inserts a double-precision floating point primitive value into a dictionary.
xpc_dictionary_set_fd(_:_:_:)) func xpc_dictionary_set_fd(xpc_object_t, UnsafePointer<CChar>, Int32) — Inserts a file descriptor into a dictionary.
xpc_dictionary_set_int64(_:_:_:)) func xpc_dictionary_set_int64(xpc_object_t, UnsafePointer<CChar>, Int64) — Inserts a 64-bit integer primitive value into a dictionary.
xpc_dictionary_set_string(_:_:_:)) func xpc_dictionary_set_string(xpc_object_t, UnsafePointer<CChar>, UnsafePointer<CChar>) — Inserts a C-string value into a dictionary.
xpc_dictionary_set_uint64(_:_:_:)) func xpc_dictionary_set_uint64(xpc_object_t, UnsafePointer<CChar>, UInt64) — Inserts a 64-bit unsigned integer primitive value into a dictionary.
xpc_dictionary_set_uuid(_:_:_:)) func xpc_dictionary_set_uuid(xpc_object_t, UnsafePointer<CChar>, UnsafePointer<UInt8>) — Inserts a UUID primitive value into an array.
xpc_dictionary_applier_t typealias xpc_dictionary_applier_t — A block to invoke for every key-value pair in the dictionary.
xpc_dictionary_copy_mach_send(_:_:)) func xpc_dictionary_copy_mach_send(xpc_object_t, UnsafePointer<CChar>) -> mach_port_t —
xpc_dictionary_set_mach_send(_:_:_:)) func xpc_dictionary_set_mach_send(xpc_object_t, UnsafePointer<CChar>, mach_port_t) —

String objects

xpc_string_create(_:)) func xpc_string_create(UnsafePointer<CChar>) -> xpc_object_t — Creates an XPC object that represents a null-terminated C-string.
xpc_string_create_with_format_and_arguments(_:_:)) func xpc_string_create_with_format_and_arguments(UnsafePointer<CChar>, CVaListPointer) -> xpc_object_t — Creates an XPC object that represents a C-string that the specified format string and argument list pointer generate.
xpc_string_get_length(_:)) func xpc_string_get_length(xpc_object_t) -> Int — Returns the length of the underlying string.
xpc_string_get_string_ptr(_:)) func xpc_string_get_string_ptr(xpc_object_t) -> UnsafePointer<CChar>? — Returns a pointer to the internal storage of a string object.

File Descriptor objects

xpc_fd_create(_:)) func xpc_fd_create(Int32) -> xpc_object_t? — Creates an XPC object that represents a POSIX file descriptor.
xpc_fd_dup(_:)) func xpc_fd_dup(xpc_object_t) -> Int32 — Returns a file descriptor that is equivalent to the one that the specified file descriptor object boxes.

Date objects

xpc_date_create(_:)) func xpc_date_create(Int64) -> xpc_object_t — Creates an XPC date object.
xpc_date_create_from_current()) func xpc_date_create_from_current() -> xpc_object_t — Creates an XPC date object that represents the current date.
xpc_date_get_value(_:)) func xpc_date_get_value(xpc_object_t) -> Int64 — Returns the underlying date interval from an object.

UUID objects

xpc_uuid_create(_:)) func xpc_uuid_create(UnsafePointer<UInt8>) -> xpc_object_t — Creates an XPC object that represents a universally unique identifier (UUID).
xpc_uuid_get_bytes(_:)) func xpc_uuid_get_bytes(xpc_object_t) -> UnsafePointer<UInt8>? — Copies the UUID that an XPC UUID object boxes into the specified UUID buffer.

Shared memory objects

xpc_shmem_create(_:_:)) func xpc_shmem_create(UnsafeMutableRawPointer, Int) -> xpc_object_t — Creates an XPC object that represents the specified shared memory region.
xpc_shmem_map(_:_:)) func xpc_shmem_map(xpc_object_t, UnsafeMutablePointer<UnsafeMutableRawPointer?>) -> Int — Maps the region that the XPC shared memory object boxes into the caller’s address space.

Null objects

xpc_null_create()) func xpc_null_create() -> xpc_object_t — Creates an XPC object that represents the null object.

Object life cycle

xpc_retain(_:)) func xpc_retain(xpc_object_t) -> xpc_object_t —
xpc_release(_:)) func xpc_release(xpc_object_t) —

Types of objects

XPC_TYPE_ACTIVITY var XPC_TYPE_ACTIVITY: xpc_type_t — A type that represents the XPC activity object.
XPC_TYPE_ARRAY var XPC_TYPE_ARRAY: xpc_type_t — A type that represents an array of XPC objects.
XPC_TYPE_BOOL var XPC_TYPE_BOOL: xpc_type_t — A type that represents a Boolean value.
XPC_TYPE_CONNECTION var XPC_TYPE_CONNECTION: xpc_type_t — A type that represents a connection to a named service.
XPC_TYPE_DATA var XPC_TYPE_DATA: xpc_type_t — A type that represents an arbitrary buffer of bytes.
XPC_TYPE_DATE var XPC_TYPE_DATE: xpc_type_t — A type that represents a date interval.
XPC_TYPE_DICTIONARY var XPC_TYPE_DICTIONARY: xpc_type_t — A type that represents a dictionary of XPC objects keyed off of C-strings.
XPC_TYPE_DOUBLE var XPC_TYPE_DOUBLE: xpc_type_t — A type that represents an IEEE-compliant, double-precision floating point value.
XPC_TYPE_ENDPOINT var XPC_TYPE_ENDPOINT: xpc_type_t — A type that represents a connection in serialized form.
XPC_TYPE_FD var XPC_TYPE_FD: xpc_type_t — A type that represents a POSIX file descriptor.
XPC_TYPE_INT64 var XPC_TYPE_INT64: xpc_type_t — A type that represents a signed, 64-bit integer value.
XPC_TYPE_NULL var XPC_TYPE_NULL: xpc_type_t — A type that represents a null object.
XPC_TYPE_SHMEM var XPC_TYPE_SHMEM: xpc_type_t — A type that represents a region of shared memory.
XPC_TYPE_STRING var XPC_TYPE_STRING: xpc_type_t — A type that represents a null-terminated C-string.
XPC_TYPE_UINT64 var XPC_TYPE_UINT64: xpc_type_t — A type that represents an unsigned, 64-bit integer value.
XPC_TYPE_UUID var XPC_TYPE_UUID: xpc_type_t — A type that represents a universally unique identifier.

Errors

XPCRichError struct XPCRichError — An error that contains a description and indicates if you can retry the operation that caused the error.
XPC_TYPE_RICH_ERROR var XPC_TYPE_RICH_ERROR: xpc_type_t — A type that represents a rich error object.
XPC_TYPE_ERROR var XPC_TYPE_ERROR: xpc_type_t — A type that represents an error object.
XPC_ERROR_KEY_DESCRIPTION let XPC_ERROR_KEY_DESCRIPTION: UnsafePointer<CChar> — A key for querying an error dictionary to retrieve a string with a human-readable description of the error.
XPC_ERROR_PEER_CODE_SIGNING_REQUIREMENT var XPC_ERROR_PEER_CODE_SIGNING_REQUIREMENT: xpc_object_t —

OS_xpc_listener

Class | XPC

class OS_xpc_listener

Relationships

Inherits From

OS_object

Conforms To

OS_xpc_object

Protocol | XPC

The interface for an XPC object.

protocol OS_xpc_object : NSObjectProtocol

Relationships

Inherits From

NSObjectProtocol

XPC_ARRAY_APPEND

Global Variable | XPC

A constant to pass as the destination index to the class of primitive XPC array setters indicating that the specified primitive needs to append to the array.

var XPC_ARRAY_APPEND: size_t { get }

xpc_array_append_value(_:_:)

Function | XPC

Appends an object to an XPC array.

func xpc_array_append_value(_ xarray: xpc_object_t, _ value: xpc_object_t)

Parameters

xarray: The array object which is to be manipulated.
value: The object to append. This object is retained by the array.

xpc_array_applier_t

Type Alias | XPC

A block to invoke for every value in the array.

typealias xpc_array_applier_t = (Int, xpc_object_t) -> Bool

A Boolean indicating whether iteration should continue.

Parameters

index: The current index in the iteration.
value: The current value in the iteration.

xpc_array_create(_:_:)

Function | XPC

Creates an XPC object that represents an array of XPC objects.

func xpc_array_create(_ objects: UnsafePointer<xpc_object_t>?, _ count: Int) -> xpc_object_t

A new array object.

Parameters

objects: An array of XPC objects which is to be boxed. The order of this array is preserved in the object. If this array contains a NULL value, the behavior is undefined. This parameter may be NULL only if the count is 0.
count: The number of objects in the given array. If the number passed is less than the actual number of values in the array, only the specified number of items are inserted into the resulting array. If the number passed is more than the the actual number of values, the behavior is undefined.

xpc_array_create_connection(_:_:)

Function | XPC

Creates a connection object from an array directly.

func xpc_array_create_connection(_ xarray: xpc_object_t, _ index: Int) -> xpc_connection_t?

A new connection created from the value at the specified index. You are responsible for calling xpc_release on the returned connection. NULL if the value at the specified index is not an endpoint containing a connection. Each call to this method for the same index in the same array will yield a different connection. See xpc_connection_create_from_endpoint(_:)) for discussion as to the responsibilities when dealing with the returned connection.

Parameters

xarray: The array which is to be examined.
index: The index of the value to obtain. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array). If the index is outside that range, the behavior is undefined.

xpc_array_apply(_:_:)

Function | XPC

Invokes the specified block for every value in the array.

func xpc_array_apply(_ xarray: xpc_object_t, _ applier: (Int, xpc_object_t) -> Bool) -> Bool

A Boolean indicating whether iteration of the array completed successfully. Iteration will only fail if the applier block returns false.

Parameters

xarray: The array object which is to be examined.
applier: The block which this function applies to every element in the array.

xpc_array_create_empty()

Function | XPC

Creates an XPC object that represents an array of XPC objects.

func xpc_array_create_empty() -> xpc_object_t

A new array object.

xpc_array_get_array(_:_:)

Function | XPC

Returns the array at the specified index in the array.

func xpc_array_get_array(_ xarray: xpc_object_t, _ index: Int) -> xpc_object_t?

The object at the specified index within the array or NULL if the given object was not an XPC array or if the the value at the specified index was not an array.

Parameters

xarray: The array object which is to be examined.
index: The index of the value to obtain. This value must lie within the range of indexes as specified in xpc_array_set_value(_:_:_:)).

xpc_array_dup_fd(_:_:)

Function | XPC

Gets a file descriptor from an array directly.

func xpc_array_dup_fd(_ xarray: xpc_object_t, _ index: Int) -> Int32

A new file descriptor created from the value at the specified index. You are responsible for closing this descriptor. -1 if the value at the specified index is not a file descriptor value.

Parameters

xarray: The array which is to be examined.
index: The index of the value to obtain. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array). If the index is outside that range, the behavior is undefined.

xpc_array_get_count(_:)

Function | XPC

Returns the count of values in the array.

func xpc_array_get_count(_ xarray: xpc_object_t) -> Int

The count of values in the array.

Parameters

xarray: The array object which is to be examined.

xpc_array_get_bool(_:_:)

Function | XPC

Gets a Boolean primitive value from an array directly.

func xpc_array_get_bool(_ xarray: xpc_object_t, _ index: Int) -> Bool

The underlying bool value at the specified index. false if the value at the specified index is not a Boolean value.

Parameters

xarray: The array which is to be examined.
index: The index of the value to obtain. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array). If the index is outside that range, the behavior is undefined.

xpc_array_get_data(_:_:_:)

Function | XPC

Gets a pointer to the raw bytes of a data object from an array directly.

func xpc_array_get_data(_ xarray: xpc_object_t, _ index: Int, _ length: UnsafeMutablePointer<Int>?) -> UnsafeRawPointer?

The underlying bytes at the specified index. NULL if the value at the specified index is not a data value.

Parameters

xarray: The array which is to be examined.
index: The index of the value to obtain. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array). If the index is outside that range, the behavior is undefined.
length: Upon return output, will contain the length of the data corresponding to the specified key.

xpc_array_get_dictionary(_:_:)

Function | XPC

Returns the dictionary at the specified index in the array.

func xpc_array_get_dictionary(_ xarray: xpc_object_t, _ index: Int) -> xpc_object_t?

The object at the specified index within the array or NULL if the given object was not an XPC array or if the the value at the specified index was not a dictionary.

Parameters

xarray: The array object which is to be examined.
index: The index of the value to obtain. This value must lie within the range of indexes as specified in xpc_array_set_value(_:_:_:)).

xpc_array_get_date(_:_:)

Function | XPC

Gets a date interval from an array directly.

func xpc_array_get_date(_ xarray: xpc_object_t, _ index: Int) -> Int64

The underlying date interval at the specified index. 0 if the value at the specified index is not a date value.

Parameters

xarray: The array which is to be examined.
index: The index of the value to obtain. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array). If the index is outside that range, the behavior is undefined.

xpc_array_get_double(_:_:)

Function | XPC

Gets a double-precision floating point primitive value from an array directly.

func xpc_array_get_double(_ xarray: xpc_object_t, _ index: Int) -> Double

The underlying double value at the specified index. NAN if the value at the specified index is not a floating point value.

Parameters

xarray: The array which is to be examined.
index: The index of the value to obtain. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array). If the index is outside that range, the behavior is undefined.

xpc_array_get_int64(_:_:)

Function | XPC

Gets a 64-bit integer primitive value from an array directly.

func xpc_array_get_int64(_ xarray: xpc_object_t, _ index: Int) -> Int64

The underlying int64_t value at the specified index. 0 if the value at the specified index is not a signed integer value.

Parameters

xarray: The array which is to be examined.
index: The index of the value to obtain. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array). If the index is outside that range, the behavior is undefined.

xpc_array_get_uint64(_:_:)

Function | XPC

Gets a 64-bit unsigned integer primitive value from an array directly.

func xpc_array_get_uint64(_ xarray: xpc_object_t, _ index: Int) -> UInt64

The underlying uint64_t value at the specified index. 0 if the value at the specified index is not an unsigned integer value.

Parameters

xarray: The array which is to be examined.
index: The index of the value to obtain. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array). If the index is outside that range, the behavior is undefined.

xpc_array_get_string(_:_:)

Function | XPC

Gets a C-string value from an array directly.

func xpc_array_get_string(_ xarray: xpc_object_t, _ index: Int) -> UnsafePointer<CChar>?

The underlying C string at the specified index. NULL if the value at the specified index is not a C string value.

Parameters

xarray: The array which is to be examined.
index: The index of the value to obtain. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array). If the index is outside that range, the behavior is undefined.

xpc_array_get_uuid(_:_:)

Function | XPC

Gets a UUID value from an array directly.

func xpc_array_get_uuid(_ xarray: xpc_object_t, _ index: Int) -> UnsafePointer<UInt8>?

The underlying uuid_t value at the specified index. The null UUID if the value at the specified index is not a UUID value. The returned pointer may be safely passed to the uuid(3) APIs.

Parameters

xarray: The array which is to be examined.
index: The index of the value to obtain. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array). If the index is outside that range, the behavior is undefined.

xpc_array_get_value(_:_:)

Function | XPC

Returns the value at the specified index in the array.

func xpc_array_get_value(_ xarray: xpc_object_t, _ index: Int) -> xpc_object_t

The object at the specified index within the array.

Parameters

xarray: The array object which is to be examined.
index: The index of the value to obtain. This value must lie within the range of indexes as specified in xpc_array_set_value(_:_:_:)).

xpc_array_set_bool(_:_:_:)

Function | XPC

Inserts a Boolean primitive value into an array.

func xpc_array_set_bool(_ xarray: xpc_object_t, _ index: Int, _ value: Bool)

Parameters

xarray: The array object which is to be manipulated.
index: The index at which to insert the value. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array) or be XPC_ARRAY_APPEND. If the index is outside that range, the behavior is undefined.
value: The bool value to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_array_get_value(_:_:)).

xpc_array_set_connection(_:_:_:)

Function | XPC

Inserts a connection into an array.

func xpc_array_set_connection(_ xarray: xpc_object_t, _ index: Int, _ connection: xpc_connection_t)

Parameters

xarray: The array object which is to be manipulated.
index: The index at which to insert the value. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array) or be XPC_ARRAY_APPEND. If the index is outside that range, the behavior is undefined.
connection: The connection to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_array_get_value(_:_:)). The connection is NOT retained by the array.

xpc_array_set_data(_:_:_:_:)

Function | XPC

Inserts a raw data value into an array.

func xpc_array_set_data(_ xarray: xpc_object_t, _ index: Int, _ bytes: UnsafeRawPointer?, _ length: Int)

Parameters

xarray: The array object which is to be manipulated.
index: The index at which to insert the value. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array) or be XPC_ARRAY_APPEND. If the index is outside that range, the behavior is undefined.
bytes: The raw data to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_array_get_value(_:_:)).
length: The length of the data.

xpc_array_set_date(_:_:_:)

Function | XPC

Inserts a date value into an array.

func xpc_array_set_date(_ xarray: xpc_object_t, _ index: Int, _ value: Int64)

Parameters

xarray: The array object which is to be manipulated.
index: The index at which to insert the value. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array) or be XPC_ARRAY_APPEND. If the index is outside that range, the behavior is undefined.
value: The double value to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_array_get_value(_:_:)).

xpc_array_set_fd(_:_:_:)

Function | XPC

Inserts a file descriptor into an array.

func xpc_array_set_fd(_ xarray: xpc_object_t, _ index: Int, _ fd: Int32)

Parameters

xarray: The array object which is to be manipulated.
index: The index at which to insert the value. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array) or be XPC_ARRAY_APPEND. If the index is outside that range, the behavior is undefined.
fd: The file descriptor to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_array_get_value(_:_:)).

xpc_array_set_double(_:_:_:)

Function | XPC

Inserts a double-precision floating point primitive value into an array.

func xpc_array_set_double(_ xarray: xpc_object_t, _ index: Int, _ value: Double)

Parameters

xarray: The array object which is to be manipulated.
index: The index at which to insert the value. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array) or be XPC_ARRAY_APPEND. If the index is outside that range, the behavior is undefined.
value: The double value to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_array_get_value(_:_:)).

xpc_array_set_int64(_:_:_:)

Function | XPC

Inserts a 64-bit integer primitive value into an array.

func xpc_array_set_int64(_ xarray: xpc_object_t, _ index: Int, _ value: Int64)

Parameters

xarray: The array object which is to be manipulated.
index: The index at which to insert the value. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array) or be XPC_ARRAY_APPEND. If the index is outside that range, the behavior is undefined.
value: The int64_t value to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_array_get_value(_:_:)).

xpc_array_set_string(_:_:_:)

Function | XPC

Inserts a C-string into an array.

func xpc_array_set_string(_ xarray: xpc_object_t, _ index: Int, _ string: UnsafePointer<CChar>)

Parameters

xarray: The array object which is to be manipulated.
index: The index at which to insert the value. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array) or be XPC_ARRAY_APPEND. If the index is outside that range, the behavior is undefined.
string: The C string to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_array_get_value(_:_:)).

xpc_array_set_uint64(_:_:_:)

Function | XPC

Inserts a 64-bit unsigned integer primitive value into an array.

func xpc_array_set_uint64(_ xarray: xpc_object_t, _ index: Int, _ value: UInt64)

Parameters

xarray: The array object which is to be manipulated.
index: The index at which to insert the value. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array) or be XPC_ARRAY_APPEND. If the index is outside that range, the behavior is undefined.
value: The uint64_t value to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_array_get_value(_:_:)).

xpc_array_set_uuid(_:_:_:)

Function | XPC

Inserts a UUID primitive value into an array.

func xpc_array_set_uuid(_ xarray: xpc_object_t, _ index: Int, _ uuid: UnsafePointer<UInt8>)

Parameters

xarray: The array object which is to be manipulated.
index: The index at which to insert the value. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array) or be XPC_ARRAY_APPEND. If the index is outside that range, the behavior is undefined.
uuid: The UUID primitive to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_array_get_value(_:_:)).

xpc_array_set_value(_:_:_:)

Function | XPC

Inserts the specified object into the array at the specified index.

func xpc_array_set_value(_ xarray: xpc_object_t, _ index: Int, _ value: xpc_object_t)

Parameters

xarray: The array object which is to be manipulated.
index: The index at which to insert the value. This value must lie within the index space of the array (0 to N-1 inclusive, where N is the count of the array). If the index is outside that range, the behavior is undefined.
value: The object to insert. This value is retained by the array and cannot be NULL. If there is already a value at the specified index, it is released, and the new value is inserted in its place.

XPC_BOOL_FALSE

Global Variable | XPC

A constant that represents a Boolean value of false.

var XPC_BOOL_FALSE: xpc_object_t { get }

You may compare a Boolean object against this constant to determine its value.

xpc_bool_create(_:)

Function | XPC

Creates an XPC Boolean object.

func xpc_bool_create(_ value: Bool) -> xpc_object_t

A new Boolean object.

Parameters

value: The Boolean primitive value which is to be boxed.

XPC_BOOL_TRUE

Global Variable | XPC

A constant that represents a Boolean value of true.

var XPC_BOOL_TRUE: xpc_object_t { get }

You may compare a Boolean object against this constant to determine its value.

xpc_bool_get_value(_:)

Function | XPC

Returns the underlying Boolean value from the object.

func xpc_bool_get_value(_ xbool: xpc_object_t) -> Bool

The underlying Boolean value.

Parameters

xbool: The Boolean object which is to be examined.

xpc_copy(_:)

Function | XPC

Creates a copy of the object.

func xpc_copy(_ object: xpc_object_t) -> xpc_object_t?

The new object. NULL if the object type does not support copying or if sufficient memory for the copy could not be allocated. Service objects do not support copying.

Parameters

object: The object to copy.

xpc_data_create(_:_:)

Function | XPC

Creates an XPC object that represents a buffer of bytes.

func xpc_data_create(_ bytes: UnsafeRawPointer?, _ length: Int) -> xpc_object_t

A new data object.

Parameters

bytes: The buffer of bytes which is to be boxed. You may create an empty data object by passing NULL for this parameter and 0 for the length. Passing NULL with any other length will result in undefined behavior.
length: The number of bytes which are to be boxed.

xpc_copy_description(_:)

Function | XPC

Copies a debug string that describes the object.

func xpc_copy_description(_ object: xpc_object_t) -> UnsafeMutablePointer<CChar>

A string describing object which contains information useful for debugging. This string should be disposed of with free(3) when done.

Parameters

object: The object which is to be examined.

xpc_data_get_bytes(_:_:_:_:)

Function | XPC

Copies the bytes in a data object into the specified buffer.

func xpc_data_get_bytes(_ xdata: xpc_object_t, _ buffer: UnsafeMutableRawPointer, _ off: Int, _ length: Int) -> Int

The number of bytes that were copied into the buffer.

Parameters

xdata: The data object which is to be examined.
buffer: The buffer in which to copy the data object’s bytes.
off: The offset at which to begin the copy. If this offset is greater than the length of the data element, nothing is copied. Pass 0 to start the copy at the beginning of the buffer.
length: The length of the destination buffer.

xpc_data_create_with_dispatch_data(_:)

Function | XPC

Creates an XPC object that represents a buffer of bytes that the specified GCD data object describes.

func xpc_data_create_with_dispatch_data(_ ddata: dispatch_data_t) -> xpc_object_t

A new data object.

Parameters

ddata: The GCD data object containing the bytes which are to be boxed. This object is retained by the data object.

xpc_data_get_bytes_ptr(_:)

Function | XPC

Returns a pointer to the internal storage of a data object.

func xpc_data_get_bytes_ptr(_ xdata: xpc_object_t) -> UnsafeRawPointer?

A pointer to the underlying boxed data.

Parameters

xdata: The data object which is to be examined.

xpc_data_get_length(_:)

Function | XPC

Returns the length of the data that an XPC data object encapsulates.

func xpc_data_get_length(_ xdata: xpc_object_t) -> Int

The length of the underlying boxed data.

Parameters

xdata: The data object which is to be examined.

xpc_date_create_from_current()

Function | XPC

Creates an XPC date object that represents the current date.

func xpc_date_create_from_current() -> xpc_object_t

A new date object representing the current date.

xpc_date_create(_:)

Function | XPC

Creates an XPC date object.

func xpc_date_create(_ interval: Int64) -> xpc_object_t

A new date object.

Parameters

interval: The date interval which is to be boxed. Negative values indicate the number of nanoseconds before the epoch. Positive values indicate the number of nanoseconds after the epoch.

xpc_dictionary_applier_t

Type Alias | XPC

A block to invoke for every key-value pair in the dictionary.

typealias xpc_dictionary_applier_t = (UnsafePointer<CChar>, xpc_object_t) -> Bool

A Boolean indicating whether iteration should continue.

Parameters

key: The current key in the iteration.
value: The current value in the iteration.

xpc_dictionary_apply(_:_:)

Function | XPC

Invokes the specified block for every key-value pair in the dictionary.

func xpc_dictionary_apply(_ xdict: xpc_object_t, _ applier: (UnsafePointer<CChar>, xpc_object_t) -> Bool) -> Bool

A Boolean indicating whether iteration of the dictionary completed successfully. Iteration will only fail if the applier block returns false.

Parameters

xdict: The dictionary object which is to be examined.
applier: The block which this function applies to every key/value pair in the dictionary.

xpc_date_get_value(_:)

Function | XPC

Returns the underlying date interval from an object.

func xpc_date_get_value(_ xdate: xpc_object_t) -> Int64

The underlying date interval.

Parameters

xdate: The date object which is to be examined.

xpc_dictionary_copy_mach_send(_:_:)

Function | XPC

func xpc_dictionary_copy_mach_send(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> mach_port_t

xpc_dictionary_create(_:_:_:)

Function | XPC

Creates an XPC object that represents a dictionary of XPC objects keyed to C-strings.

func xpc_dictionary_create(_ keys: UnsafePointer<UnsafePointer<CChar>>?, _ values: UnsafePointer<xpc_object_t?>?, _ count: Int) -> xpc_object_t

The new dictionary object.

Parameters

keys: An array of C-strings that are to be the keys for the values to be inserted. Each element of this array is copied into the dictionary’s internal storage. If any element of this array is NULL, the behavior is undefined.
values: A C-array that is parallel to the array of keys, consisting of objects that are to be inserted. Each element in this array is retained. Elements in this array may be NULL.
count: The number of key/value pairs in the given arrays. If the count is less than the actual count of values, only that many key/value pairs will be inserted into the dictionary.

If the count is more than the the actual count of key/value pairs, the behavior is undefined. If one array is NULL and the other is not, the behavior is undefined. If both arrays are NULL and the count is non-0, the behavior is undefined.

xpc_dictionary_create_connection(_:_:)

Function | XPC

Creates a connection from a dictionary directly.

func xpc_dictionary_create_connection(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> xpc_connection_t?

A new connection created from the value for the specified key. You are responsible for calling xpc_release on the returned connection. NULL if the value for the specified key is not an endpoint containing a connection or if there is no value for the specified key. Each call to this method for the same key in the same dictionary will yield a different connection. See xpc_connection_create_from_endpoint(_:)) for discussion as to the responsibilities when dealing with the returned connection.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_create_empty()

Function | XPC

Creates an XPC object that represents a dictionary of XPC objects keyed to C-strings.

func xpc_dictionary_create_empty() -> xpc_object_t

The new dictionary object.

xpc_dictionary_create_reply(_:)

Function | XPC

Creates a dictionary that is in reply to the specified dictionary.

func xpc_dictionary_create_reply(_ original: xpc_object_t) -> xpc_object_t?

The new dictionary object. NULL if the dictionary did not come from the wire with a reply context.

Parameters

original: The original dictionary that is to be replied to.

xpc_dictionary_dup_fd(_:_:)

Function | XPC

Creates a file descriptor from a dictionary directly.

func xpc_dictionary_dup_fd(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> Int32

A new file descriptor created from the value for the specified key. You are responsible for closing this descriptor. -1 if the value for the specified key is not a file descriptor value or if there is no value for the specified key.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_get_array(_:_:)

Function | XPC

Returns the array value for the specified key.

func xpc_dictionary_get_array(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> xpc_object_t?

The object for the specified key within the dictionary. NULL if there is no value associated with the specified key, if the given object was not an XPC dictionary, or if the object for the specified key is not an array.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_get_bool(_:_:)

Function | XPC

Gets a Boolean primitive value from a dictionary directly.

func xpc_dictionary_get_bool(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> Bool

The underlying bool value for the specified key. false if the the value for the specified key is not a Boolean value or if there is no value for the specified key.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_get_count(_:)

Function | XPC

Returns the number of values in the dictionary.

func xpc_dictionary_get_count(_ xdict: xpc_object_t) -> Int

The number of values stored in the dictionary. Calling xpc_dictionary_set_value(_:_:_:)) with a non-NULL value will increment the count. Calling xpc_dictionary_set_value(_:_:_:)) with a NULL value will decrement the count.

Parameters

xdict: The dictionary object which is to be examined.

xpc_dictionary_get_data(_:_:_:)

Function | XPC

Gets a raw data value from a dictionary directly.

func xpc_dictionary_get_data(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ length: UnsafeMutablePointer<Int>?) -> UnsafeRawPointer?

The underlying raw data for the specified key. NULL if the value for the specified key is not a data value or if there is no value for the specified key.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.
length: For the data type, the third parameter, upon output, will contain the length of the data corresponding to the specified key.

xpc_dictionary_get_date(_:_:)

Function | XPC

Gets a date value from a dictionary directly.

func xpc_dictionary_get_date(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> Int64

The underlying date interval for the specified key. 0 if the value for the specified key is not a date value or if there is no value for the specified key.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_get_dictionary(_:_:)

Function | XPC

Returns the dictionary value for the specified key.

func xpc_dictionary_get_dictionary(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> xpc_object_t?

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_get_double(_:_:)

Function | XPC

Gets a double-precision floating point primitive value from a dictionary directly.

func xpc_dictionary_get_double(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> Double

The underlying double value for the specified key. NAN if the value for the specified key is not a floating point value or if there is no value for the specified key.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_get_int64(_:_:)

Function | XPC

Gets a 64-bit integer primitive value from a dictionary directly.

func xpc_dictionary_get_int64(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> Int64

The underlying int64_t value for the specified key. 0 if the value for the specified key is not a signed integer value or if there is no value for the specified key.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_get_remote_connection(_:)

Function | XPC

Returns the connection that receives the dictionary.

func xpc_dictionary_get_remote_connection(_ xdict: xpc_object_t) -> xpc_connection_t?

If the dictionary was received by a connection event handler or a dictionary created through xpc_dictionary_create_reply(_:)), a connection object over which a reply message can be sent is returned. For any other dictionary, NULL is returned.

Parameters

xdict: The dictionary object which is to be examined.

xpc_dictionary_get_string(_:_:)

Function | XPC

Gets a C-string value from a dictionary directly.

func xpc_dictionary_get_string(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> UnsafePointer<CChar>?

The underlying C string for the specified key. NULL if the value for the specified key is not a C string value or if there is no value for the specified key.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_get_uint64(_:_:)

Function | XPC

Gets a 64-bit unsigned integer primitive value from a dictionary directly.

func xpc_dictionary_get_uint64(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> UInt64

The underlying uint64_t value for the specified key. 0 if the value for the specified key is not an unsigned integer value or if there is no value for the specified key.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_get_uuid(_:_:)

Function | XPC

Gets a UUID value from a dictionary directly.

func xpc_dictionary_get_uuid(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> UnsafePointer<UInt8>?

The underlying uuid_t value for the specified key. NULL is the value at the specified index is not a UUID value. The returned pointer may be safely passed to the uuid(3) APIs.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_get_value(_:_:)

Function | XPC

Returns the value for the specified key.

func xpc_dictionary_get_value(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>) -> xpc_object_t?

The object for the specified key within the dictionary. NULL if there is no value associated with the specified key.

Parameters

xdict: The dictionary object which is to be examined.
key: The key whose value is to be obtained.

xpc_dictionary_set_connection(_:_:_:)

Function | XPC

Inserts a connection into a dictionary.

func xpc_dictionary_set_connection(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ connection: xpc_connection_t)

Parameters

xdict: The dictionary which is to be manipulated.
key: The key for which the primitive value shall be set.
connection: The connection to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_dictionary_get_value(_:_:)). The connection is NOT retained by the dictionary.

xpc_dictionary_set_bool(_:_:_:)

Function | XPC

Inserts a Boolean primitive value into a dictionary.

func xpc_dictionary_set_bool(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ value: Bool)

Parameters

xdict: The dictionary which is to be manipulated.
key: The key for which the primitive value shall be set.
value: The bool value to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_dictionary_get_value(_:_:)).

xpc_dictionary_set_data(_:_:_:_:)

Function | XPC

Inserts a raw data value into a dictionary.

func xpc_dictionary_set_data(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ bytes: UnsafeRawPointer?, _ length: Int)

Parameters

xdict: The dictionary which is to be manipulated.
key: The key for which the primitive value shall be set.
bytes: The bytes to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_dictionary_get_value(_:_:)).
length: The length of the data.

xpc_dictionary_set_date(_:_:_:)

Function | XPC

Inserts a date primitive value into a dictionary.

func xpc_dictionary_set_date(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ value: Int64)

Parameters

xdict: The dictionary which is to be manipulated.
key: The key for which the primitive value shall be set.
value: The date value to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_dictionary_get_value(_:_:)).

xpc_dictionary_set_fd(_:_:_:)

Function | XPC

Inserts a file descriptor into a dictionary.

func xpc_dictionary_set_fd(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ fd: Int32)

Parameters

xdict: The dictionary which is to be manipulated.
key: The key for which the primitive value shall be set.
fd: The file descriptor to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_dictionary_get_value(_:_:)).

xpc_dictionary_set_double(_:_:_:)

Function | XPC

Inserts a double-precision floating point primitive value into a dictionary.

func xpc_dictionary_set_double(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ value: Double)

Parameters

xdict: The dictionary which is to be manipulated.
key: The key for which the primitive value shall be set.
value: The double value to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_dictionary_get_value(_:_:)).

xpc_dictionary_set_int64(_:_:_:)

Function | XPC

Inserts a 64-bit integer primitive value into a dictionary.

func xpc_dictionary_set_int64(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ value: Int64)

Parameters

xdict: The dictionary which is to be manipulated.
key: The key for which the primitive value shall be set.
value: The int64_t value to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_dictionary_get_value(_:_:)).

xpc_dictionary_set_mach_send(_:_:_:)

Function | XPC

func xpc_dictionary_set_mach_send(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ p: mach_port_t)

xpc_dictionary_set_string(_:_:_:)

Function | XPC

Inserts a C-string value into a dictionary.

func xpc_dictionary_set_string(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ string: UnsafePointer<CChar>)

Parameters

xdict: The dictionary which is to be manipulated.
key: The key for which the primitive value shall be set.
string: The C string to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_dictionary_get_value(_:_:)).

xpc_dictionary_set_uint64(_:_:_:)

Function | XPC

Inserts a 64-bit unsigned integer primitive value into a dictionary.

func xpc_dictionary_set_uint64(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ value: UInt64)

Parameters

xdict: The dictionary which is to be manipulated.
key: The key for which the primitive value shall be set.
value: The uint64_t value to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_dictionary_get_value(_:_:)).

xpc_dictionary_set_uuid(_:_:_:)

Function | XPC

Inserts a UUID primitive value into an array.

func xpc_dictionary_set_uuid(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ uuid: UnsafePointer<UInt8>)

Parameters

xdict: The dictionary which is to be manipulated.
key: The key for which the primitive value shall be set.
uuid: The uuid_t value to insert. After calling this method, the XPC object corresponding to the primitive value inserted may be safely retrieved with xpc_dictionary_get_value(_:_:)).

xpc_dictionary_set_value(_:_:_:)

Function | XPC

Sets the value for the specified key to the specified object.

func xpc_dictionary_set_value(_ xdict: xpc_object_t, _ key: UnsafePointer<CChar>, _ value: xpc_object_t?)

Parameters

xdict: The dictionary object which is to be manipulated.
key: The key for which the value shall be set.
value: The object to insert. The object is retained by the dictionary. If there already exists a value for the specified key, the old value is released and overwritten by the new value. This parameter may be NULL, in which case the value corresponding to the specified key is deleted if present.

xpc_double_create(_:)

Function | XPC

Creates an XPC double object.

func xpc_double_create(_ value: Double) -> xpc_object_t

A new floating point object.

Parameters

value: The floating point quantity which is to be boxed.

xpc_double_get_value(_:)

Function | XPC

Returns the underlying double-precision floating point value from an object.

func xpc_double_get_value(_ xdouble: xpc_object_t) -> Double

The underlying floating point value.

Parameters

xdouble: The floating point object which is to be examined.

xpc_equal(_:_:)

Function | XPC

Compares two objects for equality.

func xpc_equal(_ object1: xpc_object_t, _ object2: xpc_object_t) -> Bool

Returns true if the objects are equal, otherwise false. Two objects must be of the same type in order to be equal.

Parameters

object1: The first object to compare.
object2: The second object to compare.

XPC_ERROR_KEY_DESCRIPTION

Global Variable | XPC

A key for querying an error dictionary to retrieve a string with a human-readable description of the error.

nonisolated(unsafe) let XPC_ERROR_KEY_DESCRIPTION: UnsafePointer<CChar>

XPC_ERROR_PEER_CODE_SIGNING_REQUIREMENT

Global Variable | XPC

var XPC_ERROR_PEER_CODE_SIGNING_REQUIREMENT: xpc_object_t { get }

xpc_fd_create(_:)

Function | XPC

Creates an XPC object that represents a POSIX file descriptor.

func xpc_fd_create(_ fd: Int32) -> xpc_object_t?

A new file descriptor object. NULL if sufficient memory could not be allocated or if the given file descriptor was not valid.

Parameters

fd: The file descriptor which is to be boxed.

xpc_fd_dup(_:)

Function | XPC

Returns a file descriptor that is equivalent to the one that the specified file descriptor object boxes.

func xpc_fd_dup(_ xfd: xpc_object_t) -> Int32

A file descriptor that is equivalent to the one originally given to xpc_fd_create(_:)). If the descriptor could not be created, -1 is returned.

Parameters

xfd: The file descriptor object which is to be examined.

xpc_get_type(_:)

Function | XPC

Returns the type of an object.

func xpc_get_type(_ object: xpc_object_t) -> xpc_type_t

An opaque pointer describing the type of the object. This pointer is suitable for direct comparison to exported type constants with the equality operator.

Parameters

object: The object to examine.

xpc_hash(_:)

Function | XPC

Calculates a hash value for the specified object.

func xpc_hash(_ object: xpc_object_t) -> Int

The calculated hash value.

Parameters

object: The object for which to calculate a hash value. This value may be modded with a table size for insertion into a dictionary-like data structure.

xpc_int64_create(_:)

Function | XPC

Creates an XPC signed integer object.

func xpc_int64_create(_ value: Int64) -> xpc_object_t

A new signed integer object.

Parameters

value: The signed integer value which is to be boxed.

xpc_int64_get_value(_:)

Function | XPC

Returns the underlying signed 64-bit integer value from an object.

func xpc_int64_get_value(_ xint: xpc_object_t) -> Int64

The underlying signed 64-bit value.

Parameters

xint: The signed integer object which is to be examined.

xpc_null_create()

Function | XPC

Creates an XPC object that represents the null object.

func xpc_null_create() -> xpc_object_t

A new null object.

xpc_object_t

Type Alias | XPC

A type that can describe all XPC objects, including dictionaries, arrays, strings, and numbers.

typealias xpc_object_t = any OS_xpc_object

XPC objects are created with a retain count of 1, and therefore it is the caller’s responsibility to call xpc_release on them when they are no longer needed.

xpc_release(_:)

Function | XPC

func xpc_release(_ object: xpc_object_t)

xpc_retain(_:)

Function | XPC

func xpc_retain(_ object: xpc_object_t) -> xpc_object_t

xpc_shmem_create(_:_:)

Function | XPC

Creates an XPC object that represents the specified shared memory region.

func xpc_shmem_create(_ region: UnsafeMutableRawPointer, _ length: Int) -> xpc_object_t

A new shared memory object.

Parameters

region: A pointer to a region of shared memory, created through a call to mmap(2) with the MAP_SHARED flag, which is to be boxed.
length: The length of the region.

xpc_shmem_map(_:_:)

Function | XPC

Maps the region that the XPC shared memory object boxes into the caller’s address space.

func xpc_shmem_map(_ xshmem: xpc_object_t, _ region: UnsafeMutablePointer<UnsafeMutableRawPointer?>) -> Int

The length of the region that was mapped. If the mapping failed, 0 is returned.

Parameters

xshmem: The shared memory object to be examined.
region: On return, this will point to the region at which the shared memory was mapped.

xpc_string_create(_:)

Function | XPC

Creates an XPC object that represents a null-terminated C-string.

func xpc_string_create(_ string: UnsafePointer<CChar>) -> xpc_object_t

A new string object.

Parameters

string: The C-string which is to be boxed.

xpc_string_create_with_format_and_arguments(_:_:)

Function | XPC

Creates an XPC object that represents a C-string that the specified format string and argument list pointer generate.

func xpc_string_create_with_format_and_arguments(_ fmt: UnsafePointer<CChar>, _ ap: CVaListPointer) -> xpc_object_t

A new string object.

Parameters

fmt: The printf(3)-style format string from which to construct the final C-string to be boxed.
ap: A pointer to the arguments which correspond to those specified in the format string.

xpc_string_get_length(_:)

Function | XPC

Returns the length of the underlying string.

func xpc_string_get_length(_ xstring: xpc_object_t) -> Int

The length of the underlying string, not including the NULL-terminator.

Parameters

xstring: The string object which is to be examined.

XPC_TYPE_ACTIVITY

Global Variable | XPC

A type that represents the XPC activity object.

var XPC_TYPE_ACTIVITY: xpc_type_t { get }

xpc_string_get_string_ptr(_:)

Function | XPC

Returns a pointer to the internal storage of a string object.

func xpc_string_get_string_ptr(_ xstring: xpc_object_t) -> UnsafePointer<CChar>?

A pointer to the string object’s internal storage.

Parameters

xstring: The string object which is to be examined.

XPC_TYPE_ARRAY

Global Variable | XPC

A type that represents an array of XPC objects.

var XPC_TYPE_ARRAY: xpc_type_t { get }

This array must be contiguous, that is, it can’t contain NULL values. If you want to indicate that a slot is empty, you can insert a null object. The array grows as necessary to accommodate more objects.

XPC_TYPE_BOOL

Global Variable | XPC

A type that represents a Boolean value.

var XPC_TYPE_BOOL: xpc_type_t { get }

XPC_TYPE_CONNECTION

Global Variable | XPC

A type that represents a connection to a named service.

var XPC_TYPE_CONNECTION: xpc_type_t { get }

This connection is bidirectional and can both send and receive messages. A connection carries the credentials of the remote service provider.

XPC_TYPE_DATA

Global Variable | XPC

A type that represents an arbitrary buffer of bytes.

var XPC_TYPE_DATA: xpc_type_t { get }

XPC_TYPE_DATE

Global Variable | XPC

A type that represents a date interval.

var XPC_TYPE_DATE: xpc_type_t { get }

The interval is with respect to UNIX time. XPC dates are in UTC and are unaware of local time or leap seconds.

XPC_TYPE_DICTIONARY

Global Variable | XPC

A type that represents a dictionary of XPC objects keyed off of C-strings.

var XPC_TYPE_DICTIONARY: xpc_type_t { get }

You may insert NULL values into this collection. The dictionary grows as necessary to accommodate more key-value pairs.

XPC_TYPE_DOUBLE

Global Variable | XPC

A type that represents an IEEE-compliant, double-precision floating point value.

var XPC_TYPE_DOUBLE: xpc_type_t { get }

XPC_TYPE_ENDPOINT

Global Variable | XPC

A type that represents a connection in serialized form.

var XPC_TYPE_ENDPOINT: xpc_type_t { get }

Unlike a connection, an endpoint is an inert object that doesn’t have any associated runtime activity. So, it is safe to pass an endpoint in a message. Upon receiving an endpoint, the recipient can use xpc_connection_create_from_endpoint(_:)) to create as many distinct connections as necessary.

XPC_TYPE_ERROR

Global Variable | XPC

A type that represents an error object.

var XPC_TYPE_ERROR: xpc_type_t { get }

Errors in XPC are dictionaries, but xpc_get_type(_:)) will return this type when given an error object. You cannot create an error object directly; XPC will only give them to handlers. These error objects have pointer values that are constant across the lifetime of your process and can be safely compared.

These constants are enumerated in the header for the connection object. Error dictionaries may reserve keys so that they can be queried to obtain more detailed information about the error. Currently, the only reserved key is XPC_ERROR_KEY_DESCRIPTION.

XPC_TYPE_INT64

Global Variable | XPC

A type that represents a signed, 64-bit integer value.

var XPC_TYPE_INT64: xpc_type_t { get }

XPC_TYPE_FD

Global Variable | XPC

A type that represents a POSIX file descriptor.

var XPC_TYPE_FD: xpc_type_t { get }

xpc_type_get_name(_:)

Function | XPC

Returns a string that describes an XPC object type.

func xpc_type_get_name(_ type: xpc_type_t) -> UnsafePointer<CChar>

A string describing the type of an object, like "string" or "int64". This string should not be freed or modified.

Parameters

type: The type to describe.

XPC_TYPE_NULL

Global Variable | XPC

A type that represents a null object.

var XPC_TYPE_NULL: xpc_type_t { get }

This type is useful for disambiguating an unset key in a dictionary and one which has been reserved but set empty. Also, this type is a way to represent a “null” value in dictionaries, which do not accept NULL.

XPC_TYPE_RICH_ERROR

Global Variable | XPC

A type that represents a rich error object.

var XPC_TYPE_RICH_ERROR: xpc_type_t { get }

XPC_TYPE_SHMEM

Global Variable | XPC

A type that represents a region of shared memory.

var XPC_TYPE_SHMEM: xpc_type_t { get }

XPC_TYPE_STRING

Global Variable | XPC

A type that represents a null-terminated C-string.

var XPC_TYPE_STRING: xpc_type_t { get }

xpc_type_t

Type Alias | XPC

A type that describes XPC object types.

typealias xpc_type_t = OpaquePointer

XPC_TYPE_UINT64

Global Variable | XPC

A type that represents an unsigned, 64-bit integer value.

var XPC_TYPE_UINT64: xpc_type_t { get }

XPC_TYPE_UUID

Global Variable | XPC

A type that represents a universally unique identifier.

var XPC_TYPE_UUID: xpc_type_t { get }

xpc_uint64_create(_:)

Function | XPC

Creates an XPC unsigned integer object.

func xpc_uint64_create(_ value: UInt64) -> xpc_object_t

A new unsigned integer object.

Parameters

value: The unsigned integer value which is to be boxed.

xpc_uint64_get_value(_:)

Function | XPC

Returns the underlying unsigned 64-bit integer value from an object.

func xpc_uint64_get_value(_ xuint: xpc_object_t) -> UInt64

The underlying unsigned integer value.

Parameters

xuint: The unsigned integer object which is to be examined.

xpc_uuid_create(_:)

Function | XPC

Creates an XPC object that represents a universally unique identifier (UUID).

func xpc_uuid_create(_ uuid: UnsafePointer<UInt8>) -> xpc_object_t

A new UUID object.

Parameters

uuid: The UUID which is to be boxed.

xpc_uuid_get_bytes(_:)

Function | XPC

Copies the UUID that an XPC UUID object boxes into the specified UUID buffer.

func xpc_uuid_get_bytes(_ xuuid: xpc_object_t) -> UnsafePointer<UInt8>?

The underlying uuid_t bytes. The returned pointer may be safely passed to the uuid(3) APIs.

Parameters

xuuid: The UUID object which is to be examined.

XPCArray

Structure | XPC

An ordered random-access collection of XPC objects.

struct XPCArray

Creating an array

init()) init() — Creates a new, empty array.
init(_:)) init(xpc_object_t) — Creates a new array that contains the given XPC object.
copy(into:)) func copy(into: XPCArray) — Copies the elements of the array to a different array.

Inspecting an array

isEmpty var isEmpty: Bool — A Boolean value that indicates whether the array is empty.
count var count: Int — The number of elements in the array.

Accessing elements

subscript(_:)-1s7qq) subscript(Int) -> XPCDictionary? — Reads and writes the value at the given index as an XPC dictionary.
subscript(_:)-6c9gh) subscript(Int) -> String? — Reads and writes the value at the given index as a string.
subscript(_:)-i6v5) subscript(Int) -> Bool? — Reads and writes the value at the given index as a Boolean value.
subscript(_:)-56wjj) subscript(Int) -> xpc_object_t? — Reads and writes the value at the given index as an XPC object.
subscript(_:)-8wubg) subscript<T>(Int) -> T? — Reads and writes the value at the given index as a floating point value.
subscript(_:)-9x9ho) subscript<T>(Int) -> T? — Reads and writes the value at the given index as an unsigned integer.
subscript(_:)-2f94n) subscript<T>(Int) -> T? — Reads and writes the value at the given index as a signed integer.
subscript(_:as:)-3ae6x) subscript(Int, as _: XPCDictionary.Type) -> XPCDictionary? — Reads the value associated with the given key as an XPC dictionary.
subscript(_:as:)-9ukjj) subscript(Int, as _: String.Type) -> String? — Reads and writes the value at the given index as a string.
subscript(_:as:)-1bilh) subscript(Int, as _: Bool.Type) -> Bool? — Reads and writes the value at the given index as a Boolean value.
subscript(_:as:)-931lh) subscript(Int, as _: any OS_xpc_object.Type) -> xpc_object_t? — Reads and writes the value at the given index as an XPC object.
subscript(_:as:)-3tgp4) subscript(Int, as _: xpc_type_t) -> xpc_object_t? — Reads and writes the value at the given index as an XPC object.
subscript(_:as:)-2hql9) subscript<T>(Int, as _: T.Type) -> T? — Reads and writes the value at the given index as a floating point value.
subscript(_:as:)-6grs4) subscript<T>(Int, as _: T.Type) -> T? — Reads and writes the value at the given index as an integer value.
subscript(_:as:default:)-2bn95) subscript(Int, as _: Bool.Type, default _: @autoclosure () -> Bool) -> Bool — Reads and writes the value at the given index as a Boolean value, falling back to the given default value.
subscript(_:as:default:)-3k2qm) subscript<T>(Int, as _: T.Type, default _: @autoclosure () -> T) -> T — Reads and writes the value at the given index as a floating point value, falling back to the given default value.
withUnsafeUnderlyingArray(_:)) func withUnsafeUnderlyingArray<ReturnType>((xpc_object_t) throws -> ReturnType) rethrows -> ReturnType — Calls a closure with an unsafe reference to the array.

Iterating over an array’s elements

forEach(_:)-6obs3) func forEach((XPCArray.IndexValuePair) throws -> Void) rethrows — Calls the given closure with each element in the array in the same order as a for-in loop.
forEach(_:)-2ib8a) func forEach((Int, xpc_object_t) throws -> Void) rethrows — Calls the given closure with an index and element of the array in the same order as a for-in loop.

Transforming an array

map(_:)) func map<ReturnType>((XPCArray.IndexValuePair) throws -> ReturnType) rethrows -> [ReturnType] — Returns an array containing the results of mapping the given closure over the sequence’s elements.

Supporting types

XPCArray.IndexValuePair typealias IndexValuePair — A type that contains an index and the object at that index.

Relationships

Conforms To

XPCDictionary

Structure | XPC

A type that contains key-value pairs, notably used as the container of messages between a client and listener.

struct XPCDictionary

Creating a dictionary

init()) init() — Creates an empty dictionary.
init(_:)) init(xpc_object_t) — Creates a dictionary using the keys and values in the specified object parameter.
copy(into:)) func copy(into: XPCDictionary) — Copies the keys and values of the dictionary to a different dictionary.

Replying to client messages

reply(_:)) func reply(XPCDictionary) — Sends a reply to the originator of the dictionary.

Inspecting a dictionary

isEmpty var isEmpty: Bool — A Boolean value that indicates whether the dictionary is empty.
count var count: Int — The number of key-value pairs in the dictionary.

Accessing keys and values

keys var keys: [String] — A collection containing just the keys of the dictionary.
values var values: [xpc_object_t] — A collection containing just the values of the dictionary.
subscript(_:)-4hbmg) subscript(String) -> XPCDictionary? — Reads and writes the value associated with the given key as an XPC dictionary.
subscript(_:)-80fs2) subscript(String) -> String? — Reads and writes the value associated with the given key as a string.
subscript(_:)-gas6) subscript(String) -> Bool? — Reads and writes the value associated with the given key as a Boolean value.
subscript(_:)-4j21u) subscript(String) -> xpc_object_t? — Reads and writes the value associated with the given key as an XPC object.
subscript(_:)-8gyze) subscript<T>(String) -> T? — Reads and writes the value associated with the given key as a floating point value.
subscript(_:)-4vrsa) subscript<T>(String) -> T? — Reads and writes the value associated with the given key as an unsigned integer value.
subscript(_:)-3i01t) subscript<T>(String) -> T? — Reads and writes the value associated with the given key as a signed integer value.
subscript(_:as:)-1mm7n) subscript(String, as _: XPCDictionary.Type) -> XPCDictionary? — Reads the value associated with the given key as an XPC dictionary.
subscript(_:as:)-4zxc8) subscript(String, as _: String.Type) -> String? — Reads and writes the value associated with the given key as a string.
subscript(_:as:)-18db5) subscript(String, as _: Bool.Type) -> Bool? — Reads and writes the value associated with the given key as a Boolean value.
subscript(_:as:)-5y39v) subscript(String, as _: any OS_xpc_object.Type) -> xpc_object_t? — Reads and writes the value associated with the given key as an XPC object.
subscript(_:as:)-qjxa) subscript(String, as _: xpc_type_t) -> xpc_object_t? — Reads and writes the value associated with the given key as an XPC object.
subscript(_:as:)-3mzgc) subscript<T>(String, as _: T.Type) -> T? — Reads and writes the value associated with the given key as a floating point value.
subscript(_:as:)-119cl) subscript<T>(String, as _: T.Type) -> T? — Reads and writes the value associated with the given key as an integer value.
subscript(_:as:default:)-5ufgs) subscript(String, as _: Bool.Type, default _: @autoclosure () -> Bool) -> Bool — Reads and writes the value associated with the given key as a Boolean value, falling back to the given default value.
subscript(_:as:default:)-4ssx3) subscript<T>(String, as _: T.Type, default _: @autoclosure () -> T) -> T — Reads and writes the value associated with the given key converted to the specified type, falling back to the given default value.
withUnsafeUnderlyingDictionary(_:)) func withUnsafeUnderlyingDictionary<ReturnType>((xpc_object_t) throws -> ReturnType) rethrows -> ReturnType — Calls a closure with an unsafe reference to the dictionary.

Removing keys and values

removeValue(forKey:)) func removeValue(forKey: String) -> xpc_object_t? — Removes the given key and its associated value from the dictionary.

Supporting types

XPCDictionary.KeyValuePair typealias KeyValuePair — A type that contains a dictionary’s key-value pair.

Iterating over keys and values

forEach(_:)-9hufx) func forEach((XPCDictionary.KeyValuePair) throws -> Void) rethrows — Calls the given closure with each element in the dictionary in the same order as a for-in loop.
forEach(_:)-6riqn) func forEach((String, xpc_object_t) throws -> Void) rethrows — Calls the given closure with each key and value in the dictionary in the same order as a for-in loop.

Transforming a dictionary

map(_:)) func map<ReturnType>((XPCDictionary.KeyValuePair) throws -> ReturnType) rethrows -> [ReturnType] — Returns an array containing the results of mapping the given closure over the sequence’s elements.

Subscripts

subscript(_:)-2p7tp) subscript(String) -> XPCEndpoint? — Get or set an XPCEndpoint value in this dictionary.
subscript(_:as:)-7rdzi) subscript(String, as _: XPCEndpoint.Type) -> XPCEndpoint? — Get an XPCEndpoint value in this dictionary.

Relationships

Conforms To

XPCRichError

Structure | XPC

An error that contains a description and indicates if you can retry the operation that caused the error.

struct XPCRichError

Error properties

canRetry var canRetry: Bool — A Boolean that indicates whether you can retry the operation that caused the error.

Relationships

Conforms To

copy(into:)

Instance Method | XPC

Copies the elements of the array to a different array.

func copy(into destination: XPCArray)

Parameters

destination: The array to copy the elements into.

count

Instance Property | XPC

The number of elements in the array.

var count: Int { get }

forEach(_:)

Instance Method | XPC

Calls the given closure with an index and element of the array in the same order as a for-in loop.

func forEach(_ body: (Int, xpc_object_t) throws -> Void) rethrows

Parameters

body: A closure that takes an index and an element of the sequence as parameters.

forEach(_:)

Instance Method | XPC

Calls the given closure with each element in the array in the same order as a for-in loop.

func forEach(_ body: (XPCArray.IndexValuePair) throws -> Void) rethrows

Parameters

body: A closure that takes an element of the array as a parameter.

init()

Initializer | XPC

Creates a new, empty array.

init()

XPCArray.IndexValuePair

Type Alias | XPC

A type that contains an index and the object at that index.

typealias IndexValuePair = (index: Int, value: xpc_object_t)

XPCArray exposes its values as instances of xpc_object_t even if they were originally set with other types.

init(_:)

Initializer | XPC

Creates a new array that contains the given XPC object.

init(_ value: xpc_object_t)

Parameters

value: An XPC object. The object’s type must be XPC_TYPE_ARRAY.

isEmpty

Instance Property | XPC

A Boolean value that indicates whether the array is empty.

var isEmpty: Bool { get }

map(_:)

Instance Method | XPC

Returns an array containing the results of mapping the given closure over the sequence’s elements.

func map<ReturnType>(_ transform: (XPCArray.IndexValuePair) throws -> ReturnType) rethrows -> [ReturnType]

Parameters

transform: A mapping closure. transform accepts an element of this sequence as its parameter and returns a transformed value of the same or of a different type.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value at the given index as an XPC dictionary.

subscript(index: Int) -> XPCDictionary? { get set }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value at the given index as a signed integer.

subscript<T>(index: Int) -> T? where T : SignedInteger { get set }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value at the given index as an XPC object.

subscript(index: Int) -> xpc_object_t? { get set }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value at the given index as a string.

subscript(index: Int) -> String? { get set }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value at the given index as a floating point value.

subscript<T>(index: Int) -> T? where T : BinaryFloatingPoint { get set }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value at the given index as an unsigned integer.

subscript<T>(index: Int) -> T? where T : UnsignedInteger { get set }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value at the given index as a Boolean value.

subscript(index: Int) -> Bool? { get set }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value at the given index as a floating point value.

subscript<T>(index: Int, as type: T.Type = T.self) -> T? where T : BinaryFloatingPoint { get }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value at the given index as a Boolean value.

subscript(index: Int, as type: Bool.Type = Bool.self) -> Bool? { get }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Reads the value associated with the given key as an XPC dictionary.

subscript(index: Int, as type: XPCDictionary.Type = XPCDictionary.self) -> XPCDictionary? { get }

The value at the specified index in the array.

Parameters

index: The position of the element to access.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value at the given index as an XPC object.

subscript(index: Int, as type: xpc_type_t) -> xpc_object_t? { get }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value at the given index as an integer value.

subscript<T>(index: Int, as type: T.Type = T.self) -> T? where T : BinaryInteger { get }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value at the given index as a string.

subscript(index: Int, as type: String.Type = String.self) -> String? { get }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value at the given index as an XPC object.

subscript(index: Int, as type: any OS_xpc_object.Type = xpc_object_t.self) -> xpc_object_t? { get }

The value at the specified index in the array, otherwise nil.

Parameters

index: The position of the element to access.
type: The expected type for the returned value.

subscript(_:as:default:)

Instance Subscript | XPC

Reads and writes the value at the given index as a Boolean value, falling back to the given default value.

subscript(index: Int, as type: Bool.Type = Bool.self, default defaultValue: @autoclosure () -> Bool) -> Bool { get }

The value at the specified index in the array.

Parameters

index: The position of the element to access.
type: The expected type for the returned value.
defaultValue: The value to use if no value for exists at index or if conversion to type fails.

withUnsafeUnderlyingArray(_:)

Instance Method | XPC

Calls a closure with an unsafe reference to the array.

func withUnsafeUnderlyingArray<ReturnType>(_ closure: (xpc_object_t) throws -> ReturnType) rethrows -> ReturnType

The return value, if any, of the closure.

Parameters

closure: A closure that takes an xpc_object_t parameter. If closure has a return value, that value is also used as the return value for the withUnsafeUnderlyingArray(body:) function.

subscript(_:as:default:)

Instance Subscript | XPC

Reads and writes the value at the given index as a floating point value, falling back to the given default value.

subscript<T>(index: Int, as type: T.Type = T.self, default defaultValue: @autoclosure () -> T) -> T where T : BinaryFloatingPoint { get }

The value at the specified index in the array.

Parameters

index: The position of the element to access.
type: The expected type for the returned value.
defaultValue: The value to use if no value for exists at index or if conversion to type fails.

copy(into:)

Instance Method | XPC

Copies the keys and values of the dictionary to a different dictionary.

func copy(into destination: XPCDictionary)

Parameters

destination: The dictionary to copy the keys and values into.

count

Instance Property | XPC

The number of key-value pairs in the dictionary.

var count: Int { get }

forEach(_:)

Instance Method | XPC

Calls the given closure with each element in the dictionary in the same order as a for-in loop.

func forEach(_ body: (XPCDictionary.KeyValuePair) throws -> Void) rethrows

Parameters

body: A closure that takes an element of the sequence as a parameter.

forEach(_:)

Instance Method | XPC

Calls the given closure with each key and value in the dictionary in the same order as a for-in loop.

func forEach(_ body: (String, xpc_object_t) throws -> Void) rethrows

Parameters

body: A closure that takes a key and a value as parameters.

init()

Initializer | XPC

Creates an empty dictionary.

init()

init(_:)

Initializer | XPC

Creates a dictionary using the keys and values in the specified object parameter.

init(_ value: xpc_object_t)

Parameters

value: An XPC dictionary object. The object’s type must be XPC_TYPE_DICTIONARY.

isEmpty

Instance Property | XPC

A Boolean value that indicates whether the dictionary is empty.

var isEmpty: Bool { get }

keys

Instance Property | XPC

A collection containing just the keys of the dictionary.

var keys: [String] { get }

When iterated over, keys appear in this collection in the same order as they occur in the dictionary’s key-value pairs. Each key in the keys collection has a unique value.

Note: The complexity of this property is O(*n*) over the dictionary’s count.

XPCDictionary.KeyValuePair

Type Alias | XPC

A type that contains a dictionary’s key-value pair.

typealias KeyValuePair = (key: String, value: xpc_object_t)

XPCDictionary exposes its values as instances of xpc_object_t even if they were originally set with other types.

removeValue(forKey:)

Instance Method | XPC

Removes the given key and its associated value from the dictionary.

@discardableResult func removeValue(forKey key: String) -> xpc_object_t?

The value that was removed, or nil if the key was not present in the dictionary.

Parameters

key: The key to remove along with its associated value.

map(_:)

Instance Method | XPC

Returns an array containing the results of mapping the given closure over the sequence’s elements.

func map<ReturnType>(_ transform: (XPCDictionary.KeyValuePair) throws -> ReturnType) rethrows -> [ReturnType]

An array containing the transformed elements of this sequence.

Parameters

transform: A mapping closure. transform accepts an element of this sequence as its parameter and returns a transformed value of the same or of a different type.

reply(_:)

Instance Method | XPC

Sends a reply to the originator of the dictionary.

func reply(_ reply: XPCDictionary)

When a listener receives an XPCDictionary, the dictionary keeps track of the client that sent it. This function sends the specified reply dictionary back to the originating client.

Don’t call this function more than once on a single dictionary, and don’t call it on a dictionary that wasn’t received from a client. Calling it more than once or sending a reply using a dictionary that wasn’t received triggers an API misuse crash.

Parameters

reply: A dictionary to send back to the client that sent the receiving dictionary.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as a signed integer value.

subscript<T>(key: String) -> T? where T : SignedInteger { get set }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.

subscript(_:)

Instance Subscript | XPC

Get or set an XPCEndpoint value in this dictionary.

subscript(key: String) -> XPCEndpoint? { get set }

A previously-set endpoint value. If no endpoint was previously set for key, returns nil.

Parameters

key: The key under which to get the xpc endpoint.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as an XPC dictionary.

subscript(key: String) -> XPCDictionary? { get set }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as an XPC object.

subscript(key: String) -> xpc_object_t? { get set }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as an unsigned integer value.

subscript<T>(key: String) -> T? where T : UnsignedInteger { get set }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as a string.

subscript(key: String) -> String? { get set }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as a floating point value.

subscript<T>(key: String) -> T? where T : BinaryFloatingPoint { get set }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.

subscript(_:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as a Boolean value.

subscript(key: String) -> Bool? { get set }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as a Boolean value.

subscript(key: String, as type: Bool.Type = Bool.self) -> Bool? { get }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as an integer value.

subscript<T>(key: String, as type: T.Type = T.self) -> T? where T : BinaryInteger { get }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Reads the value associated with the given key as an XPC dictionary.

subscript(key: String, as type: XPCDictionary.Type = XPCDictionary.self) -> XPCDictionary? { get }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as a floating point value.

subscript<T>(key: String, as type: T.Type = T.self) -> T? where T : BinaryFloatingPoint { get }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as a string.

subscript(key: String, as type: String.Type = String.self) -> String? { get }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as an XPC object.

subscript(key: String, as type: any OS_xpc_object.Type = xpc_object_t.self) -> xpc_object_t? { get }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.
type: The expected type for the returned value.

subscript(_:as:)

Instance Subscript | XPC

Get an XPCEndpoint value in this dictionary.

subscript(key: String, as type: XPCEndpoint.Type = XPCEndpoint.self) -> XPCEndpoint? { get }

A previously-set endpoint value. If no endpoint was previously set for key, returns nil.

Parameters

key: The key under which to get the xpc endpoint.
type: The expected type of the resulting value.

subscript(_:as:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as an XPC object.

subscript(key: String, as type: xpc_type_t) -> xpc_object_t? { get }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.
type: The expected type for the returned value.

subscript(_:as:default:)

Instance Subscript | XPC

Reads and writes the value associated with the given key converted to the specified type, falling back to the given default value.

subscript<T>(key: String, as type: T.Type = T.self, default defaultValue: @autoclosure () -> T) -> T where T : BinaryFloatingPoint { get }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.
type: The expected type for the returned value.
defaultValue: The value to use if no value for key exists or if conversion to type fails.

subscript(_:as:default:)

Instance Subscript | XPC

Reads and writes the value associated with the given key as a Boolean value, falling back to the given default value.

subscript(key: String, as type: Bool.Type = Bool.self, default defaultValue: @autoclosure () -> Bool) -> Bool { get }

The value associated with key in the dictionary; otherwise, nil.

Parameters

key: The key the look up in the dictionary.
type: The expected type for the returned value.
defaultValue: The value to use if no value for key exists or if conversion to type fails.

values

Instance Property | XPC

A collection containing just the values of the dictionary.

var values: [xpc_object_t] { get }

A collection containing just the values of the dictionary. When iterated over, values appear in this collection in the same order as they occur in the dictionary’s key-value pairs.

Note: The complexity of this property is O(*n*) over the dictionary’s count.

withUnsafeUnderlyingDictionary(_:)

Instance Method | XPC

Calls a closure with an unsafe reference to the dictionary.

func withUnsafeUnderlyingDictionary<ReturnType>(_ closure: (xpc_object_t) throws -> ReturnType) rethrows -> ReturnType

The return value, if any, of the closure.

Parameters

closure: A closure that takes an xpc_object_t parameter. If closure has a return value, that value is also used as the return value for the withUnsafeUnderlyingDictionary(body:) function.

canRetry

Instance Property | XPC

A Boolean that indicates whether you can retry the operation that caused the error.

var canRetry: Bool { get }

Objects

Identity

Comparison

Copying

Boolean objects

Data objects

Number objects

Array objects

Dictionary objects

String objects

File Descriptor objects

Date objects

UUID objects

Shared memory objects

Null objects

Object life cycle

Types of objects

Errors

See Also

Additional Types

OS_xpc_listener

Relationships

Inherits From

Conforms To

See Also

Objects

OS_xpc_object

Relationships

Inherits From

See Also

Objects

XPC_ARRAY_APPEND

See Also

Array objects

xpc_array_append_value(_:_:)

Parameters

See Also

Array objects

xpc_array_applier_t

Parameters

See Also

Array objects

xpc_array_create(_:_:)

Parameters

See Also

Array objects

xpc_array_create_connection(_:_:)

Parameters

See Also

Array objects

xpc_array_apply(_:_:)

Parameters

See Also

Array objects

xpc_array_create_empty()

See Also

Array objects

xpc_array_get_array(_:_:)

Parameters

See Also

Array objects

xpc_array_dup_fd(_:_:)

Parameters

See Also

Array objects

xpc_array_get_count(_:)

Parameters

See Also

Array objects

xpc_array_get_bool(_:_:)

Parameters

See Also

Array objects

xpc_array_get_data(_:_:_:)

Parameters

See Also

Array objects

xpc_array_get_dictionary(_:_:)

Parameters

See Also