lgo_Read()

Read data from a connection.

#include "laygo.h"

LResult lgo_Read
    (
        LCid           cid,
        LDataBuffer    buffer,
        LBufferSize    size
    );

lgo_Read() reads data from a connection. The minimum and maximum number of bytes which can be requested in one call to lgo_Read() is a system parameter defined by the configuration of the buffer pool and the protocols used.

If lgo_Read() fails with an error code of lgo_ERROR_BUFFER_SIZE, the application may call lgo_Poll() to determine the number of bytes of data waiting to be read.

If successful, lgo_Read() returns a non-negative value indicating the number of bytes read into the buffer. Otherwise, it returns a negative value indicating the reason it failed. Possible unsuccessful return values are:

• lgo_ERROR_INVALID_CID
• lgo_ERROR_INVALID_COMMAND
• lgo_ERROR_INVALID_OUTPUT_BUFFER
• lgo_ERROR_BUFFER_SIZE
• lgo_ERROR_EVENT_WAITING
• lgo_ERROR_SPECIAL_DATA_WAITING
• lgo_ERROR_TRANSMISSION_BLOCKED

A return value of 0 means that there are neither data nor control events waiting to be read.

lgo_ReadSpecial()
lgo_Poll()

if ((bytesRead = lgo_Read(cid, buffer, size)) < 0)
{
    /* process error */
}
else if (bytesRead > 0)
{
    /* process read data */
}
else
{
    /* process other CIDs */
}