Synopsis:
int HTTPCore_cleanup()
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int HTTPCore_debugEnabled()
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int HTTPCore_dispatch( PIHTTP *pPIHTTP, int iStartPhase, int iEndPhase )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int HTTPCore_executePhase( PIHTTP *pPIHTTP,
PIObject *(* nextHandler)(void *), void *pArg)
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
PIFInfo *HTTPCore_getCachedFile( const char *pPath )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Name:
HTTPCore_getMIMETypeFromExtension
Synopsis:
const char *HTTPCore_getMIMETypeFromExtension( const char *pExtension )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
const char *HTTPCore_getServerStamp()
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int HTTPCore_init( PIObject *pObject )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int HTTPCore_loadMIMEFile( PIObject *pObject, PIDB *pMimeDB,
const char *pMimeFile )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int HTTPCore_logDebug( int iLevel, const char *pFormat, ... )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int HTTPCore_logError( PIHTTP *pPIHTTP, const char *pFormat, ... )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int HTTPCore_readHeaders( PIIOBuffer *pB, PIDB *pDB, int iFlags )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Name:
HTTPCore_relativeToAbsolutePath
Synopsis:
int HTTPCore_relativeToAbsolutePath( const char *pRelative,
Pi3String *pResult )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Name:
HTTPCore_releaseCachedFile
Synopsis:
void HTTPCore_releaseCachedFile( PIFInfo *pInfo )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Name:
HTTPCore_sendEntityHeaders
Synopsis:
int HTTPCore_sendEntityHeaders( PIHTTP *pPIHTTP, PIDB *pR )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Name:
HTTPCore_sendGeneralHeaders
Synopsis:
int HTTPCore_sendGeneralHeaders( PIHTTP *pPIHTTP )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int HTTPUtil_contractPath( char *pPath )
Description:
Contract the directory path pPath in place by removing directories
with the name '..'.
Notes:
Return Values:
Returns the number of directories above the root pPath which should be
discarded. Typically a value of 0 is the desired result.
Errors:
See Also:
Synopsis:
HTTPUtil_doHTTPError( PIHTTP *pPIHTTP, int iError )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
const char *HTTPUtil_getHostName( PIHTTP *pPIHTTP )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
const char *HTTPUtil_getHostPort( PIHTTP *pPIHTTP )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Name:
HTTPUtil_phaseNameToNumber
Synopsis:
int HTTPUtil_phaseNameToNumber( const char *pPhaseName )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Name:
HTTPUtil_phaseNumberToName
Synopsis:
const char *HTTPUtil_phaseNumberToName( int iPhaseNumber )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Name:
HTTPUtil_protocolNumberToName
Synopsis:
const char *HTTPUtil_protocolNumberToName( int iProtocol )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int HTTPUtil_rFC822Time( struct tm *pT, Pi3String *pResult )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int HTTPUtil_rcNameToNumber( const char *pName )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
const char *HTTPUtil_rcNumberToName( int iRC )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
HTTPUtil_readTime( const char *pLine, struct tm *pT )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
HTTPUtil_regexMatch( const char *pRegex, int iRegex, const char *pString,
int iStringLen )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Name:
HTTPUtil_regexMatchPi3String
Synopsis:
HTTPUtil_regexMatchPi3String( const Pi3String *pRegexPattern,
const Pi3String *pString )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
HTTPUtil_sendFile( PIIOBuffer *pBuffer, PIFInfo *pFInfo,
int iBufferingFlags, int iSendFlags )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
HTTPUtil_urlDecode( const Pi3String *pToDecode, Pi3String *pResult )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
HTTPUtil_urlEncode( const Pi3String *pToEncode, Pi3String *pResult )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
void *PIHTTP_allocMem( PIHTTP *pPIHTTP, unsigned int iSize )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int PIHTTP_delete( PIHTTP *pPIHTTP )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
PIHTTP *PIHTTP_new( PIObject *pIOObject, PIDB *pHostDB )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
PIHTTP *PIHTTP_newChild( PIHTTP *pParent )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Name:
PIIOBuffer_advanceBufferPointer
Synopsis:
int PIIOBuffer_advanceBufferPointer( PIIOBuffer *pIOBuf, int iCount )
Description:
Advances the internal buffer pointer by iCount bytes. See
PIIOBuffer_getBufferPointer() for more information.
Notes:
Return Values:
Returns a positive integer on success.
Errors:
Returns a negative or zero value on failure.
See Also:
PIIOBuffer_getBufferPointer
Synopsis:
int PIIOBuffer_delete( PIIOBuffer *pPIIOBuffer )
Description:
Deallocate memory associated with IO buffer object pIOBuffer after
flushing output.
Notes:
Destroying the buffer object does not destroy the IO channel it
encapsulates.
Return Values:
Errors:
See Also:
PIIOBuffer_new
Synopsis:
int PIIOBuffer_flush( PIIOBuffer *pIOBuf )
Description:
Flush contents of output buffer to the IO channel.
Notes:
Return Values:
Returns an integer which should be interpreted as a boolean.
Errors:
Returns non-zero on success, zero on failure.
See Also:
Synopsis:
int PIIOBuffer_getBytesSent( PIIOBuffer *pIOBuf )
Description:
Returns the number of byes which have been place into this buffer
object since it was created or PIIOBuffer_resetBytesSent() was
last invoked. This value is the sum of the data sent down the IO channel
and data currently in the output buffer.
Notes:
Return Values:
Returns number of bytes sent.
Errors:
This function does not raise an error.
See Also:
PIIOBuffer_resetBytesSent
Synopsis:
int PIIOBuffer_getLine( PIIOBuffer *pIOBuf, char *pszBuf, int iBufLen )
Description:
Read a line from the IO buffer into buffer pszBuf. Up to iBufLen
characters are written.
Notes:
Return Values:
Returns number of characters read or -1 on error.
Errors:
Returns -1 on error.
See Also:
PIIOBuffer_read
Name:
PIIOBuffer_getOutputBuffer
Synopsis:
int PIIOBuffer_getOutputBuffer( PIIOBuffer *pIOBuf, char **ppBuffer )
Description:
Returns the output buffer and its length so data can be written into
it directly rather than using intermediate buffering. If the buffer
length is not sufficient PIIOBuffer_flush() may be invoked followed by
PIIOBuffer_getOutputBuffer() to get the flushed buffer.
The pointer ppBuffer will be set to point at the internal buffer.
After data has been written to the buffer and before any other output
buffer functions are invoked the function PIIOBuffer_advanceBufferPointer()
should be called to set the internal length of the output buffer.
Notes:
Return Values:
Returns the length of the output buffer.
Errors:
See Also:
PIIOBuffer_advanceBufferPointer
Synopsis:
PIIOBuffer *PIIOBuffer_new( PIObject *pIOObject )
Description:
Create a new IO buffer object which uses IO channel object pIOObject for
input and output.
Notes:
Return Values:
Errors:
See Also:
PIIOBuffer_delete
Name:
PIIOBuffer_pollBeforeRead
Synopsis:
int PIIOBuffer_pollBeforeRead( PIIOBuffer *pIOBuf )
Description:
Causes the current thread to yield until data has been read from the
IO channel into the internal buffer.
Notes:
Return Values:
Returns -1 on IO error, 0 for channel closed and >0 for success.
Errors:
Returns -1 on error.
See Also:
PIIOBuffer_read
Synopsis:
const char *PIIOBuffer_read( PIIOBuffer *pIOBuf, int *piRead )
Description:
Reads data from the IO channel into the internal buffer and returns
a pointer to the data read. The pointer piRead should point at
an integer which will be set to the number of bytes read on success.
Notes:
Return Values:
Return a non-NULL pointer on success.
Errors:
Returns NULL on channel closed or error.
See Also:
PIIOBuffer_readToBuffer
Synopsis:
int PIIOBuffer_readToBuffer( PIIOBuffer *pIOBuf, char *pszBuf,
int iMaxLen )
Description:
Reads data from the IO channel into the buffer pIOBuf. Up to iMaxLen
bytes will be read. A positive return value gives the number of bytes
written into the buffer.
Notes:
Return Values:
Returns values are: 0 on channel closed, -1 on error and >0 on success.
Errors:
Returns -1 on error, 0 on channel closed.
See Also:
PIIOBuffer_read
Name:
PIIOBuffer_resetBytesSent
Synopsis:
int PIIOBuffer_resetBytesSent( PIIOBuffer *pIOBuf )
Description:
Resets the count of bytes sent through this buffer object to 0.
Refer to PIIOBuffer_getBytesSent() for more information.
Notes:
Return Values:
This function does not return a value.
Returns number of bytes sent.
Errors:
This function does not raise an error.
See Also:
PIIOBuffer_getBytesSent
Synopsis:
int PIIOBuffer_write( PIIOBuffer *pIOBuf, const char *pszBuf, int iLen,
int iFlags )
Description:
Write the contents of the buffer pszBuf of length iLen into the
the internal output buffer optionally flushing the output buffer.
The value iFlags is formed by OR'ing the following flags
PIIOBUF_NONE No flags (0).
PIIOBUF_NOBUFFER Don't buffer, output data with directly after
flushing existing output buffer.
Notes:
If iLen is -1, PIIOBuffer_write() uses strlen() to determine the
length of the string pszBuf.
Return Values:
Returns number of bytes written or -1 on error.
Errors:
Returns -1 on error.
See Also:
PIIOBuffer_writeLn
Synopsis:
int PIIOBuffer_writeLn( PIIOBuffer *pIOBuf, const char *pszBuf, int iLen,
int iFlags )
Description:
Write the contents of the buffer pszBuf of length iLen into the
the internal output buffer followed by CRLF to terminate the line.
See PIIOBuffer_write() for a description of flags.
Notes:
If iLen is -1, PIIOBuffer_write() uses strlen() to determine the
length of the string pszBuf.
Return Values:
Returns number of bytes written or -1 on error.
Errors:
Returns -1 on error.
See Also:
PIIOBuffer_write
Synopsis:
int Pi3Expression_delete( Pi3Expression *pExpression );
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
Pi3Expression *Pi3Expression_new( const char *pExpression,
FnPi3Write *pParameters, Pi3String *pErrorDescription )
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int Pi3Expression_write( Pi3Expression *pExpression, PIHTTP *pPIHTTP,
void *pData, char *pBuffer, int iBufferLength );
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int Pi3String_delete( Pi3String *pString );
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
int Pi3String_getLength( Pi3String *pString );
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
const char *Pi3String_getPtr( Pi3String *pString );
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also:
Synopsis:
Pi3String *Pi3String_new( const char *pString );
Description:
This function is not yet documented.
Notes:
The parameter pString may be NULL to indicate an empty string.
Return Values:
Errors:
See Also:
Synopsis:
Pi3String *Pi3String_newEx( const char *pString, int iLength );
Description:
This function is not yet documented.
Notes:
Return Values:
Errors:
See Also: