NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO
#include<hr/hr.h>int hrKillGroup(int groupId);
The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.
See API(5FEA) for details.
HOT_RESTART
hrKillGroup() can only be invoked by supervisor actors or trusted user actors.
hrKillGroup() permanently kills all hot restartable actors in the restart group with ID groupId, and unregisters them in the Hot Restart Controller. All persistent memory blocks used to store the actor images and executed images for these actors are freed. All persistent memory blocks created using the group's deletion key (HR_GROUP_KEY, as described in the man page for pmmAllocate(2RESTART)) are also freed. It is the programmer's responsibility to free any persistent memory blocks allocated by the killed actors that use a different deletion key.
When a group has been killed successfully, the group ID that identified it can be used to identify a different restartable actor group.
Calling hrKillGroup() is the only way to kill a restartable actor programmatically. Individual restartable actors cannot be killed independently of their group, as this would leave the group in an inconsistent state after a restart. Calling akill(2K) on a restartable actor will simply restart the actor's group, and not kill the actor.
No error is returned if groupId is not currently used by a restart group.
hrKillGroup() is functionally equivalent to the C_INIT command akill(1M) with the -g option.
If successful, hrKillGroup() returns 0. Otherwise hrKillGroup() returns -1 and sets errno to indicate the error.
The calling actor is neither a trusted actor nor a supervisor actor.
groupId is greater than or equal
to the value of the tunable system parameter hrCtrl.maxGroups
.
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE | ATTRIBUTE VALUE |
---|---|
Interface Stability | Evolving |
NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO