Home

Traffic Server Software Developers Kit

Chapter 18. Function Reference

Table of Contents

List of Function Groups
Initialization Functions
INKPluginInit
INKPluginRegister
INKTrafficServerVersionGet
Debugging Functions
INKDebug
INKIsDebugTagSet
INKError
INKAssert
INKReleaseAssert
The INKfopen Family
INKfclose
INKfflush
INKfgets
INKfopen
INKfread
INKfwrite
Memory Allocation
INKfree
INKmalloc
INKrealloc
INKstrdup
INKstrndup
Thread Functions
INKThreadCreate
INKThreadDestroy
INKThreadInit
INKThreadSelf
HTTP Functions
Hook Functions
INKHttpHookAdd
Session Functions
INKHttpSsnHookAdd
INKHttpSsnReenable
HTTP Transaction Functions
INKHttpTxnCacheLookupStatusGet
INKHttpTxnCachedReqGet
INKHttpTxnCachedRespGet
INKHttpTxnClientIncomingPortGet
INKHttpTxnClientIPGet
INKHttpTxnClientRemotePortGet
INKHttpTxnClientReqGet
INKHttpTxnClientRespGet
INKHttpTxnErrorBodySet
INKHttpTxnHookAdd
INKHttpTxnNextHopIPGet
INKHttpTxnParentProxyGet
INKHttpTxnParentProxySet
INKHttpTxnReenable
INKHttpTxnServerIPGet
INKHttpTxnServerReqGet
INKHttpTxnServerRespGet
INKHttpTxnSsnGet
INKHttpTxnTransformedRespCache
INKHttpTxnTransformRespGet
INKHttpTxnUntransformedRespCache
Initiate Connection
INKHttpConnect
Intercepting HTTP Transaction Functions
INKHttpTxnIntercept
INKHttpTxnServerIntercept
Alternate Selection Functions
INKHttpAltInfoCachedReqGet
INKHttpAltInfoCachedRespGet
INKHttpAltInfoClientReqGet
INKHttpAltInfoQualitySet
Handle Release Functions
INKHandleMLocRelease
INKHandleStringRelease
Marshal Buffers
INKMBufferCreate
INKMBufferDestroy
HTTP Header Functions
INKHttpHdrClone
INKHttpHdrCopy
INKHttpHdrCreate
INKHttpHdrDestroy
INKHttpHdrLengthGet
INKHttpHdrMethodGet
INKHttpHdrMethodSet
INKHttpHdrPrint
INKHttpHdrReasonGet
INKHttpHdrReasonLookup
INKHttpHdrReasonSet
INKHttpHdrStatusGet
INKHttpHdrStatusSet
INKHttpHdrTypeGet
INKHttpHdrTypeSet
INKHttpHdrUrlGet
INKHttpHdrUrlSet
INKHttpHdrVersionGet
INKHttpHdrVersionSet
INKHttpParserClear
INKHttpParserCreate
INKHttpParserDestroy
INKHttpHdrParseReq
INKHttpHdrParseResp
URL Functions
INKUrlClone
INKUrlCopy
INKUrlCreate
INKUrlDestroy
INKUrlPrint
INKUrlFtpTypeGet
INKUrlFtpTypeSet
INKUrlHostGet
INKUrlHostSet
INKUrlHttpFragmentGet
INKUrlHttpFragmentSet
INKUrlHttpParamsGet
INKUrlHttpParamsSet
INKUrlHttpQueryGet
INKUrlHttpQuerySet
INKUrlLengthGet
INKUrlParse
INKUrlPasswordGet
INKUrlPasswordSet
INKUrlPathGet
INKUrlPathSet
INKUrlPortGet
INKUrlPortSet
INKUrlSchemeGet
INKUrlSchemeSet
INKUrlStringGet
INKUrlUserGet
INKUrlUserSet
MIIME Headers
INKMimeHdrFieldAppend
INKMimeHdrFieldClone
INKMimeHdrFieldCopy
INKMimeHdrFieldCopyValues
INKMimeHdrFieldCreate
INKMimeHdrFieldDestroy
INKMimeHdrFieldLengthGet
INKMimeHdrFieldNameGet
INKMimeHdrFieldNameSet
INKMimeHdrFieldNext
INKMimeHdrFieldNextDup
INKMimeHdrFieldValueAppend
INKMimeHdrFieldValueDateGet
INKMimeHdrFieldValueDateInsert
INKMimeHdrFieldValueDateSet
INKMimeHdrFieldValueDelete
INKMimeHdrFieldValueIntGet
INKMimeHdrFieldValueIntInsert
INKMimeHdrFieldValueIntSet
INKMimeHdrFieldValueStringGet
INKMimeHdrFieldValueStringInsert
INKMimeHdrFieldValueStringSet
INKMimeHdrFieldValueUintGet
INKMimeHdrFieldValueUIntInsert
INKMimeHdrFieldValueUintSet
INKMimeHdrFieldValuesClear
INKMimeHdrFieldValuesCount
INKMimeHdrClone
INKMimeHdrCopy
INKMimeHdrCreate
INKMimeHdrDestroy
INKMimeHdrFieldFind
INKMimeHdrFieldGet
INKMimeHdrFieldRemove
INKMimeHdrFieldsClear
INKMimeHdrFieldsCount
INKMimeHdrLengthGet
INKMimeHdrParse
INKMimeParserClear
INKMimeParserCreate
INKMimeParserDestroy
INKMimeHdrPrint
Mutex Functions
INKMutexCreate
INKMutexLock
INKMutexLockTry
INKMutexUnlock
Continuation Functions
INKContCall
INKContCreate
INKContDataGet
INKContDataSet
INKContDestroy
INKContMutexGet
INKContSchedule
Plugin Configuration Functions
INKConfigDataGet
INKConfigGet
INKConfigRelease
INKConfigSet
Action Functions
INKActionCancel
INKActionDone
Host Lookup Functions
INKHostLookup
INKHostLookupResultIPGet
Vconnection Functions
INKVConnAbort
INKVConnClose
INKVConnClosedGet
INKVConnRead
INKVConnReadVIOGet
INKVConnShutdown
INKVConnWrite
INKVConnWriteVIOGet
Netvconnection Functions
INKNetAccept
INKNetConnect
INKNetVConnRemoteIPGet
INKNetVConnRemotePortGet
Cache Interface Functions
INKCacheKeyCreate
INKCacheKeyDigestSet
INKCacheKeyHostNameSet
INKCacheKeyDestroy
INKCacheRead
INKCacheReady
INKCacheWrite
INKCacheRemove
INKCacheKeyPinnedSet
INKVConnCacheObjectSizeGet
Transformation Functions
INKTransformCreate
INKTransformOutputVConnGet
VIO Functions
INKVIOBufferGet
INKVIOVConnGet
INKVIOContGet
INKVIOMutexGet
INKVIONBytesGet
INKVIONBytesSet
INKVIONDoneGet
INKVIONDoneSet
INKVIONTodoGet
INKVIOReaderGet
INKVIOReenable
IO Buffer Interface
INKIOBufferBlockNext
INKIOBufferBlockReadAvail
INKIOBufferBlockReadStart
INKIOBufferBlockWriteAvail
INKIOBufferBlockWriteStart
INKIOBufferCopy
INKIOBufferCreate
INKIOBufferDestroy
INKIOBufferProduce
INKIOBufferReaderAlloc
INKIOBufferReaderAvail
INKIOBufferReaderClone
INKIOBufferReaderConsume
INKIOBufferReaderFree
INKIOBufferReaderStart
INKIOBufferSizedCreate
INKIOBufferStart
INKIOBufferWaterMarkGet
INKIOBufferWaterMarkSet
INKIOBufferWrite
Management Interface Functions
INKMgmtUpdateRegister
Traffic Server Configuration Read Functions
INKMgmtCounterGet
INKMgmtFloatGet
INKMgmtIntGet
INKMgmtStringGet
Customer Installation and Licensing Functions
INKInstallDirGet
INKPluginDirGet
INKPluginLicenseRequired
Statistics Functions
Uncoupled Statistics
INKStatFloatGet
INKStatIntGet
INKStatFloatAddTo
INKStatIntAddTo
INKStatCreate
INKStatDecrement
INKStatIncrement
INKStatFloatSet
INKStatIntSet
Coupled Statistics
INKStatCoupledGlobalAdd
INKStatCoupledLocalAdd
INKStatCoupledGlobalCategoryCreate
INKStatCoupledLocalCopyCreate
INKStatCoupledLocalCopyDestroy
INKStatsCoupledUpdate
Logging Functions
INKTextLogObjectCreate
INKTextLogObjectHeaderSet
INKTextLogObjectRollingEnabledSet
INKTextLogObjectRollingIntervalSecSet
INKTextLogObjectRollingOffsetHrSet
INKTextLogObjectWrite
INKTextLogObjectFlush
INKTextLogObjectDestroy

This chapter provides a description of each function in the Traffic Server API. The functions are grouped according to what they do. The following section lists all the function groups; to look up functions alphabetically, use the Function Index.

List of Function Groups