Class mpi.Request

java.lang.Object
    |
    +----mpi.Request

Subclasses:

Prequest

public class Request

extends java.lang.Object

Field Summary
long	handle
static int	NULL

 

Constructor Summary

Request()

Request(int Type)

Request(long _handle)

 

Method Summary
void	Cancel() Mark a pending nonblocking communication for cancellation.
void	Free() Set the request object to be void.
boolean	Is_null() Test if request object is void.
Status	Test() Returns a status object if the operation identified by the request is complete, or a null handle otherwise.
static Status[]	Testall(Request[] array_of_request) Tests for completion of all of the operations associated with active requests.
static Status	Testany(Request[] array_of_request) Tests for completion of either one or none of the operations associated with active requests.
static Status[]	Testsome(Request[] array_of_request) Behaves like Waitsome, except that it returns immediately.
Status	Wait() Blocks until the operation identified by the request is complete.
static Status[]	Waitall(Request[] array_of_request) Blocks until all of the operations associated with the active requests in the array have completed.
static Status[]	Waitsome(Request[] array_of_request) Blocks until at least one of the operations associated with the active requests in the array has completed.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

NULL

public static final int NULL

handle

protected long handle

Request

public Request()

Request

public Request(int Type)

Request

public Request(long _handle)

Free

public void Free()

Set the request object to be void. Java binding of the MPI operation MPI_REQUEST_FREE.

Cancel

public void Cancel()

Mark a pending nonblocking communication for cancellation. Java binding of the MPI operation MPI_CANCEL.

Is_null

public boolean Is_null()

Test if request object is void.

returns:

true if the request object is void, false otherwise

Wait

public Status Wait()

Blocks until the operation identified by the request is complete.

returns:

status object

Java binding of the MPI operation MPI_WAIT.

After the call returns, the request object becomes inactive.

Test

public Status Test()

Returns a status object if the operation identified by the request is complete, or a null handle otherwise.

returns:

status object or null handle

Java binding of the MPI operation MPI_TEST.

After the call, if the operation is complete (ie, if the return value is non-null), the request object becomes inactive.

Testany

public static Status Testany(Request[] array_of_request)

Tests for completion of either one or none of the operations associated with active requests.

array_of_requests	array of requests
returns:	status object or null handle

Java binding of the MPI operation MPI_TESTANY.

If some request completed, the index in array_of_requests for that request can be obtained from the returned status object through the. The corresponding element of array_of_requests becomes inactive. If no request completed, Testany returns a null handle.

Waitall

public static Status[] Waitall(Request[] array_of_request)

Blocks until all of the operations associated with the active requests in the array have completed.

array_of_requests	array of requests
returns:	array of status objects

Java binding of the MPI operation MPI_WAITALL.

The result array will be the same size as array_of_requests. On exit, requests become inactive. If the input value of arrayOfRequests contains inactive requests, corresponding elements of the result array will contain null status handles.

Testall

public static Status[] Testall(Request[] array_of_request)

Tests for completion of all of the operations associated with active requests.

array_of_requests	array of requests
returns:	array of status objects

Java binding of the MPI operation MPI_TESTALL.

If all operations have completed, the exit value of the argument array and the result array are as for Waitall. If any operation has not completed, the result value is null and no element of the argument array is modified.

Waitsome

public static Status[] Waitsome(Request[] array_of_request)

Blocks until at least one of the operations associated with the active requests in the array has completed.

array_of_requests	array of requests
returns:	array of status objects

Java binding of the MPI operation MPI_WAITSOME.

The size of the result array will be the number of operations that completed. The index in array_of_requests for each request that completed can be obtained from the returned status objects through the Status.index field. The corresponding element in array_of_requests becomes inactive.

Testsome

public static Status[] Testsome(Request[] array_of_request)

Behaves like Waitsome, except that it returns immediately.

array_of_requests	array of requests
returns:	array of status objects

Java binding of the MPI operation MPI_TESTSOME.

If no operation has completed, TestSome returns an array of length zero and elements of array_of_requests are unchanged. Otherwise, arguments and return value are as for Waitsome.