mpi4py.MPI.Request

class mpi4py.MPI.Request(request=None)

Bases: object

Request handle

Parameters

request (Optional[Request]) –

Return type

Request

static __new__(cls, request=None)
Parameters

request (Optional[Request]) –

Return type

Request

Methods Summary

Cancel()

Cancel a communication request

Free()

Free a communication request

Get_status([status])

Non-destructive test for the completion of a request

Test([status])

Test for the completion of a send or receive

Testall(requests[, statuses])

Test for completion of all previously initiated requests

Testany(requests[, status])

Test for completion of any previously initiated request

Testsome(requests[, statuses])

Test for completion of some previously initiated requests

Wait([status])

Wait for a send or receive to complete

Waitall(requests[, statuses])

Wait for all previously initiated requests to complete

Waitany(requests[, status])

Wait for any previously initiated request to complete

Waitsome(requests[, statuses])

Wait for some previously initiated requests to complete

cancel()

Cancel a communication request

f2py(arg)

get_status([status])

Non-destructive test for the completion of a request

py2f()

test([status])

Test for the completion of a send or receive

testall(requests[, statuses])

Test for completion of all previously initiated requests

testany(requests[, status])

Test for completion of any previously initiated request

testsome(requests[, statuses])

Test for completion of some previously initiated requests

wait([status])

Wait for a send or receive to complete

waitall(requests[, statuses])

Wait for all previously initiated requests to complete

waitany(requests[, status])

Wait for any previously initiated request to complete

waitsome(requests[, statuses])

Wait for some previously initiated requests to complete

Methods Documentation

Cancel()

Cancel a communication request

Return type

None

Free()

Free a communication request

Return type

None

Get_status(status=None)

Non-destructive test for the completion of a request

Parameters

status (Optional[Status]) –

Return type

bool

Test(status=None)

Test for the completion of a send or receive

Parameters

status (Optional[Status]) –

Return type

bool

classmethod Testall(requests, statuses=None)

Test for completion of all previously initiated requests

Parameters
Return type

bool

classmethod Testany(requests, status=None)

Test for completion of any previously initiated request

Parameters
Return type

Tuple[int, bool]

classmethod Testsome(requests, statuses=None)

Test for completion of some previously initiated requests

Parameters
Return type

Optional[List[int]]

Wait(status=None)

Wait for a send or receive to complete

Parameters

status (Optional[Status]) –

Return type

Literal[True]

classmethod Waitall(requests, statuses=None)

Wait for all previously initiated requests to complete

Parameters
Return type

Literal[True]

classmethod Waitany(requests, status=None)

Wait for any previously initiated request to complete

Parameters
Return type

int

classmethod Waitsome(requests, statuses=None)

Wait for some previously initiated requests to complete

Parameters
Return type

Optional[List[int]]

cancel()

Cancel a communication request

Return type

None

classmethod f2py(arg)
Parameters

arg (int) –

Return type

Request

get_status(status=None)

Non-destructive test for the completion of a request

Parameters

status (Optional[Status]) –

Return type

bool

py2f()
Return type

int

test(status=None)

Test for the completion of a send or receive

Parameters

status (Optional[Status]) –

Return type

Tuple[bool, Optional[Any]]

classmethod testall(requests, statuses=None)

Test for completion of all previously initiated requests

Parameters
Return type

Tuple[bool, Optional[List[Any]]]

classmethod testany(requests, status=None)

Test for completion of any previously initiated request

Parameters
Return type

Tuple[int, bool, Optional[Any]]

classmethod testsome(requests, statuses=None)

Test for completion of some previously initiated requests

Parameters
Return type

Tuple[Optional[List[int]], Optional[List[Any]]]

wait(status=None)

Wait for a send or receive to complete

Parameters

status (Optional[Status]) –

Return type

Any

classmethod waitall(requests, statuses=None)

Wait for all previously initiated requests to complete

Parameters
Return type

List[Any]

classmethod waitany(requests, status=None)

Wait for any previously initiated request to complete

Parameters
Return type

Tuple[int, Any]

classmethod waitsome(requests, statuses=None)

Wait for some previously initiated requests to complete

Parameters
Return type

Tuple[Optional[List[int]], Optional[List[Any]]]