lgo_Xoff()

Request temporary suspension of data transmission by the remote system.

#include "laygo.h"

LResult lgo_Xoff
    (
        LCid    cid
    );

lgo_Xoff() requests a temporary suspension of data transmission by the remote system. lgo_Xoff() may be called more than once, without an intervening call to lgo_Xon(), but the effect, if any, is defined by the protocol. For instance, The X.21 bis protocol uses a physical signal for flow control. So multiple xoff requests have no effect. However, an HDLC LAPB implementation may chose to send an RNRframe each time lgo_Xoff() is called.

A successful return from lgo_Xoff() does not prevent the local application from continuing to read and write data and sending control events.

If successful, lgo_Xoff() returns a non-negative value. 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_TRANSMISSION_BLOCKED
• lgo_ERROR_NO_SYSTEM_BUFFER

lgo_Xon()

if (cannotProcess)
{
    lgo_Xoff(cid);
}