os_workgroup_create_with_port
Creates a new workgroup that is bound to the workgroup with the specified Mach port.
Declaration
extern os_workgroup_t os_workgroup_create_with_port(const char *name, mach_port_t mach_port);Parameters
- name:
An optional name for the workgroup. Use this name to identify the workgroups you create. You may specify
NULLfor this parameter. - mach_port:
A port that represents the send right for a kernel workgroup object. Typically, you obtain this port from another process, which creates it using the Os_workgroup_copy_port function. This function doesn’t consume a reference to the port’s send right.
Return Value
An immutable workgroup object that refers to the workgroup with the specified port.
Discussion
Use this function to join threads of your app to a workgroup in a different process. A process may export its workgroup’s Mach port to coordinate any work it’s doing with similar work happening in other processes. For example, the system’s audio APIs export workgroups that allow other processes to provide audio data on the same schedule as the system. Use this function to construct a local workgroup from the provided port information.
The workgroup this function returns is a reference to the workgroup with the specified port. You can add threads to the newly created workgroup, but you cannot change the configuration or scheduling details of the original group. For example, you cannot start, stop, or update the deadlines for an interval workgroup, and those functions return errors if you try to do so. Instead, the process that owns the original workgroup handles all configuration and scheduling details.
This function sets the name of the new workgroup to the value in the name property. It then configures the new workgroup as a reference to the workgroup in the wg parameter. The newly created workgroup doesn’t contain any threads initially, and it doesn’t contain any context data.