18.2.423. MPI_T_event_handle_alloc

MPI_T_event_handle_alloc - Allocate event handles

18.2.423.1. SYNTAX

18.2.423.1.1. C Syntax

int MPI_T_event_handle_alloc(int event_index, void* obj_handle,
    MPI_Info info, MPI_T_event_registration* event_registration)

18.2.423.2. INPUT PARAMETERS

event_index: Index of event type for which the registration handle is to be allocated.
obj_handle: reference to a handle of the MPI object to which this event is supposed to be bound.
info: Info object.

18.2.423.3. OUTPUT PARAMETERS

event_registration: Event registration.

18.2.423.4. DESCRIPTION

MPI_T_event_handle_alloc binds the control variable specified in event_index to the MPI object specified in obj_handle. If MPI_T_event_get_info returns MPI_T_BIND_NO_OBJECT as the binding of the variable the obj_handle argument is ignored.

Note

When the event type is bound to an object, obj_handle is the address of the variable holding that MPI object’s handle, and the resulting registration is notified only when the event occurs for that specific object. For the list of Open MPI’s built-in event types – which are bound to an object and which are MPI_T_BIND_NO_OBJECT – and a fuller description of binding, see MPI_T_Events.

18.2.423.5. ERRORS

MPI_T_event_handle_alloc will fail if:

MPI_T_ERR_NOT_INITIALIZED: The MPI Tools interface is not initialized.
MPI_T_ERR_INVALID_HANDLE: The handle is invalid.
MPI_T_ERR_INVALID_HANDLE: Invalid use of the interface or bad parameter values(s).
MPI_T_ERR_OTHER: Other error