debian man page for trf_querymaxread

Trf_QueryMaxRead(3)					     Library Functions Manual					       Trf_QueryMaxRead(3)

NAME
       Trf_QueryMaxRead - Interface for procedures to query a transformation about the max.

SYNOPSIS
       #include <transform.h>

       int Trf_QueryMaxRead
       (
	    Trf_ControlBlock ctrlBlock,
	    ClientData clientData
       );

PARAMETERS
       Trf_ControlBlock ctrlBlock
	      State of encoder/decoder.

       ClientData clientData
	      Arbitrary information, as defined in Trf_TypeDefinition.clientData.

DESCRIPTION
	Number	of bytes to read in the next call to the down channel.	This procedure will be called by the generic trf layer just before reading
       data from the channel below the transformation. This way a transformation is able to control its  consumption  of  characters.  An  example
       would  be  'identity with stop after n characters'. This would transfer at most n characters and then basically fake higher transformations
       into believing that EOF occured. Then popping it would reveal the truth. Pattern matching could be used here too (internet protocols !).

SEE ALSO
       Trf_Init(3), Trf_SafeInit(3),  Trf_IsInitialized(3),  Trf_CreateOptions(3),  Trf_DeleteOptions(3),  Trf_CheckOptions(3),  Trf_SetOption(3),
       Trf_SetObjOption(3),   Trf_QueryOptions(3),   Trf_SeekQueryOptions(3),  Trf_WriteProc(3),  Trf_CreateCtrlBlock(3),  Trf_DeleteCtrlBlock(3),
       Trf_TransformCharacter(3), Trf_TransformBuffer(3),  Trf_FlushTransformation(3),	Trf_ClearCtrlBlock(3),	Trf_Register(3),  Trf_ConverterOp-
       tions(3),  Trf_MDStart(3),  Trf_MDUpdate(3),  Trf_MDUpdateBuf(3), Trf_MDFinal(3), Trf_MDCheck(3), Trf_RegisterMessageDigest(3), Trf_LoadLi-
       brary(3), Trf_XorBuffer(3), Trf_ShiftRegister(3), Trf_FlipRegisterShort(3), Trf_FlipRegisterLong(3), Trf_InitStubs(3)

c2man transform.h						  27 August 2002					       Trf_QueryMaxRead(3)