a0FGet()

Performs a blocking get from a pipe.


Syntax

a0tError a0FGet(
a0tPipe *pipe,
a0tRequest *request,
a0tFormat *format,
void *address,
int count );

Arguments

Namerd/wrDescription
pipe read Pipe to get from.
request write Request descriptor to hold the status.
format read Format of the data to receive.
address write Address of the data to receive.
count read Number of elements to receive.

Description

This function performs a blocking get from a given pipe pipe. A request is posted to receive the data described by format, starting at address, with count elements. This request can cause a message to be immediately received from the origin node or not, depending on the protocol used and the data left in the buffer of the pipe.

On return of this function, the variable pointed by request contains an opaque request that can be used later to check the completion status of the operation.


Return Values

If an error condition occurs, it returns the error code, otherwise it returns A0ErrOk. Possible values are as follows:
Error CodeDescription
A0Err...Some error occurred.
A0ErrOkSuccessful completion.

See Also

a0IFGet() a0FPut() a0IFPut() a0FReceive() a0UseFormats() a0NewMapFormat() a0NewFunctionFormat() a0NewPipe()