openfam::fam::fam_destroy_region
Destroy an existing region in FAM.
Synopsis
void fam_destroy_region(Fam_Region_Descriptor *descriptor);
Description
This destroys a region in FAM, and asynchronously frees space allocated to the region.
Input Arguments
| Name | Description |
|---|---|
| Descriptor | Descriptor of the region to be destroyed. |
Return Values
None. Throws an exception on error.
Exceptions
| Exception | Description |
|---|---|
| FAM_ERR_NOPERM | Caller does not have access rights |
| FAM_ERR_NOTFOUND | the region name is not present in FAM |
| FAM_ERR_GRPC | there is a communication error with memory server |
| FAM_ERR_RPC_CLIENT_NOTFOUND | Memory server initialization failure |
Notes
If a region is destroyed, all data items in it are also destroyed. If descriptors to the region or the contained data items are subsequently used, the behavior of the library is implementation dependent. Note that this call will trigger a delayed free operation, to permit other PEs currently using the region to finish.