Write Special

lgo_WriteSpecial()

Write specially tagged data on a connection.

#include "laygo.h"

LResult lgo_WriteSpecial
    (
        LCid           cid,
        LDataBuffer    buffer,
        LBufferSize    count,
        LDataFlags     flags
    );

cid	connection to write on
buffer	buffer of data to send
count	size of data in buffer in bytes
flags	protocol-specific flags to send with data

lgo_WriteSpecial() writes specially tagged data to the subsystem for transmission to the remote system. A successful return by lgo_WriteSpecial() means that the data has been accepted for transmission on the connection. It does not mean that the data has been successfully transmitted or received by the remote system. An end-to-end protocol should be used by the application to insure successful transmission to the remote system.

The minimum number of bytes which can be written by one call to lgo_WriteSpecial() is 1. The maximum number of bytes which can be written by one call to lgo_WriteSpecial() depends on the configuration of the underlying protocols and the system buffer pool.

The meanings of the data flags are defined by the protocol.

If successful, lgo_WriteSpecial() returns a non-negative value representing the number of bytes written. Otherwise, it returns a negative value indicating the reason it failed. Possible unsuccessful return values are:

lgo_Write()

if ((bytes = lgo_WriteSpecial(cid, buffer, count, flags)) < 0)
{
    /* process error */
}