LAPI_Probe Subroutine

Purpose

Transfers control to the communication subsystem to check for arriving messages and to make progress in polling mode.

Library

Availability Library (liblapi_r.a)

C Syntax

#include <lapi.h>
 
int LAPI_Probe(hndl)
lapi_handle_t hndl;

FORTRAN Syntax

include 'lapif.h'
 
int LAPI_PROBE(hndl, ierror)
INTEGER hndl
INTEGER ierror

Description

Type of call: local progress monitor (non-blocking)

This subroutine transfers control to the communication subsystem in order to make progress on messages associated with the context hndl. A LAPI_Probe operation lasts for one round of the communication dispatcher.

Note: There is no guarantee about receipt of messages on the return from this function.

Parameters

INPUT

hndl

Specifies the LAPI handle.

OUTPUT

ierror

Specifies a FORTRAN return code. This is always the last parameter.

Return Values

LAPI_SUCCESS

Indicates that the function call completed successfully.

LAPI_ERR_HNDL_INVALID

Indicates that the hndl passed in is not valid (not initialized or in terminated state).

Location

/usr/lib/liblapi_r.a