Implements callin functions for TSAPI plugins. More...

#include <stdio.h>
#include "libts.h"
#include "I_Layout.h"
#include "ts.h"
#include "InkAPIInternal.h"
#include "Log.h"
#include "URL.h"
#include "MIME.h"
#include "HTTP.h"
#include "HttpClientSession.h"
#include "HttpServerSession.h"
#include "HttpSM.h"
#include "HttpConfig.h"
#include "P_Net.h"
#include "P_UDPNet.h"
#include "P_HostDB.h"
#include "StatSystem.h"
#include "P_Cache.h"
#include "I_RecCore.h"
#include "I_RecSignals.h"
#include "ProxyConfig.h"
#include "Plugin.h"
#include "LogObject.h"
#include "LogConfig.h"
#include "PluginVC.h"
#include "api/ts/experimental.h"
#include "ICP.h"
#include "HttpSessionAccept.h"
#include "FetchSM.h"
#include "HttpDebugNames.h"
#include "I_AIO.h"
#include "I_Tasks.h"
#include "I_RecDefs.h"
#include "HttpProxyServerMain.h"

Include dependency graph for InkAPI.cc:

Go to the source code of this file.

Data Structures
struct	_STATE_ARG_TABLE
class	TSHttpSsnCallback
class	TSHttpSMCallback
struct	ActionSink
Defines
#define	SET_HTTP_HDR(_HDR, _BUF_PTR, _OBJ_PTR)
#define	sdk_assert(EX) ( (void)((EX) ? (void)0 : _TSReleaseAssert(#EX, __FILE__, __LINE__)) )
Typedefs
typedef const char (URL::	URLPartGetF )(int *length)
typedef void(URL::*	URLPartSetF )(const char *value, int length)
Functions
void	ts_session_protocol_well_known_name_indices_init ()
	Session Protocol initialization.
void	TSError (const char *fmt,...)
void	_TSReleaseAssert (const char text, const char file, int line)
int	_TSAssert (const char , const char , int)
MIMEHdrImpl *	_hdr_obj_to_mime_hdr_impl (HdrHeapObjImpl *obj)
MIMEHdrImpl *	_hdr_mloc_to_mime_hdr_impl (TSMLoc mloc)
TSReturnCode	sdk_sanity_check_field_handle (TSMLoc field, TSMLoc parent_hdr=NULL)
TSReturnCode	sdk_sanity_check_mbuffer (TSMBuffer bufp)
TSReturnCode	sdk_sanity_check_mime_hdr_handle (TSMLoc field)
TSReturnCode	sdk_sanity_check_url_handle (TSMLoc field)
TSReturnCode	sdk_sanity_check_http_hdr_handle (TSMLoc field)
TSReturnCode	sdk_sanity_check_continuation (TSCont cont)
TSReturnCode	sdk_sanity_check_fetch_sm (TSFetchSM fetch_sm)
TSReturnCode	sdk_sanity_check_http_ssn (TSHttpSsn ssnp)
TSReturnCode	sdk_sanity_check_txn (TSHttpTxn txnp)
TSReturnCode	sdk_sanity_check_mime_parser (TSMimeParser parser)
TSReturnCode	sdk_sanity_check_http_parser (TSHttpParser parser)
TSReturnCode	sdk_sanity_check_alt_info (TSHttpAltInfo info)
TSReturnCode	sdk_sanity_check_hook_id (TSHttpHookID id)
TSReturnCode	sdk_sanity_check_lifecycle_hook_id (TSLifecycleHookID id)
TSReturnCode	sdk_sanity_check_null_ptr (void *ptr)
bool	isWriteable (TSMBuffer bufp)
	The function checks if the buffer is Modifiable and returns true if it is modifiable, else returns false.
static MIMEFieldSDKHandle *	sdk_alloc_field_handle (TSMBuffer, MIMEHdrImpl *mh)
static void	sdk_free_field_handle (TSMBuffer bufp, MIMEFieldSDKHandle *field_handle)
void	api_init ()
void *	_TSmalloc (size_t size, const char *)
void *	_TSrealloc (void ptr, size_t size, const char )
char *	_TSstrdup (const char str, int64_t length, const char path)
size_t	_TSstrlcpy (char dst, const char str, size_t siz)
size_t	_TSstrlcat (char dst, const char str, size_t siz)
void	_TSfree (void *ptr)
TSReturnCode	TSBase64Decode (const char str, size_t str_len, unsigned char dst, size_t dst_size, size_t *length)
TSReturnCode	TSBase64Encode (const char str, size_t str_len, char dst, size_t dst_size, size_t *length)
unsigned int	TSrandom ()
double	TSdrandom ()
ink_hrtime	TShrtime ()
const char *	TSInstallDirGet (void)
	Gets the path of the directory in which Traffic Server is installed.
const char *	TSConfigDirGet (void)
	Gets the path of the directory of Traffic Server configuration.
const char *	TSTrafficServerVersionGet (void)
	Gets the version of Traffic Server currently running.
int	TSTrafficServerVersionGetMajor ()
	Get the major version of Traffic Server currently running.
int	TSTrafficServerVersionGetMinor ()
	Get the minor version of Traffic Server currently running.
int	TSTrafficServerVersionGetPatch ()
	Get the patch version of Traffic Server currently running.
const char *	TSPluginDirGet (void)
	Gets the path of the plugin directory relative to the Traffic Server install directory.
TSReturnCode	TSPluginRegister (TSSDKVersion sdk_version, TSPluginRegistrationInfo *plugin_info)
	This function registers your plugin with a particular version of Traffic Server SDK.
TSFile	TSfopen (const char filename, const char mode)
	Opens a file for reading or writing and returns a descriptor for accessing the file.
void	TSfclose (TSFile filep)
	Closes the file to which filep points and frees the data structures and buffers associated with it.
size_t	TSfread (TSFile filep, void *buf, size_t length)
	Attempts to read length bytes of data from the file pointed to by filep into the buffer buf.
size_t	TSfwrite (TSFile filep, const void *buf, size_t length)
	Attempts to write length bytes of data from the buffer buf to the file filep.
void	TSfflush (TSFile filep)
	Flushes pending data that has been buffered up in memory from previous calls to TSfwrite().
char *	TSfgets (TSFile filep, char *buf, size_t length)
	Reads a line from the file pointed to by filep into the buffer buf.
TSReturnCode	TSHandleMLocRelease (TSMBuffer bufp, TSMLoc parent, TSMLoc mloc)
	Releases the TSMLoc mloc created from the TSMLoc parent.
TSMBuffer	TSMBufferCreate (void)
	Creates a new marshal buffer and initializes the reference count to 1.
TSReturnCode	TSMBufferDestroy (TSMBuffer bufp)
	Ignores the reference count and destroys the marshal buffer bufp.
TSReturnCode	TSUrlCreate (TSMBuffer bufp, TSMLoc *locp)
	Creates a new URL within the marshal buffer bufp.
TSReturnCode	TSUrlDestroy (TSMBuffer, TSMLoc)
	Destroys the URL located at url_loc within the marshal buffer bufp.
TSReturnCode	TSUrlClone (TSMBuffer dest_bufp, TSMBuffer src_bufp, TSMLoc src_url, TSMLoc *locp)
	Copies the URL located at src_url within src_bufp to a URL location within the marshal buffer dest_bufp, and returns the TSMLoc location of the copied URL.
TSReturnCode	TSUrlCopy (TSMBuffer dest_bufp, TSMLoc dest_obj, TSMBuffer src_bufp, TSMLoc src_obj)
	Copies the contents of the URL at location src_loc within the marshal buffer src_bufp to the location dest_loc within the marshal buffer dest_bufp.
void	TSUrlPrint (TSMBuffer bufp, TSMLoc obj, TSIOBuffer iobufp)
	Formats a URL stored in an TSMBuffer into an TSIOBuffer.
TSParseResult	TSUrlParse (TSMBuffer bufp, TSMLoc obj, const char *start, const char end)
	Parses a URL.
int	TSUrlLengthGet (TSMBuffer bufp, TSMLoc obj)
	Calculates the length of the URL located at url_loc within the marshal buffer bufp if it were returned as a string.
char *	TSUrlStringGet (TSMBuffer bufp, TSMLoc obj, int *length)
	Constructs a string representation of the URL located at url_loc within bufp.
static const char *	URLPartGet (TSMBuffer bufp, TSMLoc obj, int *length, URLPartGetF url_f)
static TSReturnCode	URLPartSet (TSMBuffer bufp, TSMLoc obj, const char *value, int length, URLPartSetF url_f)
const char *	TSUrlSchemeGet (TSMBuffer bufp, TSMLoc obj, int *length)
	Retrieves the scheme portion of the URL located at url_loc within the marshal buffer bufp.
TSReturnCode	TSUrlSchemeSet (TSMBuffer bufp, TSMLoc obj, const char *value, int length)
	Sets the scheme portion of the URL located at url_loc within the marshal buffer bufp to the string value.
const char *	TSUrlUserGet (TSMBuffer bufp, TSMLoc obj, int *length)
	Retrieves the user portion of the URL located at url_loc within bufp.
TSReturnCode	TSUrlUserSet (TSMBuffer bufp, TSMLoc obj, const char *value, int length)
	Sets the user portion of the URL located at url_loc within bufp to the string value.
const char *	TSUrlPasswordGet (TSMBuffer bufp, TSMLoc obj, int *length)
	Retrieves the password portion of the URL located at url_loc within bufp.
TSReturnCode	TSUrlPasswordSet (TSMBuffer bufp, TSMLoc obj, const char *value, int length)
	Sets the password portion of the URL located at url_loc within bufp to the string value.
const char *	TSUrlHostGet (TSMBuffer bufp, TSMLoc obj, int *length)
	Retrieves the host portion of the URL located at url_loc within bufp.
TSReturnCode	TSUrlHostSet (TSMBuffer bufp, TSMLoc obj, const char *value, int length)
	Sets the host portion of the URL at url_loc to the string value.
int	TSUrlPortGet (TSMBuffer bufp, TSMLoc obj)
	Retrieves the port portion of the URL located at url_loc.
TSReturnCode	TSUrlPortSet (TSMBuffer bufp, TSMLoc obj, int port)
	Sets the port portion of the URL located at url_loc.
const char *	TSUrlPathGet (TSMBuffer bufp, TSMLoc obj, int *length)
	Retrieves the path portion of the URL located at url_loc within bufp.
TSReturnCode	TSUrlPathSet (TSMBuffer bufp, TSMLoc obj, const char *value, int length)
	Sets the path portion of the URL located at url_loc within bufp to the string value.
int	TSUrlFtpTypeGet (TSMBuffer bufp, TSMLoc obj)
	Retrieves the FTP type of the URL located at url_loc within bufp.
TSReturnCode	TSUrlFtpTypeSet (TSMBuffer bufp, TSMLoc obj, int type)
	Sets the FTP type portion of the URL located at url_loc within bufp to the value type.
const char *	TSUrlHttpParamsGet (TSMBuffer bufp, TSMLoc obj, int *length)
	Retrieves the HTTP params portion of the URL located at url_loc within bufp.
TSReturnCode	TSUrlHttpParamsSet (TSMBuffer bufp, TSMLoc obj, const char *value, int length)
	Sets the HTTP params portion of the URL located at url_loc within bufp to the string value.
const char *	TSUrlHttpQueryGet (TSMBuffer bufp, TSMLoc obj, int *length)
	Retrieves the HTTP query portion of the URL located at url_loc within bufp.
TSReturnCode	TSUrlHttpQuerySet (TSMBuffer bufp, TSMLoc obj, const char *value, int length)
	Sets the HTTP query portion of the URL located at url_loc within bufp to value.
const char *	TSUrlHttpFragmentGet (TSMBuffer bufp, TSMLoc obj, int *length)
	Retrieves the HTTP fragment portion of the URL located at url_loc within bufp.
TSReturnCode	TSUrlHttpFragmentSet (TSMBuffer bufp, TSMLoc obj, const char *value, int length)
	Sets the HTTP fragment portion of the URL located at url_loc within bufp to value.
TSReturnCode	TSStringPercentEncode (const char str, int str_len, char dst, size_t dst_size, size_t length, const unsigned char map)
	Perform percent-encoding of the string in the buffer, storing the new string in the destination buffer.
TSReturnCode	TSStringPercentDecode (const char str, size_t str_len, char dst, size_t dst_size, size_t *length)
	Perform percent-decoding of the string in the buffer, writing to the output buffer.
TSReturnCode	TSUrlPercentEncode (TSMBuffer bufp, TSMLoc obj, char dst, size_t dst_size, size_t length, const unsigned char *map)
	Similar to TSStringPercentEncode(), but works on a URL object.
TSMimeParser	TSMimeParserCreate (void)
	Creates a MIME parser.
void	TSMimeParserClear (TSMimeParser parser)
	Clears the specified MIME parser so that it can be used again.
void	TSMimeParserDestroy (TSMimeParser parser)
	Destroys the specified MIME parser and frees the associated memory.
TSReturnCode	TSMimeHdrCreate (TSMBuffer bufp, TSMLoc *locp)
	Creates a new MIME header within bufp.
TSReturnCode	TSMimeHdrDestroy (TSMBuffer bufp, TSMLoc obj)
	Destroys the MIME header located at hdr_loc within bufp.
TSReturnCode	TSMimeHdrClone (TSMBuffer dest_bufp, TSMBuffer src_bufp, TSMLoc src_hdr, TSMLoc *locp)
	Copies a specified MIME header to a specified marshal buffer, and returns the location of the copied MIME header within the destination marshal buffer.
TSReturnCode	TSMimeHdrCopy (TSMBuffer dest_bufp, TSMLoc dest_obj, TSMBuffer src_bufp, TSMLoc src_obj)
	Copies the contents of the MIME header located at src_loc within src_bufp to the MIME header located at dest_loc within dest_bufp.
void	TSMimeHdrPrint (TSMBuffer bufp, TSMLoc obj, TSIOBuffer iobufp)
	Formats the MIME header located at hdr_loc within bufp into the TSIOBuffer iobufp.
TSParseResult	TSMimeHdrParse (TSMimeParser parser, TSMBuffer bufp, TSMLoc obj, const char *start, const char end)
	Parses a MIME header.
int	TSMimeHdrLengthGet (TSMBuffer bufp, TSMLoc obj)
	Calculates the length of the MIME header located at hdr_loc if it were returned as a string.
TSReturnCode	TSMimeHdrFieldsClear (TSMBuffer bufp, TSMLoc obj)
	Removes and destroys all the MIME fields within the MIME header located at hdr_loc within the marshal buffer bufp.
int	TSMimeHdrFieldsCount (TSMBuffer bufp, TSMLoc obj)
	Returns a count of the number of MIME fields within the MIME header located at hdr_loc within the marshal buffer bufp.
const char *	TSMimeFieldValueGet (TSMBuffer, TSMLoc field_obj, int idx, int *value_len_ptr)
void	TSMimeFieldValueSet (TSMBuffer bufp, TSMLoc field_obj, int idx, const char *value, int length)
void	TSMimeFieldValueInsert (TSMBuffer bufp, TSMLoc field_obj, const char *value, int length, int idx)
int	TSMimeHdrFieldEqual (TSMBuffer bufp, TSMLoc hdr_obj, TSMLoc field1_obj, TSMLoc field2_obj)
TSMLoc	TSMimeHdrFieldGet (TSMBuffer bufp, TSMLoc hdr_obj, int idx)
	Retrieves the location of a specified MIME field within the MIME header located at hdr_loc within bufp.
TSMLoc	TSMimeHdrFieldFind (TSMBuffer bufp, TSMLoc hdr_obj, const char *name, int length)
	Retrieves the TSMLoc location of a specified MIME field from within the MIME header located at hdr.
TSReturnCode	TSMimeHdrFieldAppend (TSMBuffer bufp, TSMLoc mh_mloc, TSMLoc field_mloc)
	Returns the TSMLoc location of a specified MIME field from within the MIME header located at hdr.
TSReturnCode	TSMimeHdrFieldRemove (TSMBuffer bufp, TSMLoc mh_mloc, TSMLoc field_mloc)
	Removes the MIME field located at field within bufp from the header located at hdr within bufp.
TSReturnCode	TSMimeHdrFieldDestroy (TSMBuffer bufp, TSMLoc mh_mloc, TSMLoc field_mloc)
	Destroys the MIME field located at field within bufp.
TSReturnCode	TSMimeHdrFieldCreate (TSMBuffer bufp, TSMLoc mh_mloc, TSMLoc *locp)
TSReturnCode	TSMimeHdrFieldCreateNamed (TSMBuffer bufp, TSMLoc mh_mloc, const char name, int name_len, TSMLoc locp)
TSReturnCode	TSMimeHdrFieldCopy (TSMBuffer dest_bufp, TSMLoc dest_hdr, TSMLoc dest_field, TSMBuffer src_bufp, TSMLoc src_hdr, TSMLoc src_field)
TSReturnCode	TSMimeHdrFieldClone (TSMBuffer dest_bufp, TSMLoc dest_hdr, TSMBuffer src_bufp, TSMLoc src_hdr, TSMLoc src_field, TSMLoc *locp)
TSReturnCode	TSMimeHdrFieldCopyValues (TSMBuffer dest_bufp, TSMLoc dest_hdr, TSMLoc dest_field, TSMBuffer src_bufp, TSMLoc src_hdr, TSMLoc src_field)
TSMLoc	TSMimeHdrFieldNext (TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
TSMLoc	TSMimeHdrFieldNextDup (TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
int	TSMimeHdrFieldLengthGet (TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
const char *	TSMimeHdrFieldNameGet (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int *length)
TSReturnCode	TSMimeHdrFieldNameSet (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, const char *name, int length)
TSReturnCode	TSMimeHdrFieldValuesClear (TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
int	TSMimeHdrFieldValuesCount (TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
const char *	TSMimeHdrFieldValueStringGet (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, int *value_len_ptr)
time_t	TSMimeHdrFieldValueDateGet (TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
int	TSMimeHdrFieldValueIntGet (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx)
int64_t	TSMimeHdrFieldValueInt64Get (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx)
unsigned int	TSMimeHdrFieldValueUintGet (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx)
TSReturnCode	TSMimeHdrFieldValueStringSet (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, const char *value, int length)
TSReturnCode	TSMimeHdrFieldValueDateSet (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, time_t value)
TSReturnCode	TSMimeHdrFieldValueIntSet (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, int value)
TSReturnCode	TSMimeHdrFieldValueInt64Set (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, int64_t value)
TSReturnCode	TSMimeHdrFieldValueUintSet (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, unsigned int value)
TSReturnCode	TSMimeHdrFieldValueAppend (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, const char *value, int length)
TSReturnCode	TSMimeHdrFieldValueStringInsert (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, const char *value, int length)
TSReturnCode	TSMimeHdrFieldValueIntInsert (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, int value)
TSReturnCode	TSMimeHdrFieldValueUintInsert (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, unsigned int value)
TSReturnCode	TSMimeHdrFieldValueDateInsert (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, time_t value)
TSReturnCode	TSMimeHdrFieldValueDelete (TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx)
TSHttpParser	TSHttpParserCreate (void)
void	TSHttpParserClear (TSHttpParser parser)
void	TSHttpParserDestroy (TSHttpParser parser)
TSMLoc	TSHttpHdrCreate (TSMBuffer bufp)
void	TSHttpHdrDestroy (TSMBuffer bufp, TSMLoc obj)
	Destroys the HTTP header located at hdr_loc within the marshal buffer bufp.
TSReturnCode	TSHttpHdrClone (TSMBuffer dest_bufp, TSMBuffer src_bufp, TSMLoc src_hdr, TSMLoc *locp)
TSReturnCode	TSHttpHdrCopy (TSMBuffer dest_bufp, TSMLoc dest_obj, TSMBuffer src_bufp, TSMLoc src_obj)
	Copies the contents of the HTTP header located at src_loc within src_bufp to the HTTP header located at dest_loc within dest_bufp.
void	TSHttpHdrPrint (TSMBuffer bufp, TSMLoc obj, TSIOBuffer iobufp)
TSParseResult	TSHttpHdrParseReq (TSHttpParser parser, TSMBuffer bufp, TSMLoc obj, const char *start, const char end)
	Parses an HTTP request header.
TSParseResult	TSHttpHdrParseResp (TSHttpParser parser, TSMBuffer bufp, TSMLoc obj, const char *start, const char end)
int	TSHttpHdrLengthGet (TSMBuffer bufp, TSMLoc obj)
TSHttpType	TSHttpHdrTypeGet (TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpHdrTypeSet (TSMBuffer bufp, TSMLoc obj, TSHttpType type)
int	TSHttpHdrVersionGet (TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpHdrVersionSet (TSMBuffer bufp, TSMLoc obj, int ver)
const char *	TSHttpHdrMethodGet (TSMBuffer bufp, TSMLoc obj, int *length)
TSReturnCode	TSHttpHdrMethodSet (TSMBuffer bufp, TSMLoc obj, const char *value, int length)
TSReturnCode	TSHttpHdrUrlGet (TSMBuffer bufp, TSMLoc obj, TSMLoc *locp)
TSReturnCode	TSHttpHdrUrlSet (TSMBuffer bufp, TSMLoc obj, TSMLoc url)
TSHttpStatus	TSHttpHdrStatusGet (TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpHdrStatusSet (TSMBuffer bufp, TSMLoc obj, TSHttpStatus status)
const char *	TSHttpHdrReasonGet (TSMBuffer bufp, TSMLoc obj, int *length)
TSReturnCode	TSHttpHdrReasonSet (TSMBuffer bufp, TSMLoc obj, const char *value, int length)
const char *	TSHttpHdrReasonLookup (TSHttpStatus status)
TSReturnCode	sdk_sanity_check_cachekey (TSCacheKey key)
TSCacheKey	TSCacheKeyCreate (void)
	Creates (allocates memory for) a new cache key.
TSReturnCode	TSCacheKeyDigestSet (TSCacheKey key, const char *input, int length)
	Generates a key for an object to be cached (written to the cache).
TSReturnCode	TSCacheKeyDigestFromUrlSet (TSCacheKey key, TSMLoc url)
TSReturnCode	TSCacheKeyDataTypeSet (TSCacheKey key, TSCacheDataType type)
TSReturnCode	TSCacheKeyHostNameSet (TSCacheKey key, const char *hostname, int host_len)
	Associates a host name to the cache key.
TSReturnCode	TSCacheKeyPinnedSet (TSCacheKey key, time_t pin_in_cache)
TSReturnCode	TSCacheKeyDestroy (TSCacheKey key)
	Destroys a cache key.
TSCacheHttpInfo	TSCacheHttpInfoCopy (TSCacheHttpInfo infop)
void	TSCacheHttpInfoReqGet (TSCacheHttpInfo infop, TSMBuffer bufp, TSMLoc obj)
void	TSCacheHttpInfoRespGet (TSCacheHttpInfo infop, TSMBuffer bufp, TSMLoc obj)
time_t	TSCacheHttpInfoReqSentTimeGet (TSCacheHttpInfo infop)
time_t	TSCacheHttpInfoRespReceivedTimeGet (TSCacheHttpInfo infop)
int64_t	TSCacheHttpInfoSizeGet (TSCacheHttpInfo infop)
void	TSCacheHttpInfoReqSet (TSCacheHttpInfo infop, TSMBuffer bufp, TSMLoc obj)
void	TSCacheHttpInfoRespSet (TSCacheHttpInfo infop, TSMBuffer bufp, TSMLoc obj)
int	TSCacheHttpInfoVector (TSCacheHttpInfo infop, void *data, int length)
void	TSCacheHttpInfoDestroy (TSCacheHttpInfo infop)
TSCacheHttpInfo	TSCacheHttpInfoCreate (void)
unsigned int	TSConfigSet (unsigned int id, void *data, TSConfigDestroyFunc funcp)
TSConfig	TSConfigGet (unsigned int id)
void	TSConfigRelease (unsigned int id, TSConfig configp)
void *	TSConfigDataGet (TSConfig configp)
void	TSMgmtUpdateRegister (TSCont contp, const char *plugin_name)
TSReturnCode	TSMgmtIntGet (const char var_name, TSMgmtInt result)
TSReturnCode	TSMgmtCounterGet (const char var_name, TSMgmtCounter result)
TSReturnCode	TSMgmtFloatGet (const char var_name, TSMgmtFloat result)
TSReturnCode	TSMgmtStringGet (const char var_name, TSMgmtString result)
TSCont	TSContCreate (TSEventFunc funcp, TSMutex mutexp)
void	TSContDestroy (TSCont contp)
void	TSContDataSet (TSCont contp, void *data)
void *	TSContDataGet (TSCont contp)
TSAction	TSContSchedule (TSCont contp, ink_hrtime timeout, TSThreadPool tp)
TSAction	TSContScheduleEvery (TSCont contp, ink_hrtime every, TSThreadPool tp)
TSAction	TSHttpSchedule (TSCont contp, TSHttpTxn txnp, ink_hrtime timeout)
int	TSContCall (TSCont contp, TSEvent event, void *edata)
TSMutex	TSContMutexGet (TSCont contp)
void	TSHttpHookAdd (TSHttpHookID id, TSCont contp)
void	TSLifecycleHookAdd (TSLifecycleHookID id, TSCont contp)
void	TSHttpIcpDynamicSet (int value)
void	TSHttpSsnHookAdd (TSHttpSsn ssnp, TSHttpHookID id, TSCont contp)
int	TSHttpSsnTransactionCount (TSHttpSsn ssnp)
void	TSHttpSsnReenable (TSHttpSsn ssnp, TSEvent event)
void	TSHttpTxnHookAdd (TSHttpTxn txnp, TSHttpHookID id, TSCont contp)
TSReturnCode	TSHttpTxnHookRegisteredFor (TSHttpTxn txnp, TSHttpHookID id, TSEventFunc funcp)
TSHttpSsn	TSHttpTxnSsnGet (TSHttpTxn txnp)
void	TSHttpTxnClientKeepaliveSet (TSHttpTxn txnp, int set)
TSReturnCode	TSHttpTxnClientReqGet (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpTxnPristineUrlGet (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc url_loc)
char *	TSHttpTxnEffectiveUrlStringGet (TSHttpTxn txnp, int *length)
	Get the effective URL for the transaction.
TSReturnCode	TSHttpTxnClientRespGet (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpTxnServerReqGet (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpTxnServerRespGet (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpTxnCachedReqGet (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpTxnCachedRespGet (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpTxnCachedRespModifiableGet (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpTxnCacheLookupStatusGet (TSHttpTxn txnp, int *lookup_status)
TSReturnCode	TSHttpTxnCacheLookupCountGet (TSHttpTxn txnp, int *lookup_count)
TSReturnCode	TSHttpTxnCacheLookupStatusSet (TSHttpTxn txnp, int cachelookup)
TSReturnCode	TSHttpTxnCacheLookupUrlGet (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpTxnNewCacheLookupDo (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc url_loc)
TSReturnCode	TSHttpTxnSecondUrlTryLock (TSHttpTxn txnp)
TSReturnCode	TSHttpTxnRedirectRequest (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc url_loc)
void	TSHttpTxnActiveTimeoutSet (TSHttpTxn txnp, int timeout)
	timeout is in msec overrides as proxy.config.http.transaction_active_timeout_out
void	TSHttpTxnConnectTimeoutSet (TSHttpTxn txnp, int timeout)
	timeout is in msec overrides as proxy.config.http.connect_attempts_timeout
void	TSHttpTxnDNSTimeoutSet (TSHttpTxn txnp, int timeout)
	timeout is in msec overrides as proxy.config.dns.lookup_timeout
void	TSHttpTxnNoActivityTimeoutSet (TSHttpTxn txnp, int timeout)
	timeout is in msec overrides as proxy.config.http.transaction_no_activity_timeout_out
TSReturnCode	TSHttpTxnServerRespNoStoreSet (TSHttpTxn txnp, int flag)
	Set flag indicating whether or not to cache the server response for given TSHttpTxn.
TSReturnCode	TSHttpTxnServerRespIgnore (TSHttpTxn txnp)
TSReturnCode	TSHttpTxnShutDown (TSHttpTxn txnp, TSEvent event)
TSReturnCode	TSHttpTxnAborted (TSHttpTxn txnp)
	Check if transaction was aborted (due client/server errors etc.
void	TSHttpTxnReqCacheableSet (TSHttpTxn txnp, int flag)
void	TSHttpTxnRespCacheableSet (TSHttpTxn txnp, int flag)
int	TSHttpTxnClientReqIsServerStyle (TSHttpTxn txnp)
void	TSHttpTxnOverwriteExpireTime (TSHttpTxn txnp, time_t expire_time)
TSReturnCode	TSHttpTxnUpdateCachedObject (TSHttpTxn txnp)
TSReturnCode	TSHttpTxnTransformRespGet (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc obj)
void *	TSHttpSsnSSLConnectionGet (TSHttpSsn ssnp)
	Get SSL object of this session.
sockaddr const *	TSHttpSsnClientAddrGet (TSHttpSsn ssnp)
sockaddr const *	TSHttpTxnClientAddrGet (TSHttpTxn txnp)
	Get client address for transaction txnp.
sockaddr const *	TSHttpSsnIncomingAddrGet (TSHttpSsn ssnp)
sockaddr const *	TSHttpTxnIncomingAddrGet (TSHttpTxn txnp)
	Get the incoming address.
sockaddr const *	TSHttpTxnServerAddrGet (TSHttpTxn txnp)
	Get the origin server address.
TSReturnCode	TSHttpTxnServerAddrSet (TSHttpTxn txnp, struct sockaddr const *addr)
	Set the origin server address.
void	TSHttpTxnClientIncomingPortSet (TSHttpTxn txnp, int port)
TSReturnCode	TSHttpTxnOutgoingAddrSet (TSHttpTxn txnp, const struct sockaddr *addr)
sockaddr const *	TSHttpTxnNextHopAddrGet (TSHttpTxn txnp)
	Get the next hop address.
TSReturnCode	TSHttpTxnOutgoingTransparencySet (TSHttpTxn txnp, int flag)
TSReturnCode	TSHttpTxnClientPacketMarkSet (TSHttpTxn txnp, int mark)
	Change packet firewall mark for the client side connection.
TSReturnCode	TSHttpTxnServerPacketMarkSet (TSHttpTxn txnp, int mark)
	Change packet firewall mark for the server side connection.
TSReturnCode	TSHttpTxnClientPacketTosSet (TSHttpTxn txnp, int tos)
	Change packet TOS for the client side connection.
TSReturnCode	TSHttpTxnServerPacketTosSet (TSHttpTxn txnp, int tos)
	Change packet TOS for the server side connection.
void	TSHttpTxnErrorBodySet (TSHttpTxn txnp, char buf, size_t buflength, char mimetype)
	Sets an error type body to a transaction.
void	TSHttpTxnServerRequestBodySet (TSHttpTxn txnp, char *buf, int64_t buflength)
TSReturnCode	TSHttpTxnParentProxyGet (TSHttpTxn txnp, char *hostname, int port)
	Retrieves the parent proxy hostname and port, if parent proxying is enabled.
void	TSHttpTxnParentProxySet (TSHttpTxn txnp, char *hostname, int port)
	Sets the parent proxy name and port.
void	TSHttpTxnUntransformedRespCache (TSHttpTxn txnp, int on)
void	TSHttpTxnTransformedRespCache (TSHttpTxn txnp, int on)
void	TSHttpTxnReenable (TSHttpTxn txnp, TSEvent event)
	Notifies the HTTP transaction txnp that the plugin is finished processing the current hook.
TSReturnCode	TSHttpArgIndexReserve (const char name, const char description, int *arg_idx)
TSReturnCode	TSHttpArgIndexLookup (int arg_idx, const char name, const char description)
TSReturnCode	TSHttpArgIndexNameLookup (const char name, int arg_idx, const char **description)
void	TSHttpTxnArgSet (TSHttpTxn txnp, int arg_idx, void *arg)
void *	TSHttpTxnArgGet (TSHttpTxn txnp, int arg_idx)
void	TSHttpSsnArgSet (TSHttpSsn ssnp, int arg_idx, void *arg)
void *	TSHttpSsnArgGet (TSHttpSsn ssnp, int arg_idx)
void	TSHttpTxnSetHttpRetStatus (TSHttpTxn txnp, TSHttpStatus http_retstatus)
TSReturnCode	TSHttpTxnCntl (TSHttpTxn txnp, TSHttpCntlType cntl, void *data)
TSServerState	TSHttpTxnServerStateGet (TSHttpTxn txnp)
void	TSHttpTxnDebugSet (TSHttpTxn txnp, int on)
	Set the transaction specific debugging flag for this transaction.
int	TSHttpTxnDebugGet (TSHttpTxn txnp)
	Returns the transaction specific debugging flag for this transaction.
void	TSHttpSsnDebugSet (TSHttpSsn ssnp, int on)
	Set the session specific debugging flag for this client session.
int	TSHttpSsnDebugGet (TSHttpSsn ssnp)
int	TSHttpTxnClientReqHdrBytesGet (TSHttpTxn txnp)
int64_t	TSHttpTxnClientReqBodyBytesGet (TSHttpTxn txnp)
int	TSHttpTxnServerReqHdrBytesGet (TSHttpTxn txnp)
int64_t	TSHttpTxnServerReqBodyBytesGet (TSHttpTxn txnp)
int	TSHttpTxnServerRespHdrBytesGet (TSHttpTxn txnp)
int64_t	TSHttpTxnServerRespBodyBytesGet (TSHttpTxn txnp)
int	TSHttpTxnClientRespHdrBytesGet (TSHttpTxn txnp)
int64_t	TSHttpTxnClientRespBodyBytesGet (TSHttpTxn txnp)
int	TSHttpTxnPushedRespHdrBytesGet (TSHttpTxn txnp)
int64_t	TSHttpTxnPushedRespBodyBytesGet (TSHttpTxn txnp)
TSReturnCode	TSHttpTxnMilestoneGet (TSHttpTxn txnp, TSMilestonesType milestone, ink_hrtime *time)
TSReturnCode	TSHttpTxnCachedRespTimeGet (TSHttpTxn txnp, time_t *resp_time)
int	TSHttpTxnLookingUpTypeGet (TSHttpTxn txnp)
int	TSHttpCurrentClientConnectionsGet (void)
int	TSHttpCurrentActiveClientConnectionsGet (void)
int	TSHttpCurrentIdleClientConnectionsGet (void)
int	TSHttpCurrentCacheConnectionsGet (void)
int	TSHttpCurrentServerConnectionsGet (void)
TSReturnCode	TSHttpAltInfoClientReqGet (TSHttpAltInfo infop, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpAltInfoCachedReqGet (TSHttpAltInfo infop, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSHttpAltInfoCachedRespGet (TSHttpAltInfo infop, TSMBuffer bufp, TSMLoc obj)
void	TSHttpAltInfoQualitySet (TSHttpAltInfo infop, float quality)
TSVConn	TSHttpConnectWithPluginId (sockaddr const addr, char const tag, int64_t id)
TSVConn	TSHttpConnect (sockaddr const *addr)
TSVConn	TSHttpConnectTransparent (sockaddr const client_addr, sockaddr const server_addr)
void	TSActionCancel (TSAction actionp)
int	TSActionDone (TSAction actionp)
TSVConn	TSVConnCreate (TSEventFunc event_funcp, TSMutex mutexp)
TSVConn	TSVConnFdCreate (int fd)
TSVIO	TSVConnReadVIOGet (TSVConn connp)
TSVIO	TSVConnWriteVIOGet (TSVConn connp)
int	TSVConnClosedGet (TSVConn connp)
TSVIO	TSVConnRead (TSVConn connp, TSCont contp, TSIOBuffer bufp, int64_t nbytes)
TSVIO	TSVConnWrite (TSVConn connp, TSCont contp, TSIOBufferReader readerp, int64_t nbytes)
void	TSVConnClose (TSVConn connp)
void	TSVConnAbort (TSVConn connp, int error)
void	TSVConnShutdown (TSVConn connp, int read, int write)
int64_t	TSVConnCacheObjectSizeGet (TSVConn connp)
void	TSVConnCacheHttpInfoSet (TSVConn connp, TSCacheHttpInfo infop)
TSVConn	TSTransformCreate (TSEventFunc event_funcp, TSHttpTxn txnp)
TSVConn	TSTransformOutputVConnGet (TSVConn connp)
void	TSHttpTxnServerIntercept (TSCont contp, TSHttpTxn txnp)
	Allows a plugin take over the servicing of the request as though it was the origin server.
void	TSHttpTxnIntercept (TSCont contp, TSHttpTxn txnp)
	Allows a plugin take over the servicing of the request as though it was the origin server.
void	TSVConnInactivityTimeoutSet (TSVConn connp, TSHRTime timeout)
void	TSVConnInactivityTimeoutCancel (TSVConn connp)
void	TSVConnActiveTimeoutSet (TSVConn connp, TSHRTime timeout)
void	TSVConnActiveTimeoutCancel (TSVConn connp)
sockaddr const *	TSNetVConnLocalAddrGet (TSVConn connp)
sockaddr const *	TSNetVConnRemoteAddrGet (TSVConn connp)
TSAction	TSNetConnect (TSCont contp, sockaddr const *addr)
TSAction	TSNetConnectTransparent (TSCont contp, sockaddr const client_addr, sockaddr const server_addr)
TSAction	TSNetAccept (TSCont contp, int port, int domain, int accept_threads)
bool	ssl_register_protocol (const char , Continuation )
bool	ssl_unregister_protocol (const char , Continuation )
TSReturnCode	TSNetAcceptNamedProtocol (TSCont, const char *)
	Listen on all SSL ports for connections for the specified protocol name.
TSAction	TSHostLookup (TSCont contp, const char *hostname, size_t namelen)
sockaddr const *	TSHostLookupResultAddrGet (TSHostLookupResult lookup_result)
TSReturnCode	TSCacheReady (int *is_ready)
TSReturnCode	TSCacheDataTypeReady (TSCacheDataType type, int *is_ready)
TSAction	TSCacheRead (TSCont contp, TSCacheKey key)
	Asks the Traffic Server cache if the object corresponding to key exists in the cache and can be read.
TSAction	TSCacheWrite (TSCont contp, TSCacheKey key)
	Asks the Traffic Server cache if contp can start writing the object (corresponding to key) to the cache.
TSAction	TSCacheRemove (TSCont contp, TSCacheKey key)
	Removes the object corresponding to key from the cache.
TSAction	TSCacheScan (TSCont contp, TSCacheKey key, int KB_per_second)
int	TSStatCreate (const char *the_name, TSRecordDataType the_type, TSStatPersistence persist, TSStatSync sync)
void	TSStatIntIncrement (int the_stat, TSMgmtInt amount)
void	TSStatIntDecrement (int the_stat, TSMgmtInt amount)
TSMgmtInt	TSStatIntGet (int the_stat)
void	TSStatIntSet (int the_stat, TSMgmtInt value)
TSReturnCode	TSStatFindName (const char name, int idp)
TSReturnCode	ink_sanity_check_stat_structure (void *obj)
int	TSIsDebugTagSet (const char *t)
void	TSDebugSpecific (int debug_flag, const char tag, const char format_str,...)
void	TSDebug (const char tag, const char format_str,...)
TSReturnCode	TSTextLogObjectCreate (const char filename, int mode, TSTextLogObject new_object)
	Creates a new custom log file that your plugin can write to.
TSReturnCode	TSTextLogObjectWrite (TSTextLogObject the_object, const char *format,...)
void	TSTextLogObjectFlush (TSTextLogObject the_object)
	This immediately flushes the contents of the log write buffer for the_object to disk.
TSReturnCode	TSTextLogObjectDestroy (TSTextLogObject the_object)
	Destroys a log object and releases the memory allocated to it.
void	TSTextLogObjectHeaderSet (TSTextLogObject the_object, const char *header)
	Set log header.
TSReturnCode	TSTextLogObjectRollingEnabledSet (TSTextLogObject the_object, int rolling_enabled)
	Enable/disable rolling.
void	TSTextLogObjectRollingIntervalSecSet (TSTextLogObject the_object, int rolling_interval_sec)
	Set the rolling interval.
void	TSTextLogObjectRollingOffsetHrSet (TSTextLogObject the_object, int rolling_offset_hr)
	Set the rolling offset.
TSReturnCode	TSHttpSsnClientFdGet (TSHttpSsn ssnp, int *fdp)
TSReturnCode	TSHttpTxnClientFdGet (TSHttpTxn txnp, int *fdp)
char *	TSMatcherReadIntoBuffer (char file_name, int file_len)
char *	TSMatcherTokLine (char buffer, char *last)
char *	TSMatcherExtractIPRange (char match_str, uint32_t addr1, uint32_t *addr2)
char *	TSMatcherExtractIPRange (char match_str, sockaddr addr1, sockaddr *addr2)
TSMatcherLine	TSMatcherLineCreate (void)
void	TSMatcherLineDestroy (TSMatcherLine ml)
const char *	TSMatcherParseSrcIPConfigLine (char *line, TSMatcherLine ml)
char *	TSMatcherLineName (TSMatcherLine ml, int element)
char *	TSMatcherLineValue (TSMatcherLine ml, int element)
TSReturnCode	TSMgmtConfigIntSet (const char *var_name, TSMgmtInt value)
void	TSICPFreshnessFuncSet (TSPluginFreshnessCalcFunc funcp)
TSReturnCode	TSICPCachedReqGet (TSCont contp, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSICPCachedRespGet (TSCont contp, TSMBuffer bufp, TSMLoc obj)
TSReturnCode	TSCacheUrlSet (TSHttpTxn txnp, const char *url, int length)
void	TSCacheHttpInfoKeySet (TSCacheHttpInfo infop, TSCacheKey keyp)
void	TSCacheHttpInfoSizeSet (TSCacheHttpInfo infop, int64_t size)
TSReturnCode	TSHttpTxnFollowRedirect (TSHttpTxn txnp, int on)
	This API informs the core to try to follow redirections (e.g.
void	TSHttpTxnRedirectUrlSet (TSHttpTxn txnp, const char *url, const int url_len)
	This is a generalization of the TSHttpTxnFollowRedirect(), but gives finer control over the behavior.
void	TSRedirectUrlSet (TSHttpTxn txnp, const char *url, const int url_len)
const char *	TSHttpTxnRedirectUrlGet (TSHttpTxn txnp, int *url_len_ptr)
	Return the current (if set) redirection URL string.
const char *	TSRedirectUrlGet (TSHttpTxn txnp, int *url_len_ptr)
int	TSHttpTxnRedirectRetries (TSHttpTxn txnp)
	Return the number of redirection retries we have done.
char *	TSFetchRespGet (TSHttpTxn txnp, int *length)
TSReturnCode	TSFetchPageRespGet (TSHttpTxn txnp, TSMBuffer bufp, TSMLoc obj)
void	TSFetchPages (TSFetchUrlParams_t *params)
void	TSFetchUrl (const char headers, int request_len, sockaddr const ip, TSCont contp, TSFetchWakeUpOptions callback_options, TSFetchEvent events)
TSFetchSM	TSFetchCreate (TSCont contp, const char method, const char url, const char version, struct sockaddr const client_addr, int flags)
	Extended FetchSM's AIPs.
void	TSFetchHeaderAdd (TSFetchSM fetch_sm, const char name, int name_len, const char value, int value_len)
void	TSFetchWriteData (TSFetchSM fetch_sm, const void *data, size_t len)
ssize_t	TSFetchReadData (TSFetchSM fetch_sm, void *buf, size_t len)
void	TSFetchLaunch (TSFetchSM fetch_sm)
void	TSFetchDestroy (TSFetchSM fetch_sm)
void	TSFetchUserDataSet (TSFetchSM fetch_sm, void *data)
void *	TSFetchUserDataGet (TSFetchSM fetch_sm)
TSMBuffer	TSFetchRespHdrMBufGet (TSFetchSM fetch_sm)
TSMLoc	TSFetchRespHdrMLocGet (TSFetchSM fetch_sm)
TSReturnCode	TSHttpIsInternalSession (TSHttpSsn ssnp)
TSReturnCode	TSHttpIsInternalRequest (TSHttpTxn txnp)
TSReturnCode	TSAIORead (int fd, off_t offset, char *buf, size_t buffSize, TSCont contp)
	Async disk IO read.
char *	TSAIOBufGet (TSAIOCallback data)
	Async disk IO buffer get.
int	TSAIONBytesGet (TSAIOCallback data)
	Async disk IO get number of bytes.
TSReturnCode	TSAIOWrite (int fd, off_t offset, char *buf, const size_t bufSize, TSCont contp)
	Async disk IO write.
TSReturnCode	TSAIOThreadNumSet (int thread_num)
	Async disk IO set number of threads.
void	TSRecordDump (int rec_type, TSRecordDumpCb callback, void *edata)
void	TSSkipRemappingSet (TSHttpTxn txnp, int flag)
static void *	_conf_to_memberp (TSOverridableConfigKey conf, OverridableHttpConfigParams overridableHttpConfig, OverridableDataType typep)
TSReturnCode	TSHttpTxnConfigIntSet (TSHttpTxn txnp, TSOverridableConfigKey conf, TSMgmtInt value)
TSReturnCode	TSHttpTxnConfigIntGet (TSHttpTxn txnp, TSOverridableConfigKey conf, TSMgmtInt *value)
TSReturnCode	TSHttpTxnConfigFloatSet (TSHttpTxn txnp, TSOverridableConfigKey conf, TSMgmtFloat value)
TSReturnCode	TSHttpTxnConfigFloatGet (TSHttpTxn txnp, TSOverridableConfigKey conf, TSMgmtFloat *value)
TSReturnCode	TSHttpTxnConfigStringSet (TSHttpTxn txnp, TSOverridableConfigKey conf, const char *value, int length)
TSReturnCode	TSHttpTxnConfigStringGet (TSHttpTxn txnp, TSOverridableConfigKey conf, const char *value, int length)
TSReturnCode	TSHttpTxnConfigFind (const char name, int length, TSOverridableConfigKey conf, TSRecordDataType *type)
TSReturnCode	TSHttpTxnPrivateSessionSet (TSHttpTxn txnp, int private_session)
TSReturnCode	TSMgmtStringCreate (TSRecordType rec_type, const char name, const TSMgmtString data_default, TSRecordUpdateType update_type, TSRecordCheckType check_type, const char check_regex, TSRecordAccessType access_type)
TSReturnCode	TSMgmtIntCreate (TSRecordType rec_type, const char name, TSMgmtInt data_default, TSRecordUpdateType update_type, TSRecordCheckType check_type, const char check_regex, TSRecordAccessType access_type)
TSReturnCode	TSHttpTxnCloseAfterResponse (TSHttpTxn txnp, int should_close)
TSPortDescriptor	TSPortDescriptorParse (const char *descriptor)
	Create a new port from the string specification used by the proxy.config.http.server_ports configuration value.
TSReturnCode	TSPortDescriptorAccept (TSPortDescriptor descp, TSCont contp)
	Start listening on the given port descriptor.
TSReturnCode	TSPluginDescriptorAccept (TSCont contp)
	Attempt to attach the contp continuation to sockets that have already been opened by the traffic manager and defined as belonging to plugins (based on records.config configuration).
int	TSHttpTxnBackgroundFillStarted (TSHttpTxn txnp)
int	TSHttpTxnIsCacheable (TSHttpTxn txnp, TSMBuffer request, TSMBuffer response)
	Test whether a request / response header pair would be cacheable under the current configuration.
const char *	TSHttpServerStateNameLookup (TSServerState state)
	Return a string respresentation for a TSServerState value.
const char *	TSHttpHookNameLookup (TSHttpHookID hook)
	Return a string respresentation for a TSHttpHookID value.
const char *	TSHttpEventNameLookup (TSEvent event)
	Return a string respresentation for a TSEvent value.
Variables
static volatile int	api_rsb_index = 0
static RecRawStatBlock *	api_rsb
static volatile int	next_argv_index = 0
struct _STATE_ARG_TABLE	state_arg_table [HTTP_SSN_TXN_MAX_USER_ARG]
tsapi const char *	TS_URL_SCHEME_FILE
tsapi const char *	TS_URL_SCHEME_FTP
tsapi const char *	TS_URL_SCHEME_GOPHER
tsapi const char *	TS_URL_SCHEME_HTTP
tsapi const char *	TS_URL_SCHEME_HTTPS
tsapi const char *	TS_URL_SCHEME_MAILTO
tsapi const char *	TS_URL_SCHEME_NEWS
tsapi const char *	TS_URL_SCHEME_NNTP
tsapi const char *	TS_URL_SCHEME_PROSPERO
tsapi const char *	TS_URL_SCHEME_TELNET
tsapi const char *	TS_URL_SCHEME_TUNNEL
tsapi const char *	TS_URL_SCHEME_WAIS
tsapi const char *	TS_URL_SCHEME_PNM
tsapi const char *	TS_URL_SCHEME_RTSP
tsapi const char *	TS_URL_SCHEME_RTSPU
tsapi const char *	TS_URL_SCHEME_MMS
tsapi const char *	TS_URL_SCHEME_MMSU
tsapi const char *	TS_URL_SCHEME_MMST
tsapi int	TS_URL_LEN_FILE
tsapi int	TS_URL_LEN_FTP
tsapi int	TS_URL_LEN_GOPHER
tsapi int	TS_URL_LEN_HTTP
tsapi int	TS_URL_LEN_HTTPS
tsapi int	TS_URL_LEN_MAILTO
tsapi int	TS_URL_LEN_NEWS
tsapi int	TS_URL_LEN_NNTP
tsapi int	TS_URL_LEN_PROSPERO
tsapi int	TS_URL_LEN_TELNET
tsapi int	TS_URL_LEN_TUNNEL
tsapi int	TS_URL_LEN_WAIS
tsapi int	TS_URL_LEN_PNM
tsapi int	TS_URL_LEN_RTSP
tsapi int	TS_URL_LEN_RTSPU
tsapi int	TS_URL_LEN_MMS
tsapi int	TS_URL_LEN_MMSU
tsapi int	TS_URL_LEN_MMST
tsapi const char *	TS_MIME_FIELD_ACCEPT
tsapi const char *	TS_MIME_FIELD_ACCEPT_CHARSET
tsapi const char *	TS_MIME_FIELD_ACCEPT_ENCODING
tsapi const char *	TS_MIME_FIELD_ACCEPT_LANGUAGE
tsapi const char *	TS_MIME_FIELD_ACCEPT_RANGES
tsapi const char *	TS_MIME_FIELD_AGE
tsapi const char *	TS_MIME_FIELD_ALLOW
tsapi const char *	TS_MIME_FIELD_APPROVED
tsapi const char *	TS_MIME_FIELD_AUTHORIZATION
tsapi const char *	TS_MIME_FIELD_BYTES
tsapi const char *	TS_MIME_FIELD_CACHE_CONTROL
tsapi const char *	TS_MIME_FIELD_CLIENT_IP
tsapi const char *	TS_MIME_FIELD_CONNECTION
tsapi const char *	TS_MIME_FIELD_CONTENT_BASE
tsapi const char *	TS_MIME_FIELD_CONTENT_ENCODING
tsapi const char *	TS_MIME_FIELD_CONTENT_LANGUAGE
tsapi const char *	TS_MIME_FIELD_CONTENT_LENGTH
tsapi const char *	TS_MIME_FIELD_CONTENT_LOCATION
tsapi const char *	TS_MIME_FIELD_CONTENT_MD5
tsapi const char *	TS_MIME_FIELD_CONTENT_RANGE
tsapi const char *	TS_MIME_FIELD_CONTENT_TYPE
tsapi const char *	TS_MIME_FIELD_CONTROL
tsapi const char *	TS_MIME_FIELD_COOKIE
tsapi const char *	TS_MIME_FIELD_DATE
tsapi const char *	TS_MIME_FIELD_DISTRIBUTION
tsapi const char *	TS_MIME_FIELD_ETAG
tsapi const char *	TS_MIME_FIELD_EXPECT
tsapi const char *	TS_MIME_FIELD_EXPIRES
tsapi const char *	TS_MIME_FIELD_FOLLOWUP_TO
tsapi const char *	TS_MIME_FIELD_FROM
tsapi const char *	TS_MIME_FIELD_HOST
tsapi const char *	TS_MIME_FIELD_IF_MATCH
tsapi const char *	TS_MIME_FIELD_IF_MODIFIED_SINCE
tsapi const char *	TS_MIME_FIELD_IF_NONE_MATCH
tsapi const char *	TS_MIME_FIELD_IF_RANGE
tsapi const char *	TS_MIME_FIELD_IF_UNMODIFIED_SINCE
tsapi const char *	TS_MIME_FIELD_KEEP_ALIVE
tsapi const char *	TS_MIME_FIELD_KEYWORDS
tsapi const char *	TS_MIME_FIELD_LAST_MODIFIED
tsapi const char *	TS_MIME_FIELD_LINES
tsapi const char *	TS_MIME_FIELD_LOCATION
tsapi const char *	TS_MIME_FIELD_MAX_FORWARDS
tsapi const char *	TS_MIME_FIELD_MESSAGE_ID
tsapi const char *	TS_MIME_FIELD_NEWSGROUPS
tsapi const char *	TS_MIME_FIELD_ORGANIZATION
tsapi const char *	TS_MIME_FIELD_PATH
tsapi const char *	TS_MIME_FIELD_PRAGMA
tsapi const char *	TS_MIME_FIELD_PROXY_AUTHENTICATE
tsapi const char *	TS_MIME_FIELD_PROXY_AUTHORIZATION
tsapi const char *	TS_MIME_FIELD_PROXY_CONNECTION
tsapi const char *	TS_MIME_FIELD_PUBLIC
tsapi const char *	TS_MIME_FIELD_RANGE
tsapi const char *	TS_MIME_FIELD_REFERENCES
tsapi const char *	TS_MIME_FIELD_REFERER
tsapi const char *	TS_MIME_FIELD_REPLY_TO
tsapi const char *	TS_MIME_FIELD_RETRY_AFTER
tsapi const char *	TS_MIME_FIELD_SENDER
tsapi const char *	TS_MIME_FIELD_SERVER
tsapi const char *	TS_MIME_FIELD_SET_COOKIE
tsapi const char *	TS_MIME_FIELD_STRICT_TRANSPORT_SECURITY
tsapi const char *	TS_MIME_FIELD_SUBJECT
tsapi const char *	TS_MIME_FIELD_SUMMARY
tsapi const char *	TS_MIME_FIELD_TE
tsapi const char *	TS_MIME_FIELD_TRANSFER_ENCODING
tsapi const char *	TS_MIME_FIELD_UPGRADE
tsapi const char *	TS_MIME_FIELD_USER_AGENT
tsapi const char *	TS_MIME_FIELD_VARY
tsapi const char *	TS_MIME_FIELD_VIA
tsapi const char *	TS_MIME_FIELD_WARNING
tsapi const char *	TS_MIME_FIELD_WWW_AUTHENTICATE
tsapi const char *	TS_MIME_FIELD_XREF
tsapi const char *	TS_MIME_FIELD_X_FORWARDED_FOR
tsapi int	TS_MIME_LEN_ACCEPT
tsapi int	TS_MIME_LEN_ACCEPT_CHARSET
tsapi int	TS_MIME_LEN_ACCEPT_ENCODING
tsapi int	TS_MIME_LEN_ACCEPT_LANGUAGE
tsapi int	TS_MIME_LEN_ACCEPT_RANGES
tsapi int	TS_MIME_LEN_AGE
tsapi int	TS_MIME_LEN_ALLOW
tsapi int	TS_MIME_LEN_APPROVED
tsapi int	TS_MIME_LEN_AUTHORIZATION
tsapi int	TS_MIME_LEN_BYTES
tsapi int	TS_MIME_LEN_CACHE_CONTROL
tsapi int	TS_MIME_LEN_CLIENT_IP
tsapi int	TS_MIME_LEN_CONNECTION
tsapi int	TS_MIME_LEN_CONTENT_BASE
tsapi int	TS_MIME_LEN_CONTENT_ENCODING
tsapi int	TS_MIME_LEN_CONTENT_LANGUAGE
tsapi int	TS_MIME_LEN_CONTENT_LENGTH
tsapi int	TS_MIME_LEN_CONTENT_LOCATION
tsapi int	TS_MIME_LEN_CONTENT_MD5
tsapi int	TS_MIME_LEN_CONTENT_RANGE
tsapi int	TS_MIME_LEN_CONTENT_TYPE
tsapi int	TS_MIME_LEN_CONTROL
tsapi int	TS_MIME_LEN_COOKIE
tsapi int	TS_MIME_LEN_DATE
tsapi int	TS_MIME_LEN_DISTRIBUTION
tsapi int	TS_MIME_LEN_ETAG
tsapi int	TS_MIME_LEN_EXPECT
tsapi int	TS_MIME_LEN_EXPIRES
tsapi int	TS_MIME_LEN_FOLLOWUP_TO
tsapi int	TS_MIME_LEN_FROM
tsapi int	TS_MIME_LEN_HOST
tsapi int	TS_MIME_LEN_IF_MATCH
tsapi int	TS_MIME_LEN_IF_MODIFIED_SINCE
tsapi int	TS_MIME_LEN_IF_NONE_MATCH
tsapi int	TS_MIME_LEN_IF_RANGE
tsapi int	TS_MIME_LEN_IF_UNMODIFIED_SINCE
tsapi int	TS_MIME_LEN_KEEP_ALIVE
tsapi int	TS_MIME_LEN_KEYWORDS
tsapi int	TS_MIME_LEN_LAST_MODIFIED
tsapi int	TS_MIME_LEN_LINES
tsapi int	TS_MIME_LEN_LOCATION
tsapi int	TS_MIME_LEN_MAX_FORWARDS
tsapi int	TS_MIME_LEN_MESSAGE_ID
tsapi int	TS_MIME_LEN_NEWSGROUPS
tsapi int	TS_MIME_LEN_ORGANIZATION
tsapi int	TS_MIME_LEN_PATH
tsapi int	TS_MIME_LEN_PRAGMA
tsapi int	TS_MIME_LEN_PROXY_AUTHENTICATE
tsapi int	TS_MIME_LEN_PROXY_AUTHORIZATION
tsapi int	TS_MIME_LEN_PROXY_CONNECTION
tsapi int	TS_MIME_LEN_PUBLIC
tsapi int	TS_MIME_LEN_RANGE
tsapi int	TS_MIME_LEN_REFERENCES
tsapi int	TS_MIME_LEN_REFERER
tsapi int	TS_MIME_LEN_REPLY_TO
tsapi int	TS_MIME_LEN_RETRY_AFTER
tsapi int	TS_MIME_LEN_SENDER
tsapi int	TS_MIME_LEN_SERVER
tsapi int	TS_MIME_LEN_SET_COOKIE
tsapi int	TS_MIME_LEN_STRICT_TRANSPORT_SECURITY
tsapi int	TS_MIME_LEN_SUBJECT
tsapi int	TS_MIME_LEN_SUMMARY
tsapi int	TS_MIME_LEN_TE
tsapi int	TS_MIME_LEN_TRANSFER_ENCODING
tsapi int	TS_MIME_LEN_UPGRADE
tsapi int	TS_MIME_LEN_USER_AGENT
tsapi int	TS_MIME_LEN_VARY
tsapi int	TS_MIME_LEN_VIA
tsapi int	TS_MIME_LEN_WARNING
tsapi int	TS_MIME_LEN_WWW_AUTHENTICATE
tsapi int	TS_MIME_LEN_XREF
tsapi int	TS_MIME_LEN_X_FORWARDED_FOR
tsapi const char *	TS_HTTP_VALUE_BYTES
tsapi const char *	TS_HTTP_VALUE_CHUNKED
tsapi const char *	TS_HTTP_VALUE_CLOSE
tsapi const char *	TS_HTTP_VALUE_COMPRESS
tsapi const char *	TS_HTTP_VALUE_DEFLATE
tsapi const char *	TS_HTTP_VALUE_GZIP
tsapi const char *	TS_HTTP_VALUE_IDENTITY
tsapi const char *	TS_HTTP_VALUE_KEEP_ALIVE
tsapi const char *	TS_HTTP_VALUE_MAX_AGE
tsapi const char *	TS_HTTP_VALUE_MAX_STALE
tsapi const char *	TS_HTTP_VALUE_MIN_FRESH
tsapi const char *	TS_HTTP_VALUE_MUST_REVALIDATE
tsapi const char *	TS_HTTP_VALUE_NONE
tsapi const char *	TS_HTTP_VALUE_NO_CACHE
tsapi const char *	TS_HTTP_VALUE_NO_STORE
tsapi const char *	TS_HTTP_VALUE_NO_TRANSFORM
tsapi const char *	TS_HTTP_VALUE_ONLY_IF_CACHED
tsapi const char *	TS_HTTP_VALUE_PRIVATE
tsapi const char *	TS_HTTP_VALUE_PROXY_REVALIDATE
tsapi const char *	TS_HTTP_VALUE_PUBLIC
tsapi const char *	TS_HTTP_VALUE_S_MAXAGE
tsapi int	TS_HTTP_LEN_BYTES
tsapi int	TS_HTTP_LEN_CHUNKED
tsapi int	TS_HTTP_LEN_CLOSE
tsapi int	TS_HTTP_LEN_COMPRESS
tsapi int	TS_HTTP_LEN_DEFLATE
tsapi int	TS_HTTP_LEN_GZIP
tsapi int	TS_HTTP_LEN_IDENTITY
tsapi int	TS_HTTP_LEN_KEEP_ALIVE
tsapi int	TS_HTTP_LEN_MAX_AGE
tsapi int	TS_HTTP_LEN_MAX_STALE
tsapi int	TS_HTTP_LEN_MIN_FRESH
tsapi int	TS_HTTP_LEN_MUST_REVALIDATE
tsapi int	TS_HTTP_LEN_NONE
tsapi int	TS_HTTP_LEN_NO_CACHE
tsapi int	TS_HTTP_LEN_NO_STORE
tsapi int	TS_HTTP_LEN_NO_TRANSFORM
tsapi int	TS_HTTP_LEN_ONLY_IF_CACHED
tsapi int	TS_HTTP_LEN_PRIVATE
tsapi int	TS_HTTP_LEN_PROXY_REVALIDATE
tsapi int	TS_HTTP_LEN_PUBLIC
tsapi int	TS_HTTP_LEN_S_MAXAGE
tsapi const char *	TS_HTTP_METHOD_CONNECT
tsapi const char *	TS_HTTP_METHOD_DELETE
tsapi const char *	TS_HTTP_METHOD_GET
tsapi const char *	TS_HTTP_METHOD_HEAD
tsapi const char *	TS_HTTP_METHOD_ICP_QUERY
tsapi const char *	TS_HTTP_METHOD_OPTIONS
tsapi const char *	TS_HTTP_METHOD_POST
tsapi const char *	TS_HTTP_METHOD_PURGE
tsapi const char *	TS_HTTP_METHOD_PUT
tsapi const char *	TS_HTTP_METHOD_TRACE
tsapi const char *	TS_HTTP_METHOD_PUSH
tsapi int	TS_HTTP_LEN_CONNECT
tsapi int	TS_HTTP_LEN_DELETE
tsapi int	TS_HTTP_LEN_GET
tsapi int	TS_HTTP_LEN_HEAD
tsapi int	TS_HTTP_LEN_ICP_QUERY
tsapi int	TS_HTTP_LEN_OPTIONS
tsapi int	TS_HTTP_LEN_POST
tsapi int	TS_HTTP_LEN_PURGE
tsapi int	TS_HTTP_LEN_PUT
tsapi int	TS_HTTP_LEN_TRACE
tsapi int	TS_HTTP_LEN_PUSH
tsapi const TSMLoc	TS_NULL_MLOC = (TSMLoc)NULL
	Use TS_NULL_MLOC as the parent in calls that require a parent when an TSMLoc does not have a parent TSMLoc.
HttpAPIHooks *	http_global_hooks = NULL
LifecycleAPIHooks *	lifecycle_hooks = NULL
ConfigUpdateCbTable *	global_config_cbs = NULL
static char	traffic_server_version [128] = ""
static int	ts_major_version = 0
static int	ts_minor_version = 0
static int	ts_patch_version = 0
static ClassAllocator< APIHook >	apiHookAllocator ("apiHookAllocator")
static ClassAllocator < INKContInternal >	INKContAllocator ("INKContAllocator")
static ClassAllocator < INKVConnInternal >	INKVConnAllocator ("INKVConnAllocator")
static ClassAllocator < MIMEFieldSDKHandle >	mHandleAllocator ("MIMEFieldSDKHandle")
HttpSessionAccept *	plugin_http_accept
HttpSessionAccept *	plugin_http_transparent_accept
static ActionSink	a
ClassAllocator< FetchSM >	FetchSMAllocator

Detailed Description

Implements callin functions for TSAPI plugins.

License

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition in file InkAPI.cc.

Define Documentation

#define sdk_assert ( EX ) ( (void)((EX) ? (void)0 : _TSReleaseAssert(#EX, __FILE__, __LINE__)) )

Definition at line 426 of file InkAPI.cc.

#define SET_HTTP_HDR	(	_HDR,
		_BUF_PTR,
		_OBJ_PTR
	)

Value:

_HDR.m_heap = ((HdrHeapSDKHandle*) _BUF_PTR)->m_heap; \
    _HDR.m_http = (HTTPHdrImpl*) _OBJ_PTR; \
    _HDR.m_mime = _HDR.m_http->m_fields_impl;

Definition at line 79 of file InkAPI.cc.

Referenced by TSCacheHttpInfoReqSet(), TSCacheHttpInfoRespSet(), TSHttpHdrLengthGet(), TSHttpHdrMethodGet(), TSHttpHdrMethodSet(), TSHttpHdrParseReq(), TSHttpHdrParseResp(), TSHttpHdrPrint(), TSHttpHdrReasonGet(), TSHttpHdrReasonSet(), TSHttpHdrStatusGet(), TSHttpHdrStatusSet(), TSHttpHdrTypeGet(), TSHttpHdrTypeSet(), TSHttpHdrVersionGet(), and TSHttpHdrVersionSet().

Typedef Documentation

typedef const char*(URL::* URLPartGetF)(int *length)

Definition at line 2071 of file InkAPI.cc.

typedef void(URL::* URLPartSetF)(const char *value, int length)

Definition at line 2072 of file InkAPI.cc.

Function Documentation

static void* _conf_to_memberp	(	TSOverridableConfigKey	conf,
		OverridableHttpConfigParams *	overridableHttpConfig,
		OverridableDataType *	typep
	)			`[static]`

Definition at line 7508 of file InkAPI.cc.

Referenced by TSHttpTxnConfigFloatGet(), TSHttpTxnConfigFloatSet(), TSHttpTxnConfigIntGet(), and TSHttpTxnConfigIntSet().

MIMEHdrImpl* _hdr_mloc_to_mime_hdr_impl ( TSMLoc mloc ) [inline]

MIMEHdrImpl* _hdr_obj_to_mime_hdr_impl ( HdrHeapObjImpl * obj ) [inline]

Definition at line 484 of file InkAPI.cc.

References HDR_HEAP_OBJ_HTTP_HEADER, HDR_HEAP_OBJ_MIME_HEADER, ink_release_assert, and HdrHeapObjImpl::m_type.

Referenced by _hdr_mloc_to_mime_hdr_impl().

int _TSAssert	(	const char *	,
		const char *	,
		int
	)

Definition at line 416 of file InkAPI.cc.

void _TSfree ( void * ptr )

Definition at line 1656 of file InkAPI.cc.

References ats_free().

void* _TSmalloc	(	size_t	size,
		const char *
	)

Definition at line 1625 of file InkAPI.cc.

References ats_malloc().

void* _TSrealloc	(	void *	ptr,
		size_t	size,
		const char *
	)

Definition at line 1631 of file InkAPI.cc.

References ats_realloc().

void _TSReleaseAssert	(	const char *	text,
		const char *	file,
		int	line
	)

Definition at line 402 of file InkAPI.cc.

References _ink_assert().

char* _TSstrdup	(	const char *	str,
		int64_t	length,
		const char *	path
	)

Definition at line 1638 of file InkAPI.cc.

References _xstrdup().

size_t _TSstrlcat	(	char *	dst,
		const char *	str,
		size_t	siz
	)

Definition at line 1650 of file InkAPI.cc.

References ink_strlcat().

size_t _TSstrlcpy	(	char *	dst,
		const char *	str,
		size_t	siz
	)

Definition at line 1644 of file InkAPI.cc.

References ink_strlcpy().

void api_init ( )

Definition at line 1334 of file InkAPI.cc.

Referenced by plugin_init().

TSReturnCode ink_sanity_check_stat_structure ( void * obj ) [inline]

Definition at line 6738 of file InkAPI.cc.

bool isWriteable ( TSMBuffer bufp )

The function checks if the buffer is Modifiable and returns true if it is modifiable, else returns false.

Definition at line 660 of file InkAPI.cc.

static MIMEFieldSDKHandle* sdk_alloc_field_handle	(	TSMBuffer	,
		MIMEHdrImpl *	mh
	)			`[static]`

Definition at line 673 of file InkAPI.cc.

References HDR_HEAP_OBJ_FIELD_SDK_HANDLE, mHandleAllocator, obj_init_header(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

Referenced by TSMimeHdrFieldCreate(), TSMimeHdrFieldCreateNamed(), TSMimeHdrFieldFind(), TSMimeHdrFieldGet(), TSMimeHdrFieldNext(), and TSMimeHdrFieldNextDup().

static void sdk_free_field_handle	(	TSMBuffer	bufp,
		MIMEFieldSDKHandle *	field_handle
	)			`[static]`

Definition at line 687 of file InkAPI.cc.

References mHandleAllocator, sdk_sanity_check_mbuffer(), and TS_SUCCESS.

Referenced by TSHandleMLocRelease().

TSReturnCode sdk_sanity_check_alt_info ( TSHttpAltInfo info )

Definition at line 623 of file InkAPI.cc.

Referenced by TSHttpAltInfoCachedReqGet(), TSHttpAltInfoCachedRespGet(), TSHttpAltInfoClientReqGet(), and TSHttpAltInfoQualitySet().

TSReturnCode sdk_sanity_check_cachekey ( TSCacheKey key ) [inline]

Definition at line 3887 of file InkAPI.cc.

Referenced by TSCacheKeyCreate(), TSCacheKeyDataTypeSet(), TSCacheKeyDestroy(), TSCacheKeyDigestFromUrlSet(), TSCacheKeyDigestSet(), TSCacheKeyHostNameSet(), TSCacheKeyPinnedSet(), TSCacheRead(), TSCacheRemove(), and TSCacheWrite().

TSReturnCode sdk_sanity_check_continuation ( TSCont cont )

Definition at line 572 of file InkAPI.cc.

References INKCONT_INTERN_MAGIC_DEAD.

Referenced by INKUDPBind(), INKUDPRecvFrom(), INKUDPSendTo(), TSFetchCreate(), TSFetchUrl(), TSHostLookup(), TSHttpHookAdd(), TSHttpSsnHookAdd(), TSHttpTxnHookAdd(), TSHttpTxnIntercept(), TSHttpTxnServerIntercept(), TSICPCachedReqGet(), TSICPCachedRespGet(), TSLifecycleHookAdd(), TSNetAccept(), TSNetConnect(), and TSNetConnectTransparent().

TSReturnCode sdk_sanity_check_fetch_sm ( TSFetchSM fetch_sm )

Definition at line 581 of file InkAPI.cc.

Referenced by TSFetchDestroy(), TSFetchHeaderAdd(), TSFetchLaunch(), TSFetchReadData(), TSFetchRespHdrMBufGet(), TSFetchRespHdrMLocGet(), TSFetchUserDataGet(), TSFetchUserDataSet(), and TSFetchWriteData().

TSReturnCode sdk_sanity_check_field_handle	(	TSMLoc	field,
		TSMLoc	parent_hdr = `NULL`
	)

Definition at line 505 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), HDR_HEAP_OBJ_FIELD_SDK_HANDLE, HdrHeapObjImpl::m_type, MIMEFieldSDKHandle::mh, and TS_NULL_MLOC.

TSReturnCode sdk_sanity_check_hook_id ( TSHttpHookID id )

Definition at line 631 of file InkAPI.cc.

References TS_HTTP_LAST_HOOK.

Referenced by TSHttpHookAdd(), TSHttpSsnHookAdd(), and TSHttpTxnHookAdd().

TSReturnCode sdk_sanity_check_http_hdr_handle ( TSMLoc field )

Definition at line 559 of file InkAPI.cc.

References HDR_HEAP_OBJ_HTTP_HEADER, HdrHeapObjImpl::m_type, and TS_NULL_MLOC.

TSReturnCode sdk_sanity_check_http_parser ( TSHttpParser parser )

Definition at line 615 of file InkAPI.cc.

Referenced by TSHttpParserClear(), and TSHttpParserDestroy().

TSReturnCode sdk_sanity_check_http_ssn ( TSHttpSsn ssnp )

Definition at line 590 of file InkAPI.cc.

Referenced by TSHttpSsnArgGet(), TSHttpSsnArgSet(), TSHttpSsnDebugGet(), TSHttpSsnDebugSet(), TSHttpSsnHookAdd(), TSHttpSsnReenable(), and TSHttpSsnTransactionCount().

TSReturnCode sdk_sanity_check_lifecycle_hook_id ( TSLifecycleHookID id )

Definition at line 639 of file InkAPI.cc.

References TS_LIFECYCLE_LAST_HOOK.

Referenced by TSLifecycleHookAdd().

TSReturnCode sdk_sanity_check_mbuffer ( TSMBuffer bufp )

Definition at line 523 of file InkAPI.cc.

References HDR_BUF_MAGIC_ALIVE, HdrHeapSDKHandle::m_heap, HdrHeap::m_magic, and TS_ERROR.

TSReturnCode sdk_sanity_check_mime_hdr_handle ( TSMLoc field )

Definition at line 533 of file InkAPI.cc.

References HDR_HEAP_OBJ_MIME_HEADER, HdrHeapObjImpl::m_type, and TS_NULL_MLOC.

TSReturnCode sdk_sanity_check_mime_parser ( TSMimeParser parser )

Definition at line 607 of file InkAPI.cc.

Referenced by TSMimeParserClear(), and TSMimeParserDestroy().

TSReturnCode sdk_sanity_check_null_ptr ( void * ptr )

Definition at line 647 of file InkAPI.cc.

Referenced by INKUDPPacketBufferBlockGet(), INKUDPPacketConnGet(), INKUDPPacketDestroy(), INKUDPPacketFromAddressGet(), INKUDPPacketFromPortGet(), sdk_alloc_field_handle(), TSAIOWrite(), TSBase64Decode(), TSBase64Encode(), TSCacheDataTypeReady(), TSCacheKeyHostNameSet(), TSCacheReady(), TSFetchPageRespGet(), TSFetchRespGet(), TSHostLookup(), TSHttpArgIndexLookup(), TSHttpArgIndexNameLookup(), TSHttpArgIndexReserve(), TSHttpHdrMethodGet(), TSHttpHdrMethodSet(), TSHttpHdrParseReq(), TSHttpHdrParseResp(), TSHttpHdrReasonGet(), TSHttpHdrReasonSet(), TSHttpSsnClientFdGet(), TSHttpSsnSSLConnectionGet(), TSHttpTxnCachedReqGet(), TSHttpTxnCachedRespGet(), TSHttpTxnCachedRespModifiableGet(), TSHttpTxnCacheLookupCountGet(), TSHttpTxnCacheLookupStatusGet(), TSHttpTxnClientFdGet(), TSHttpTxnClientReqGet(), TSHttpTxnClientRespGet(), TSHttpTxnConfigFind(), TSHttpTxnConfigFloatGet(), TSHttpTxnConfigIntGet(), TSHttpTxnConfigStringGet(), TSHttpTxnEffectiveUrlStringGet(), TSHttpTxnIntercept(), TSHttpTxnMilestoneGet(), TSHttpTxnParentProxySet(), TSHttpTxnPristineUrlGet(), TSHttpTxnRedirectUrlSet(), TSHttpTxnServerIntercept(), TSHttpTxnServerReqGet(), TSHttpTxnServerRespGet(), TSICPCachedReqGet(), TSICPCachedRespGet(), TSIOBufferReaderAlloc(), TSIOBufferStart(), TSIOBufferWrite(), TSMatcherExtractIPRange(), TSMatcherLineDestroy(), TSMatcherLineName(), TSMatcherLineValue(), TSMatcherParseSrcIPConfigLine(), TSMatcherReadIntoBuffer(), TSMatcherTokLine(), TSMgmtUpdateRegister(), TSMimeHdrClone(), TSMimeHdrCreate(), TSMimeHdrFieldClone(), TSMimeHdrFieldCreate(), TSMimeHdrFieldCreateNamed(), TSMimeHdrFieldFind(), TSMimeHdrFieldNameGet(), TSMimeHdrFieldNameSet(), TSMimeHdrFieldValueAppend(), TSMimeHdrFieldValueStringGet(), TSMimeHdrFieldValueStringInsert(), TSMimeHdrFieldValueStringSet(), TSMimeHdrParse(), TSPluginRegister(), TSRedirectUrlSet(), TSStatCreate(), TSStatFindName(), TSStringPercentDecode(), TSStringPercentEncode(), TSTextLogObjectCreate(), TSTextLogObjectWrite(), TSUrlClone(), TSUrlCreate(), TSUrlParse(), TSUrlStringGet(), TSVConnCreate(), and URLPartGet().

TSReturnCode sdk_sanity_check_txn ( TSHttpTxn txnp )

Definition at line 599 of file InkAPI.cc.

References HTTP_SM_MAGIC_ALIVE.

TSReturnCode sdk_sanity_check_url_handle ( TSMLoc field )

Definition at line 546 of file InkAPI.cc.

References HDR_HEAP_OBJ_URL, HdrHeapObjImpl::m_type, and TS_NULL_MLOC.

Referenced by TSHttpHdrUrlSet(), TSHttpTxnCacheLookupUrlGet(), TSHttpTxnNewCacheLookupDo(), TSHttpTxnRedirectRequest(), TSUrlClone(), TSUrlCopy(), TSUrlFtpTypeGet(), TSUrlFtpTypeSet(), TSUrlLengthGet(), TSUrlParse(), TSUrlPercentEncode(), TSUrlPortGet(), TSUrlPortSet(), TSUrlPrint(), TSUrlStringGet(), URLPartGet(), and URLPartSet().

bool ssl_register_protocol	(	const char *	,
		Continuation *
	)

Definition at line 49 of file HttpProxyServerMain.cc.

References SLL< C, L >::head, SLL< C, L >::next(), and ssl_plugin_mutex.

bool ssl_unregister_protocol	(	const char *	,
		Continuation *
	)

Definition at line 64 of file HttpProxyServerMain.cc.

References SLL< C, L >::head, SLL< C, L >::next(), and ssl_plugin_mutex.

void ts_session_protocol_well_known_name_indices_init ( )

Session Protocol initialization.

This must be called before any proxy port parsing is done.

Definition at line 578 of file RecHttp.cc.

void TSActionCancel ( TSAction actionp )

Definition at line 6122 of file InkAPI.cc.

References a, Action::cancel(), Action::continuation, EVENT_IMMEDIATE, and INKContInternal::handle_event_count().

Referenced by SDK_API_TSActionCancel(), synclient_txn_delete(), and synserver_stop().

int TSActionDone ( TSAction actionp )

Definition at line 6141 of file InkAPI.cc.

References ACTION_RESULT_DONE.

Referenced by SDK_API_TSActionCancel(), synclient_txn_delete(), and synserver_stop().

char* TSAIOBufGet ( TSAIOCallback data )

Async disk IO buffer get.

Returns:: char* to the buffer

Definition at line 7437 of file InkAPI.cc.

References ink_aiocb::aio_buf, and AIOCallback::aiocb.

int TSAIONBytesGet ( TSAIOCallback data )

Async disk IO get number of bytes.

Returns:: the number of bytes

Definition at line 7444 of file InkAPI.cc.

References AIOCallback::aio_result.

TSReturnCode TSAIORead	(	int	fd,
		off_t	offset,
		char *	buf,
		size_t	buffSize,
		TSCont	contp
	)

Async disk IO read.

Returns:: TS_SUCCESS or TS_ERROR.

Definition at line 7411 of file InkAPI.cc.

References AIOCallback::action, ink_aiocb::aio_buf, ink_aiocb::aio_fildes, ink_aiocb::aio_nbytes, ink_aiocb::aio_offset, AIOCallback::aiocb, ink_aio_read(), Continuation::mutex, new_AIOCallback(), sdk_assert, sdk_sanity_check_iocore_structure(), AIOCallback::thread, and TS_SUCCESS.

TSReturnCode TSAIOThreadNumSet ( int thread_num )

Async disk IO set number of threads.

Returns:: TS_SUCCESS or TS_ERROR.

Definition at line 7475 of file InkAPI.cc.

References ink_aio_thread_num_set(), and TS_SUCCESS.

TSReturnCode TSAIOWrite	(	int	fd,
		off_t	offset,
		char *	buf,
		size_t	bufSize,
		TSCont	contp
	)

Async disk IO write.

Returns:: TS_SUCCESS or TS_ERROR.

Definition at line 7451 of file InkAPI.cc.

References ink_aio_write(), Continuation::mutex, new_AIOCallback(), sdk_assert, sdk_sanity_check_iocore_structure(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

TSReturnCode TSBase64Decode	(	const char *	str,
		size_t	str_len,
		unsigned char *	dst,
		size_t	dst_size,
		size_t *	length
	)

Definition at line 1667 of file InkAPI.cc.

References ats_base64_decode(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

Referenced by SDK_API_ENCODING().

TSReturnCode TSBase64Encode	(	const char *	str,
		size_t	str_len,
		char *	dst,
		size_t	dst_size,
		size_t *	length
	)

Definition at line 1676 of file InkAPI.cc.

References ats_base64_encode(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

Referenced by SDK_API_ENCODING().

TSReturnCode TSCacheDataTypeReady	(	TSCacheDataType	type,
		int *	is_ready
	)

Definition at line 6565 of file InkAPI.cc.

References cacheProcessor, CacheProcessor::IsCacheReady(), sdk_assert, sdk_sanity_check_null_ptr(), TS_CACHE_DATA_TYPE_HTTP, TS_CACHE_DATA_TYPE_NONE, TS_CACHE_DATA_TYPE_OTHER, and TS_SUCCESS.

Referenced by TSCacheReady().

TSCacheHttpInfo TSCacheHttpInfoCopy ( TSCacheHttpInfo infop )

Definition at line 4004 of file InkAPI.cc.

TSCacheHttpInfo TSCacheHttpInfoCreate ( void )

Definition at line 4103 of file InkAPI.cc.

void TSCacheHttpInfoDestroy ( TSCacheHttpInfo infop )

Definition at line 4097 of file InkAPI.cc.

void TSCacheHttpInfoKeySet	(	TSCacheHttpInfo	infop,
		TSCacheKey	keyp
	)

Definition at line 7115 of file InkAPI.cc.

void TSCacheHttpInfoReqGet	(	TSCacheHttpInfo	infop,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 4013 of file InkAPI.cc.

References sdk_sanity_check_mbuffer().

time_t TSCacheHttpInfoReqSentTimeGet ( TSCacheHttpInfo infop )

Definition at line 4034 of file InkAPI.cc.

void TSCacheHttpInfoReqSet	(	TSCacheHttpInfo	infop,
		TSMBuffer	bufp,
		TSMLoc	obj
	)

Definition at line 4055 of file InkAPI.cc.

References SET_HTTP_HDR.

void TSCacheHttpInfoRespGet	(	TSCacheHttpInfo	infop,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 4024 of file InkAPI.cc.

References sdk_sanity_check_mbuffer().

time_t TSCacheHttpInfoRespReceivedTimeGet ( TSCacheHttpInfo infop )

Definition at line 4041 of file InkAPI.cc.

void TSCacheHttpInfoRespSet	(	TSCacheHttpInfo	infop,
		TSMBuffer	bufp,
		TSMLoc	obj
	)

Definition at line 4067 of file InkAPI.cc.

References SET_HTTP_HDR.

int64_t TSCacheHttpInfoSizeGet ( TSCacheHttpInfo infop )

Definition at line 4048 of file InkAPI.cc.

void TSCacheHttpInfoSizeSet	(	TSCacheHttpInfo	infop,
		int64_t	size
	)

Definition at line 7125 of file InkAPI.cc.

int TSCacheHttpInfoVector	(	TSCacheHttpInfo	infop,
		void *	data,
		int	length
	)

Definition at line 4079 of file InkAPI.cc.

References CacheHTTPInfoVector::insert(), CacheHTTPInfoVector::marshal(), and CacheHTTPInfoVector::marshal_length().

TSCacheKey TSCacheKeyCreate ( void )

Creates (allocates memory for) a new cache key.

Definition at line 3896 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_cachekey(), and TS_SUCCESS.

Referenced by SDK_API_TSCache().

TSReturnCode TSCacheKeyDataTypeSet	(	TSCacheKey	key,
		TSCacheDataType	type
	)

Definition at line 3933 of file InkAPI.cc.

References CACHE_INFO_MAGIC_ALIVE, sdk_assert, sdk_sanity_check_cachekey(), TS_CACHE_DATA_TYPE_HTTP, TS_CACHE_DATA_TYPE_NONE, TS_CACHE_DATA_TYPE_OTHER, and TS_SUCCESS.

TSReturnCode TSCacheKeyDestroy ( TSCacheKey key )

Destroys a cache key.

You must destroy cache keys when you are finished with them, i.e. after all reads and writes are completed.

Parameters:

key

to be destroyed.

Definition at line 3988 of file InkAPI.cc.

References ats_free(), CACHE_INFO_MAGIC_ALIVE, CacheInfo::hostname, CacheInfo::magic, sdk_assert, sdk_sanity_check_cachekey(), and TS_SUCCESS.

Referenced by cache_handler(), and SDK_API_TSCache().

TSReturnCode TSCacheKeyDigestFromUrlSet	(	TSCacheKey	key,
		TSMLoc	url
	)

Definition at line 3921 of file InkAPI.cc.

References CACHE_INFO_MAGIC_ALIVE, sdk_assert, sdk_sanity_check_cachekey(), TS_SUCCESS, and url_MD5_get().

TSReturnCode TSCacheKeyDigestSet	(	TSCacheKey	key,
		const char *	input,
		int	length
	)

Generates a key for an object to be cached (written to the cache).

Parameters:

	key	to be associated with the cached object. Before calling TSCacheKeySetDigest() you must create the key with TSCacheKeyCreate().
	input	string that uniquely identifies the object. In most cases, it is the URL of the object.
	length	of the string input.

Definition at line 3906 of file InkAPI.cc.

References CACHE_INFO_MAGIC_ALIVE, CacheInfo::cache_key, CacheInfo::magic, sdk_assert, sdk_sanity_check_cachekey(), sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

Referenced by SDK_API_TSCache().

TSReturnCode TSCacheKeyHostNameSet	(	TSCacheKey	key,
		const char *	hostname,
		int	host_len
	)

Associates a host name to the cache key.

Use this function if the cache has been partitioned by hostname. The hostname tells the cache which volume to use for the object.

Parameters:

	key	of the cached object.
	hostname	to associate with the cache key.
	host_len	length of the string hostname.

Definition at line 3956 of file InkAPI.cc.

References ats_malloc(), CACHE_INFO_MAGIC_ALIVE, CacheInfo::hostname, CacheInfo::len, memcpy, sdk_assert, sdk_sanity_check_cachekey(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

TSReturnCode TSCacheKeyPinnedSet	(	TSCacheKey	key,
		time_t	pin_in_cache
	)

Definition at line 3975 of file InkAPI.cc.

References CACHE_INFO_MAGIC_ALIVE, CacheInfo::pin_in_cache, sdk_assert, sdk_sanity_check_cachekey(), and TS_SUCCESS.

TSAction TSCacheRead	(	TSCont	contp,
		TSCacheKey	key
	)

Asks the Traffic Server cache if the object corresponding to key exists in the cache and can be read.

If the object can be read, the Traffic Server cache calls the continuation contp back with the event TS_EVENT_CACHE_OPEN_READ. In this case, the cache also passes contp a cache vconnection and contp can then initiate a read operation on that vconnection using TSVConnRead.

If the object cannot be read, the cache calls contp back with the event TS_EVENT_CACHE_OPEN_READ_FAILED. The user (contp) has the option to cancel the action returned by TSCacheRead. Note that reentrant calls are possible, i.e. the cache can call back the user (contp) in the same call.

Parameters:

	contp	continuation to be called back if a read operation is permissible.
	key	cache key corresponding to the object to be read.

Returns:: something allowing the user to cancel or schedule the cache read.

Definition at line 6590 of file InkAPI.cc.

References CacheInfo::cache_key, cacheProcessor, FORCE_PLUGIN_MUTEX, CacheInfo::frag_type, CacheInfo::hostname, CacheInfo::len, CacheProcessor::open_read(), sdk_assert, sdk_sanity_check_cachekey(), sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

Referenced by cache_handler().

TSReturnCode TSCacheReady ( int * is_ready )

Definition at line 6557 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_null_ptr(), TS_CACHE_DATA_TYPE_NONE, TS_SUCCESS, and TSCacheDataTypeReady().

Referenced by SDK_API_TSCache().

TSAction TSCacheRemove	(	TSCont	contp,
		TSCacheKey	key
	)

Removes the object corresponding to key from the cache.

If the object was removed successfully, the cache calls contp back with the event TS_EVENT_CACHE_REMOVE. If the object was not found in the cache, the cache calls contp back with the event TS_EVENT_CACHE_REMOVE_FAILED.

In both of these callbacks, the user (contp) does not have to do anything. The user does not get any vconnection from the cache, since no data needs to be transferred. When the cache calls contp back with TS_EVENT_CACHE_REMOVE, the remove has already been commited.

Parameters:

	contp	continuation that the cache calls back reporting the success or failure of the remove.
	key	cache key corresponding to the object to be removed.

Returns:: something allowing the user to cancel or schedule the remove.

Definition at line 6619 of file InkAPI.cc.

References CacheInfo::cache_key, cacheProcessor, FORCE_PLUGIN_MUTEX, CacheInfo::frag_type, CacheInfo::hostname, CacheInfo::len, CacheProcessor::remove(), sdk_assert, sdk_sanity_check_cachekey(), sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

Referenced by cache_handler().

TSAction TSCacheScan	(	TSCont	contp,
		TSCacheKey	key,
		int	KB_per_second
	)

Definition at line 6633 of file InkAPI.cc.

References cacheProcessor, FORCE_PLUGIN_MUTEX, CacheInfo::hostname, CacheInfo::len, CacheProcessor::scan(), sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

TSReturnCode TSCacheUrlSet	(	TSHttpTxn	txnp,
		const char *	url,
		int	length
	)

Definition at line 7092 of file InkAPI.cc.

References HttpTransact::State::cache_info, Debug, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

TSAction TSCacheWrite	(	TSCont	contp,
		TSCacheKey	key
	)

Asks the Traffic Server cache if contp can start writing the object (corresponding to key) to the cache.

If the object can be written, the cache calls contp back with the event TS_EVENT_CACHE_OPEN_WRITE. In this case, the cache also passes contp a cache vconnection and contp can then initiate a write operation on that vconnection using TSVConnWrite. The object is not committed to the cache until the vconnection is closed. When all data has been transferred, the user (contp) must do an TSVConnClose. In case of any errors, the user MUST do an TSVConnAbort(contp, 0).

If the object cannot be written, the cache calls contp back with the event TS_EVENT_CACHE_OPEN_WRITE_FAILED. This can happen, for example, if there is another object with the same key being written to the cache. The user (contp) has the option to cancel the action returned by TSCacheWrite.

Note that reentrant calls are possible, i.e. the cache can call back the user (contp) in the same call.

Parameters:

	contp	continuation that the cache calls back (telling it whether the write operation can proceed or not).
	key	cache key corresponding to the object to be cached.

Returns:: something allowing the user to cancel or schedule the cache write.

Definition at line 6604 of file InkAPI.cc.

References CacheInfo::cache_key, cacheProcessor, FORCE_PLUGIN_MUTEX, CacheInfo::frag_type, CacheInfo::hostname, CacheInfo::len, CacheProcessor::open_write(), CacheInfo::pin_in_cache, sdk_assert, sdk_sanity_check_cachekey(), sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

Referenced by SDK_API_TSCache().

void* TSConfigDataGet ( TSConfig configp )

Definition at line 4140 of file InkAPI.cc.

References INKConfigImpl::mdata.

Referenced by SDK_API_TSConfig().

const char* TSConfigDirGet ( void )

Gets the path of the directory of Traffic Server configuration.

Returns:: pointer to Traffic Server configuration directory.

Definition at line 1721 of file InkAPI.cc.

References Layout::get(), and Layout::sysconfdir.

Referenced by SDK_API_TSfopen().

TSConfig TSConfigGet ( unsigned int id )

Definition at line 4128 of file InkAPI.cc.

Referenced by SDK_API_TSConfig().

void TSConfigRelease	(	unsigned int	id,
		TSConfig	configp
	)

Definition at line 4134 of file InkAPI.cc.

Referenced by SDK_API_TSConfig().

unsigned int TSConfigSet	(	unsigned int	id,
		void *	data,
		TSConfigDestroyFunc	funcp
	)

Definition at line 4119 of file InkAPI.cc.

References INKConfigImpl::m_destroy_func, and INKConfigImpl::mdata.

Referenced by SDK_API_TSConfig().

int TSContCall	(	TSCont	contp,
		TSEvent	event,
		void *	edata
	)

Definition at line 4360 of file InkAPI.cc.

References Continuation::handleEvent().

Referenced by handle_transform(), SDK_API_TSContCreate(), synclient_txn_send_request_to_vc(), and transformtest_transform().

TSCont TSContCreate	(	TSEventFunc	funcp,
		TSMutex	mutexp
	)

void* TSContDataGet ( TSCont contp )

Definition at line 4233 of file InkAPI.cc.

References INKContInternal::mdata, sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

Referenced by altinfo_hook_handler(), cache_handler(), cache_hook_handler(), client_handler(), cont_data_handler(), cont_test_handler(), handle_transform(), log_test_handler(), mytest_handler(), server_handler(), ssn_handler(), synclient_txn_close(), synclient_txn_connect_handler(), synclient_txn_main_handler(), synclient_txn_read_response(), synclient_txn_read_response_handler(), synclient_txn_write_request(), synclient_txn_write_request_handler(), synserver_accept_handler(), synserver_txn_close(), synserver_txn_main_handler(), synserver_txn_read_request(), synserver_txn_read_request_handler(), synserver_txn_write_response(), synserver_txn_write_response_handler(), transform_hook_handler(), and transformtest_transform().

void TSContDataSet	(	TSCont	contp,
		void *	data
	)

void TSContDestroy ( TSCont contp )

Definition at line 4213 of file InkAPI.cc.

References INKContInternal::destroy(), sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

Referenced by action_cancel_handler(), client_handler(), cont_data_handler(), cont_schedule_handler(), SDK_API_TSContCreate(), SDK_API_TSContMutexGet(), server_handler(), synclient_txn_close(), synserver_delete(), synserver_txn_close(), and transformtest_transform().

TSMutex TSContMutexGet ( TSCont contp )

Definition at line 4367 of file InkAPI.cc.

References Continuation::mutex, sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

Referenced by cache_handler(), SDK_API_TSContMutexGet(), and TSTransformCreate().

TSAction TSContSchedule	(	TSCont	contp,
		ink_hrtime	timeout,
		TSThreadPool	tp
	)

TSAction TSContScheduleEvery	(	TSCont	contp,
		ink_hrtime	every,
		TSThreadPool	tp
	)

Definition at line 4297 of file InkAPI.cc.

References ET_TASK, eventProcessor, FORCE_PLUGIN_MUTEX, HRTIME_MSECONDS, ink_assert, INKContInternal::m_event_count, EventProcessor::schedule_every(), sdk_assert, sdk_sanity_check_iocore_structure(), TS_SUCCESS, TS_THREAD_POOL_DEFAULT, TS_THREAD_POOL_NET, and TS_THREAD_POOL_TASK.

void TSDebug	(	const char *	tag,
		const char *	format_str,
			...
	)

Definition at line 6769 of file InkAPI.cc.

References diags, DiagsTagType_Debug, DL_Diag, Diags::on(), and Diags::print_va().

void TSDebugSpecific	(	int	debug_flag,
		const char *	tag,
		const char *	format_str,
			...
	)

Definition at line 6755 of file InkAPI.cc.

References diags, DiagsTagType_Debug, DL_Diag, Diags::on(), and Diags::print_va().

double TSdrandom ( void )

Definition at line 1697 of file InkAPI.cc.

References InkRand::drandom(), EThread::generator, and this_ethread().

void TSError	(	const char *	fmt,
			...
	)

Definition at line 386 of file InkAPI.cc.

References diags, DL_Error, is_action_tag_set, Diags::print_va(), and Log::va_error().

void TSfclose ( TSFile filep )

Closes the file to which filep points and frees the data structures and buffers associated with it.

If the file was opened for writing, any pending data is flushed.

Parameters:

filep

file to be closed.

Definition at line 1811 of file InkAPI.cc.

References FileImpl::fclose().

Referenced by log_test_handler(), and SDK_API_TSfopen().

TSFetchSM TSFetchCreate	(	TSCont	contp,
		const char *	method,
		const char *	url,
		const char *	version,
		struct sockaddr const *	client_addr,
		int	flags
	)

Extended FetchSM's AIPs.

Definition at line 7279 of file InkAPI.cc.

References ClassAllocator< C >::alloc(), ats_is_ip(), FetchSM::ext_init(), sdk_assert, sdk_sanity_check_continuation(), and TS_SUCCESS.

Referenced by spdy_fetcher_launch().

void TSFetchDestroy ( TSFetchSM fetch_sm )

Definition at line 7329 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_fetch_sm(), and TS_SUCCESS.

Referenced by SpdyRequest::clear().

void TSFetchHeaderAdd	(	TSFetchSM	fetch_sm,
		const char *	name,
		int	name_len,
		const char *	value,
		int	value_len
	)

Definition at line 7295 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_fetch_sm(), and TS_SUCCESS.

Referenced by spdy_fetcher_launch().

void TSFetchLaunch ( TSFetchSM fetch_sm )

Definition at line 7321 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_fetch_sm(), and TS_SUCCESS.

Referenced by spdy_fetcher_launch().

TSReturnCode TSFetchPageRespGet	(	TSHttpTxn	txnp,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 7231 of file InkAPI.cc.

References HTTPHdr::m_http, sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), TS_SUCCESS, and HTTPHdr::valid().

void TSFetchPages ( TSFetchUrlParams_t * params )

Definition at line 7251 of file InkAPI.cc.

References ClassAllocator< C >::alloc(), ats_ip_sa_cast(), TSFetchUrlParams::contp, TSFetchUrlParams::events, FetchSM::httpConnect(), FetchSM::init(), TSFetchUrlParams::ip, TSFetchUrlParams::next, TSFetchUrlParams::options, TSFetchUrlParams::request, and TSFetchUrlParams::request_len.

ssize_t TSFetchReadData	(	TSFetchSM	fetch_sm,
		void *	buf,
		size_t	len
	)

Definition at line 7313 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_fetch_sm(), and TS_SUCCESS.

Referenced by spdy_read_fetch_body_callback().

char* TSFetchRespGet	(	TSHttpTxn	txnp,
		int *	length
	)

Definition at line 7223 of file InkAPI.cc.

References FetchSM::resp_get(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

TSMBuffer TSFetchRespHdrMBufGet ( TSFetchSM fetch_sm )

Definition at line 7371 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_fetch_sm(), and TS_SUCCESS.

Referenced by SpdyNV::SpdyNV().

TSMLoc TSFetchRespHdrMLocGet ( TSFetchSM fetch_sm )

Definition at line 7379 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_fetch_sm(), and TS_SUCCESS.

Referenced by SpdyNV::SpdyNV().

void TSFetchUrl	(	const char *	headers,
		int	request_len,
		sockaddr const *	ip,
		TSCont	contp,
		TSFetchWakeUpOptions	callback_options,
		TSFetchEvent	events
	)

Definition at line 7266 of file InkAPI.cc.

References ClassAllocator< C >::alloc(), FetchSM::httpConnect(), FetchSM::init(), NO_CALLBACK, sdk_assert, sdk_sanity_check_continuation(), and TS_SUCCESS.

void* TSFetchUserDataGet ( TSFetchSM fetch_sm )

Definition at line 7363 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_fetch_sm(), and TS_SUCCESS.

Referenced by spdy_process_fetch(), spdy_process_fetch_body(), and spdy_process_fetch_header().

void TSFetchUserDataSet	(	TSFetchSM	fetch_sm,
		void *	data
	)

Definition at line 7337 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_fetch_sm(), and TS_SUCCESS.

Referenced by spdy_fetcher_launch().

void TSFetchWriteData	(	TSFetchSM	fetch_sm,
		const void *	data,
		size_t	len
	)

Definition at line 7305 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_fetch_sm(), and TS_SUCCESS.

Referenced by spdy_on_data_chunk_recv_callback().

void TSfflush ( TSFile filep )

Flushes pending data that has been buffered up in memory from previous calls to TSfwrite().

Parameters:

filep

file to flush.

Definition at line 1833 of file InkAPI.cc.

References FileImpl::fflush().

Referenced by SDK_API_TSfopen().

char* TSfgets	(	TSFile	filep,
		char *	buf,
		size_t	length
	)

Reads a line from the file pointed to by filep into the buffer buf.

Lines are terminated by a line feed character, '
'. The line placed in the buffer includes the line feed character and is terminated with a NULL. If the line is longer than length bytes then only the first length-minus-1 bytes are placed in buf.

Parameters:

	filep	file to read from.
	buf	buffer to read into.
	length	size of the buffer to read into.

Returns:: pointer to the string read into the buffer buf.

Definition at line 1840 of file InkAPI.cc.

References FileImpl::fgets().

Referenced by log_test_handler(), and SDK_API_TSfopen().

TSFile TSfopen	(	const char *	filename,
		const char *	mode
	)

Opens a file for reading or writing and returns a descriptor for accessing the file.

The current implementation cannot open a file for both reading or writing. See the SDK Programmer's Guide for sample code.

Parameters:

	filename	file to be opened.
	mode	specifies whether to open the file for reading or writing. If mode is "r" then the file is opened for reading. If mode is "w" then the file is opened for writing. Currently "r" and "w" are the only two valid modes for opening a file.

Returns:: descriptor for the file that TSfopen opens. Descriptors of type TSFile can be greater than 256.

Definition at line 1797 of file InkAPI.cc.

References FileImpl::fopen().

Referenced by log_test_handler(), and SDK_API_TSfopen().

size_t TSfread	(	TSFile	filep,
		void *	buf,
		size_t	length
	)

Attempts to read length bytes of data from the file pointed to by filep into the buffer buf.

Parameters:

	filep	name of the file to read from.
	buf	buffer to read into.
	length	amount of data to read, in bytes.

Returns:: number of bytes read. If end of the file, it returns 0. If the file was not opened for reading or if an error occurs while reading the file, it returns -1.

Definition at line 1819 of file InkAPI.cc.

References FileImpl::fread().

Referenced by SDK_API_TSfopen().

size_t TSfwrite	(	TSFile	filep,
		const void *	buf,
		size_t	length
	)

Attempts to write length bytes of data from the buffer buf to the file filep.

Make sure that filep is open for writing. You might want to check the number of bytes written (TSfwrite() returns this value) against the value of length. If it is less, there might be insufficient space on disk, for example.

Parameters:

	filep	file to write into.
	buf	buffer containing the data to be written.
	length	amount of data to write to filep, in bytes.

Returns:: number of bytes written to filep. If the file was not opened for writing, it returns -1. If an error occurs while writing, it returns the number of bytes successfully written.

Definition at line 1826 of file InkAPI.cc.

References FileImpl::fwrite().

Referenced by SDK_API_TSfopen().

TSReturnCode TSHandleMLocRelease	(	TSMBuffer	bufp,
		TSMLoc	parent,
		TSMLoc	mloc
	)

Releases the TSMLoc mloc created from the TSMLoc parent.

If there is no parent TSMLoc, use TS_NULL_MLOC.

Parameters:

	bufp	marshal buffer containing the TSMLoc handle to be released.
	parent	location of the parent object from which the handle was created.
	mloc	location of the handle to be released.

Definition at line 1853 of file InkAPI.cc.

References HDR_HEAP_OBJ_FIELD_SDK_HANDLE, HDR_HEAP_OBJ_HTTP_HEADER, HDR_HEAP_OBJ_MIME_HEADER, HDR_HEAP_OBJ_URL, ink_release_assert, HdrHeapObjImpl::m_type, sdk_assert, sdk_free_field_handle(), sdk_sanity_check_field_handle(), sdk_sanity_check_mbuffer(), TS_ERROR, TS_NULL_MLOC, and TS_SUCCESS.

Referenced by cache_hook_handler(), get_request_id(), SDK_API_TSHttpHdr(), SDK_API_TSHttpHdrParse(), SDK_API_TSMimeHdrField(), SDK_API_TSMimeHdrParse(), SDK_API_TSUrl(), SDK_API_TSUrlParse(), SpdyNV::SpdyNV(), and transform_hook_handler().

TSAction TSHostLookup	(	TSCont	contp,
		const char *	hostname,
		size_t	namelen
	)

Definition at line 6530 of file InkAPI.cc.

References FORCE_PLUGIN_MUTEX, HostDBProcessor::getbyname_re(), hostDBProcessor, sdk_assert, sdk_sanity_check_continuation(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

sockaddr const* TSHostLookupResultAddrGet ( TSHostLookupResult lookup_result ) [read]

Definition at line 6543 of file InkAPI.cc.

References HostDBInfo::ip, sdk_assert, sdk_sanity_check_hostlookup_structure(), and TS_SUCCESS.

ink_hrtime TShrtime ( void )

Definition at line 1703 of file InkAPI.cc.

References ink_get_based_hrtime().

Referenced by SpdyClientSession::init(), SpdyRequest::init(), and spdy_read_fetch_body_callback().

TSReturnCode TSHttpAltInfoCachedReqGet	(	TSHttpAltInfo	infop,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 6009 of file InkAPI.cc.

References HttpAltInfo::m_cached_req, HTTPHdr::m_http, sdk_assert, sdk_sanity_check_alt_info(), sdk_sanity_check_mbuffer(), and TS_SUCCESS.

Referenced by altinfo_hook_handler().

TSReturnCode TSHttpAltInfoCachedRespGet	(	TSHttpAltInfo	infop,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 6022 of file InkAPI.cc.

References HttpAltInfo::m_cached_resp, HTTPHdr::m_http, sdk_assert, sdk_sanity_check_alt_info(), sdk_sanity_check_mbuffer(), and TS_SUCCESS.

Referenced by altinfo_hook_handler().

TSReturnCode TSHttpAltInfoClientReqGet	(	TSHttpAltInfo	infop,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 5996 of file InkAPI.cc.

References HttpAltInfo::m_client_req, HTTPHdr::m_http, sdk_assert, sdk_sanity_check_alt_info(), sdk_sanity_check_mbuffer(), and TS_SUCCESS.

Referenced by altinfo_hook_handler().

void TSHttpAltInfoQualitySet	(	TSHttpAltInfo	infop,
		float	quality
	)

Definition at line 6035 of file InkAPI.cc.

References HttpAltInfo::m_qvalue, sdk_assert, sdk_sanity_check_alt_info(), and TS_SUCCESS.

Referenced by altinfo_hook_handler().

TSReturnCode TSHttpArgIndexLookup	(	int	arg_idx,
		const char **	name,
		const char **	description
	)

Definition at line 5563 of file InkAPI.cc.

References _STATE_ARG_TABLE::description, _STATE_ARG_TABLE::name, sdk_sanity_check_null_ptr(), state_arg_table, and TS_SUCCESS.

TSReturnCode TSHttpArgIndexNameLookup	(	const char *	name,
		int *	arg_idx,
		const char **	description
	)

Definition at line 5578 of file InkAPI.cc.

References _STATE_ARG_TABLE::description, next_argv_index, sdk_assert, sdk_sanity_check_null_ptr(), state_arg_table, and TS_SUCCESS.

TSReturnCode TSHttpArgIndexReserve	(	const char *	name,
		const char *	description,
		int *	arg_idx
	)

Definition at line 5544 of file InkAPI.cc.

References ats_strdup, _STATE_ARG_TABLE::description, HTTP_SSN_TXN_MAX_USER_ARG, _STATE_ARG_TABLE::name, _STATE_ARG_TABLE::name_len, next_argv_index, sdk_assert, sdk_sanity_check_null_ptr(), state_arg_table, and TS_SUCCESS.

TSVConn TSHttpConnect ( sockaddr const * addr )

Definition at line 6079 of file InkAPI.cc.

References TSHttpConnectWithPluginId().

TSVConn TSHttpConnectTransparent	(	sockaddr const *	client_addr,
		sockaddr const *	server_addr
	)

Definition at line 6085 of file InkAPI.cc.

References PluginVCCore::alloc(), ats_ip_port_cast(), ats_is_ip(), ats_is_ip_any(), PluginVCCore::connect(), PluginVC::get_other_side(), sdk_assert, PluginVCCore::set_accept_cont(), PluginVCCore::set_active_addr(), NetVConnection::set_is_internal_request(), PluginVCCore::set_passive_addr(), and PluginVCCore::set_transparent().

TSVConn TSHttpConnectWithPluginId	(	sockaddr const *	addr,
		char const *	tag,
		int64_t	id
	)

Definition at line 6047 of file InkAPI.cc.

References PluginVCCore::alloc(), ats_ip_port_cast(), ats_is_ip(), PluginVCCore::connect(), PluginVC::get_other_side(), sdk_assert, PluginVCCore::set_accept_cont(), PluginVCCore::set_active_addr(), NetVConnection::set_is_internal_request(), PluginVCCore::set_plugin_id(), and PluginVCCore::set_plugin_tag().

int TSHttpCurrentActiveClientConnectionsGet ( void )

Definition at line 5952 of file InkAPI.cc.

References http_current_active_client_connections_stat, and HTTP_READ_DYN_SUM.

int TSHttpCurrentCacheConnectionsGet ( void )

Definition at line 5976 of file InkAPI.cc.

References http_current_cache_connections_stat, and HTTP_READ_DYN_SUM.

int TSHttpCurrentClientConnectionsGet ( void )

Definition at line 5943 of file InkAPI.cc.

References http_current_client_connections_stat, and HTTP_READ_DYN_SUM.

int TSHttpCurrentIdleClientConnectionsGet ( void )

Definition at line 5961 of file InkAPI.cc.

References http_current_active_client_connections_stat, http_current_client_connections_stat, and HTTP_READ_DYN_SUM.

int TSHttpCurrentServerConnectionsGet ( void )

Definition at line 5985 of file InkAPI.cc.

References http_current_server_connections_stat, and HTTP_READ_GLOBAL_DYN_SUM.

const char* TSHttpEventNameLookup ( TSEvent event )

Return a string respresentation for a TSEvent value.

This is useful for plugin debugging.

Parameters:

event

the value of this TSHttpHookID

Returns:: the string representation of the event

Definition at line 8623 of file InkAPI.cc.

References HttpDebugNames::get_event_name().

Referenced by SDK_API_DEBUG_NAME_LOOKUPS().

TSReturnCode TSHttpHdrClone	(	TSMBuffer	dest_bufp,
		TSMBuffer	src_bufp,
		TSMLoc	src_hdr,
		TSMLoc *	locp
	)

Definition at line 3484 of file InkAPI.cc.

References HDR_HEAP_OBJ_HTTP_HEADER, http_hdr_clone(), isWriteable(), HdrHeapObjImpl::m_type, sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr().

TSReturnCode TSHttpHdrCopy	(	TSMBuffer	dest_bufp,
		TSMLoc	dest_offset,
		TSMBuffer	src_bufp,
		TSMLoc	src_offset
	)

Copies the contents of the HTTP header located at src_loc within src_bufp to the HTTP header located at dest_loc within dest_bufp.

TSHttpHdrCopy() works correctly even if src_bufp and dest_bufp point to different marshal buffers. Make sure that you create the destination HTTP header before copying into it.

Note: TSHttpHdrCopy() appends the port number to the domain of the URL portion of the header. For example, a copy of http://www.example.com appears as http://www.example.com:80 in the destination buffer.

Parameters:

	dest_bufp	marshal buffer to contain the copied header.
	dest_offset	location of the copied header.
	src_bufp	marshal buffer containing the source header.
	src_offset	location of the source header.

Definition at line 3515 of file InkAPI.cc.

References HDR_HEAP_OBJ_HTTP_HEADER, http_hdr_copy_onto(), isWriteable(), HTTPHdrImpl::m_polarity, HdrHeapObjImpl::m_type, sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), TS_SUCCESS, and TSHttpHdrTypeSet().

Referenced by SDK_API_TSHttpHdr().

TSMLoc TSHttpHdrCreate ( TSMBuffer bufp )

Definition at line 3461 of file InkAPI.cc.

References HTTPHdr::create(), HTTP_TYPE_UNKNOWN, HdrHeapSDKHandle::m_heap, HTTPHdr::m_http, sdk_assert, sdk_sanity_check_mbuffer(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr(), and SDK_API_TSHttpHdrParse().

void TSHttpHdrDestroy	(	TSMBuffer	bufp,
		TSMLoc	offset
	)

Destroys the HTTP header located at hdr_loc within the marshal buffer bufp.

Do not forget to release the handle hdr_loc with a call to TSHandleMLocRelease().

Definition at line 3472 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr().

int TSHttpHdrLengthGet	(	TSMBuffer	bufp,
		TSMLoc	obj
	)

Definition at line 3623 of file InkAPI.cc.

References HDR_HEAP_OBJ_HTTP_HEADER, ink_assert, HTTPHdr::length_get(), HTTPHdr::m_http, HdrHeapObjImpl::m_type, sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), SET_HTTP_HDR, and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr().

const char* TSHttpHdrMethodGet	(	TSMBuffer	bufp,
		TSMLoc	obj,
		int *	length
	)

Definition at line 3724 of file InkAPI.cc.

References HTTPHdr::method_get(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), SET_HTTP_HDR, and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr().

TSReturnCode TSHttpHdrMethodSet	(	TSMBuffer	bufp,
		TSMLoc	obj,
		const char *	value,
		int	length
	)

Definition at line 3737 of file InkAPI.cc.

References isWriteable(), HTTPHdr::method_set(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), SET_HTTP_HDR, and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr().

TSParseResult TSHttpHdrParseReq	(	TSHttpParser	parser,
		TSMBuffer	bufp,
		TSMLoc	offset,
		const char **	start,
		const char *	end
	)

Parses an HTTP request header.

The HTTP header must have already been created, and must reside inside the marshal buffer bufp. The start argument points to the current position of the string buffer being parsed. The end argument points to one byte after the end of the buffer to be parsed. On return, TSHttpHdrParseReq() modifies start to point past the last character parsed.

It is possible to parse an HTTP request header a single byte at a time using repeated calls to TSHttpHdrParseReq(). As long as an error does not occur, the TSHttpHdrParseReq() function will consume that single byte and ask for more.

Parameters:

	parser	parses the HTTP header.
	bufp	marshal buffer containing the HTTP header to be parsed.
	offset	location of the HTTP header within bufp.
	start	both an input and output. On input, it points to the current position of the string buffer being parsed. On return, start is modified to point past the last character parsed.
	end	points to one byte after the end of the buffer to be parsed.

Returns:

status of the parse:

TS_PARSE_ERROR means there was a parsing error.
TS_PARSE_DONE means that the end of the header was reached (the parser encountered a "\r\n\r\n" pattern).
TS_PARSE_CONT means that parsing of the header stopped because the parser reached the end of the buffer (large headers can span multiple buffers).

Definition at line 3583 of file InkAPI.cc.

References HDR_HEAP_OBJ_HTTP_HEADER, ink_assert, isWriteable(), HTTPHdr::m_http, HdrHeapObjImpl::m_type, HTTPHdr::parse_req(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), SET_HTTP_HDR, TS_HTTP_TYPE_REQUEST, TS_SUCCESS, and TSHttpHdrTypeSet().

Referenced by SDK_API_TSHttpHdrParse().

TSParseResult TSHttpHdrParseResp	(	TSHttpParser	parser,
		TSMBuffer	bufp,
		TSMLoc	obj,
		const char **	start,
		const char *	end
	)

Definition at line 3603 of file InkAPI.cc.

References HDR_HEAP_OBJ_HTTP_HEADER, ink_assert, isWriteable(), HTTPHdr::m_http, HdrHeapObjImpl::m_type, HTTPHdr::parse_resp(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), SET_HTTP_HDR, TS_HTTP_TYPE_RESPONSE, TS_SUCCESS, and TSHttpHdrTypeSet().

Referenced by SDK_API_TSHttpHdrParse().

void TSHttpHdrPrint	(	TSMBuffer	bufp,
		TSMLoc	obj,
		TSIOBuffer	iobufp
	)

Definition at line 3548 of file InkAPI.cc.

References MIOBuffer::add_block(), IOBufferBlock::end(), MIOBuffer::fill(), MIOBuffer::get_current_block(), HDR_HEAP_OBJ_HTTP_HEADER, ink_assert, HTTPHdr::m_http, HdrHeapObjImpl::m_type, HTTPHdr::print(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_iocore_structure(), sdk_sanity_check_mbuffer(), SET_HTTP_HDR, TS_SUCCESS, and IOBufferBlock::write_avail().

Referenced by convert_http_hdr_to_string(), and SDK_API_TSHttpHdr().

const char* TSHttpHdrReasonGet	(	TSMBuffer	bufp,
		TSMLoc	obj,
		int *	length
	)

Definition at line 3834 of file InkAPI.cc.

References HTTPHdr::reason_get(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), SET_HTTP_HDR, and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr(), and SpdyNV::SpdyNV().

const char* TSHttpHdrReasonLookup ( TSHttpStatus status )

Definition at line 3874 of file InkAPI.cc.

References http_hdr_reason_lookup().

Referenced by SDK_API_TSHttpHdr().

TSReturnCode TSHttpHdrReasonSet	(	TSMBuffer	bufp,
		TSMLoc	obj,
		const char *	value,
		int	length
	)

Definition at line 3847 of file InkAPI.cc.

References isWriteable(), HTTPHdr::reason_set(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), SET_HTTP_HDR, and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr().

TSHttpStatus TSHttpHdrStatusGet	(	TSMBuffer	bufp,
		TSMLoc	obj
	)

Definition at line 3801 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), SET_HTTP_HDR, HTTPHdr::status_get(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr(), SpdyNV::SpdyNV(), and transformable().

TSReturnCode TSHttpHdrStatusSet	(	TSMBuffer	bufp,
		TSMLoc	obj,
		TSHttpStatus	status
	)

Definition at line 3813 of file InkAPI.cc.

References HDR_HEAP_OBJ_HTTP_HEADER, ink_assert, isWriteable(), HTTPHdr::m_http, HdrHeapObjImpl::m_type, sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), SET_HTTP_HDR, HTTPHdr::status_set(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr().

TSHttpType TSHttpHdrTypeGet	(	TSMBuffer	bufp,
		TSMLoc	obj
	)

Definition at line 3636 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), SET_HTTP_HDR, TS_SUCCESS, and HTTPHdr::type_get().

Referenced by SDK_API_TSHttpHdr().

TSReturnCode TSHttpHdrTypeSet	(	TSMBuffer	bufp,
		TSMLoc	obj,
		TSHttpType	type
	)

Definition at line 3650 of file InkAPI.cc.

References HDR_HEAP_OBJ_HTTP_HEADER, HTTP_TYPE_REQUEST, HTTP_TYPE_UNKNOWN, ink_assert, isWriteable(), HdrHeapSDKHandle::m_heap, HTTPHdr::m_http, HTTPHdrImpl::m_polarity, HdrHeapObjImpl::m_type, HTTPHdrImpl::req, sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), SET_HTTP_HDR, TS_HTTP_TYPE_RESPONSE, TS_HTTP_TYPE_UNKNOWN, TS_SUCCESS, HTTPHdrImpl::u, and url_create().

Referenced by SDK_API_TSHttpHdr(), TSHttpHdrCopy(), TSHttpHdrParseReq(), and TSHttpHdrParseResp().

TSReturnCode TSHttpHdrUrlGet	(	TSMBuffer	bufp,
		TSMLoc	obj,
		TSMLoc *	locp
	)

Definition at line 3761 of file InkAPI.cc.

References HTTP_TYPE_REQUEST, HTTPHdrImpl::m_polarity, HTTPHdrImpl::req, sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), TS_SUCCESS, and HTTPHdrImpl::u.

Referenced by SDK_API_TSHttpHdr().

TSReturnCode TSHttpHdrUrlSet	(	TSMBuffer	bufp,
		TSMLoc	obj,
		TSMLoc	url
	)

Definition at line 3776 of file InkAPI.cc.

References HDR_HEAP_OBJ_HTTP_HEADER, http_hdr_url_set(), isWriteable(), HdrHeapObjImpl::m_type, sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_url_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr().

int TSHttpHdrVersionGet	(	TSMBuffer	bufp,
		TSMLoc	obj
	)

Definition at line 3688 of file InkAPI.cc.

References HTTPVersion::m_version, sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), SET_HTTP_HDR, TS_SUCCESS, and HTTPHdr::version_get().

Referenced by SDK_API_TSHttpHdr(), and SpdyNV::SpdyNV().

TSReturnCode TSHttpHdrVersionSet	(	TSMBuffer	bufp,
		TSMLoc	obj,
		int	ver
	)

Definition at line 3701 of file InkAPI.cc.

References HDR_HEAP_OBJ_HTTP_HEADER, ink_assert, isWriteable(), HTTPHdr::m_http, HdrHeapObjImpl::m_type, sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), SET_HTTP_HDR, TS_SUCCESS, and HTTPHdr::version_set().

Referenced by SDK_API_TSHttpHdr().

void TSHttpHookAdd	(	TSHttpHookID	id,
		TSCont	contp
	)

Definition at line 4379 of file InkAPI.cc.

References FeatureAPIHooks< ID, N >::append(), sdk_assert, sdk_sanity_check_continuation(), sdk_sanity_check_hook_id(), and TS_SUCCESS.

Referenced by altinfo_hook_handler(), SDK_API_HttpAltInfo(), SDK_API_HttpHookAdd(), SDK_API_HttpSsn(), SDK_API_HttpTxnCache(), SDK_API_HttpTxnTransform(), SDK_API_TSHttpConnectIntercept(), SDK_API_TSHttpConnectServerIntercept(), and PrefetchProcessor::start().

const char* TSHttpHookNameLookup ( TSHttpHookID hook )

Return a string respresentation for a TSHttpHookID value.

This is useful for plugin debugging.

Parameters:

hook

the value of this TSHttpHookID

Returns:: the string representation of the hook ID

Definition at line 8617 of file InkAPI.cc.

References HttpDebugNames::get_api_hook_name().

Referenced by SDK_API_DEBUG_NAME_LOOKUPS().

void TSHttpIcpDynamicSet ( int value )

Definition at line 4397 of file InkAPI.cc.

References icp_dynamic_enabled.

TSReturnCode TSHttpIsInternalRequest ( TSHttpTxn txnp )

Definition at line 7403 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), TS_SUCCESS, TSHttpIsInternalSession(), and TSHttpTxnSsnGet().

TSReturnCode TSHttpIsInternalSession ( TSHttpSsn ssnp )

Definition at line 7387 of file InkAPI.cc.

References NetVConnection::get_is_internal_request(), HttpClientSession::get_netvc(), and TS_SUCCESS.

Referenced by TSHttpIsInternalRequest().

void TSHttpParserClear ( TSHttpParser parser )

Definition at line 3441 of file InkAPI.cc.

References http_parser_clear(), sdk_assert, sdk_sanity_check_http_parser(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdrParse().

TSHttpParser TSHttpParserCreate ( void )

Definition at line 3432 of file InkAPI.cc.

References ats_malloc(), and http_parser_init().

Referenced by SDK_API_TSHttpHdrParse().

void TSHttpParserDestroy ( TSHttpParser parser )

Definition at line 3448 of file InkAPI.cc.

References ats_free(), http_parser_clear(), sdk_assert, sdk_sanity_check_http_parser(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdrParse().

TSAction TSHttpSchedule	(	TSCont	contp,
		TSHttpTxn	txnp,
		ink_hrtime	timeout
	)

Definition at line 4332 of file InkAPI.cc.

References ET_NET, eventProcessor, FORCE_PLUGIN_MUTEX, HRTIME_MSECONDS, ink_assert, INKContInternal::m_event_count, EventProcessor::schedule_imm(), EventProcessor::schedule_in(), sdk_assert, sdk_sanity_check_iocore_structure(), HttpSM::set_http_schedule(), and TS_SUCCESS.

const char* TSHttpServerStateNameLookup ( TSServerState state )

Return a string respresentation for a TSServerState value.

This is useful for plugin debugging.

Parameters:

state

the value of this TSServerState

Returns:: the string representation of the state

Definition at line 8611 of file InkAPI.cc.

References HttpDebugNames::get_server_state_name().

Referenced by SDK_API_DEBUG_NAME_LOOKUPS().

void* TSHttpSsnArgGet	(	TSHttpSsn	ssnp,
		int	arg_idx
	)

Definition at line 5627 of file InkAPI.cc.

References ProxyClientSession::get_user_arg(), HTTP_SSN_TXN_MAX_USER_ARG, sdk_assert, sdk_sanity_check_http_ssn(), and TS_SUCCESS.

void TSHttpSsnArgSet	(	TSHttpSsn	ssnp,
		int	arg_idx,
		void *	arg
	)

Definition at line 5616 of file InkAPI.cc.

References HTTP_SSN_TXN_MAX_USER_ARG, sdk_assert, sdk_sanity_check_http_ssn(), ProxyClientSession::set_user_arg(), and TS_SUCCESS.

sockaddr const* TSHttpSsnClientAddrGet ( TSHttpSsn ssnp ) [read]

Definition at line 5191 of file InkAPI.cc.

References HttpClientSession::get_netvc(), and NetVConnection::get_remote_addr().

Referenced by TSHttpTxnClientAddrGet().

TSReturnCode TSHttpSsnClientFdGet	(	TSHttpSsn	ssnp,
		int *	fdp
	)

Definition at line 6905 of file InkAPI.cc.

References HttpClientSession::get_netvc(), NetVConnection::get_socket(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

Referenced by TSHttpTxnClientFdGet().

int TSHttpSsnDebugGet ( TSHttpSsn ssnp )

Definition at line 5743 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_http_ssn(), and TS_SUCCESS.

void TSHttpSsnDebugSet	(	TSHttpSsn	ssnp,
		int	on
	)

Set the session specific debugging flag for this client session.

When turned on, internal debug messages related to this session and all transactions in the session will be written even if the debug tag isn't on.

Parameters:

	ssnp	Client session to change.
	on	set to 1 to turn on, 0 to turn off.

Definition at line 5736 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_http_ssn(), and TS_SUCCESS.

void TSHttpSsnHookAdd	(	TSHttpSsn	ssnp,
		TSHttpHookID	id,
		TSCont	contp
	)

Definition at line 4412 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_continuation(), sdk_sanity_check_hook_id(), sdk_sanity_check_http_ssn(), HttpClientSession::ssn_hook_append(), and TS_SUCCESS.

Referenced by ssn_handler().

sockaddr const* TSHttpSsnIncomingAddrGet ( TSHttpSsn ssnp ) [read]

Definition at line 5212 of file InkAPI.cc.

References NetVConnection::get_local_addr(), and HttpClientSession::get_netvc().

Referenced by TSHttpTxnIncomingAddrGet().

void TSHttpSsnReenable	(	TSHttpSsn	ssnp,
		TSEvent	event
	)

Definition at line 4454 of file InkAPI.cc.

References ET_NET, eventProcessor, Continuation::handleEvent(), Continuation::mutex, MUTEX_TRY_LOCK, REGULAR, EventProcessor::schedule_imm(), sdk_assert, sdk_sanity_check_http_ssn(), this_ethread(), TS_SUCCESS, and EThread::tt.

Referenced by ssn_handler().

void* TSHttpSsnSSLConnectionGet ( TSHttpSsn ssnp )

Get SSL object of this session.

Retrieves the SSL object of the SSL connection.

Returns:: SSL object of this session

Definition at line 5173 of file InkAPI.cc.

References HttpClientSession::get_netvc(), sdk_assert, sdk_sanity_check_null_ptr(), SSLNetVConnection::ssl, and TS_SUCCESS.

int TSHttpSsnTransactionCount ( TSHttpSsn ssnp )

Definition at line 4423 of file InkAPI.cc.

References HttpClientSession::get_transact_count(), sdk_assert, sdk_sanity_check_http_ssn(), and TS_SUCCESS.

TSReturnCode TSHttpTxnAborted ( TSHttpTxn txnp )

Check if transaction was aborted (due client/server errors etc.

)

Returns:: 1 if transaction was aborted

Definition at line 5074 of file InkAPI.cc.

References HttpTransact::ABORTED, HttpTransact::State::current, sdk_assert, sdk_sanity_check_txn(), HttpTransact::State::squid_codes, SQUID_LOG_ERR_CLIENT_ABORT, SQUID_LOG_TCP_SWAPFAIL, HttpSM::t_state, and TS_SUCCESS.

void TSHttpTxnActiveTimeoutSet	(	TSHttpTxn	txnp,
		int	timeout
	)

timeout is in msec overrides as proxy.config.http.transaction_active_timeout_out

Definition at line 4978 of file InkAPI.cc.

References HttpTransact::State::api_txn_active_timeout_value, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

void* TSHttpTxnArgGet	(	TSHttpTxn	txnp,
		int	arg_idx
	)

Definition at line 5606 of file InkAPI.cc.

References HTTP_SSN_TXN_MAX_USER_ARG, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, and HttpTransact::State::user_args.

void TSHttpTxnArgSet	(	TSHttpTxn	txnp,
		int	arg_idx,
		void *	arg
	)

Definition at line 5596 of file InkAPI.cc.

References HTTP_SSN_TXN_MAX_USER_ARG, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, and HttpTransact::State::user_args.

int TSHttpTxnBackgroundFillStarted ( TSHttpTxn txnp )

Definition at line 8574 of file InkAPI.cc.

References HttpSM::background_fill, BACKGROUND_FILL_STARTED, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

TSReturnCode TSHttpTxnCachedReqGet	(	TSHttpTxn	txnp,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 4642 of file InkAPI.cc.

References Arena::alloc(), HttpTransact::State::arena, HttpTransact::State::cache_info, HttpTransact::State::cache_req_hdr_heap_handle, HdrHeapSDKHandle::m_heap, HTTPHdr::m_http, sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, HTTPHdr::valid(), and HTTPInfo::valid().

Referenced by cache_hook_handler().

TSReturnCode TSHttpTxnCachedRespGet	(	TSHttpTxn	txnp,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 4680 of file InkAPI.cc.

References Arena::alloc(), HttpTransact::State::arena, HttpTransact::State::cache_info, HttpTransact::State::cache_resp_hdr_heap_handle, HdrHeapSDKHandle::m_heap, HTTPHdr::m_http, sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, HTTPHdr::valid(), and HTTPInfo::valid().

Referenced by cache_hook_handler().

TSReturnCode TSHttpTxnCachedRespModifiableGet	(	TSHttpTxn	txnp,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 4719 of file InkAPI.cc.

References HttpTransact::State::api_modifiable_cached_resp, HttpTransact::State::cache_info, HTTPInfo::create(), ink_assert, HTTPHdr::m_http, HTTPInfo::response_get(), HTTPInfo::response_set(), sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, HTTPHdr::valid(), and HTTPInfo::valid().

TSReturnCode TSHttpTxnCachedRespTimeGet	(	TSHttpTxn	txnp,
		time_t *	resp_time
	)

Definition at line 5917 of file InkAPI.cc.

References HttpTransact::State::cache_info, HTTPInfo::response_received_time_get(), sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, TS_ERROR, TS_SUCCESS, and HTTPInfo::valid().

TSReturnCode TSHttpTxnCacheLookupCountGet	(	TSHttpTxn	txnp,
		int *	lookup_count
	)

Definition at line 4782 of file InkAPI.cc.

References HttpTransact::State::cache_info, sdk_assert, sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

TSReturnCode TSHttpTxnCacheLookupStatusGet	(	TSHttpTxn	txnp,
		int *	lookup_status
	)

Definition at line 4752 of file InkAPI.cc.

References HttpTransact::CACHE_LOOKUP_DOC_BUSY, HttpTransact::CACHE_LOOKUP_HIT_FRESH, HttpTransact::CACHE_LOOKUP_HIT_STALE, HttpTransact::CACHE_LOOKUP_HIT_WARNING, HttpTransact::CACHE_LOOKUP_MISS, HttpTransact::CACHE_LOOKUP_NONE, HttpTransact::State::cache_lookup_result, HttpTransact::CACHE_LOOKUP_SKIPPED, sdk_assert, sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

Referenced by cache_hook_handler(), and PrefetchPlugin().

TSReturnCode TSHttpTxnCacheLookupStatusSet	(	TSHttpTxn	txnp,
		int	cachelookup
	)

Definition at line 4798 of file InkAPI.cc.

References HttpTransact::State::api_cleanup_cache_read, HttpTransact::CACHE_LOOKUP_MISS, HttpTransact::State::cache_lookup_result, ink_assert, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, HttpTransact::State::transact_return_point, TS_CACHE_LOOKUP_HIT_FRESH, TS_CACHE_LOOKUP_HIT_STALE, TS_CACHE_LOOKUP_MISS, and TS_SUCCESS.

TSReturnCode TSHttpTxnCacheLookupUrlGet	(	TSHttpTxn	txnp,
		TSMBuffer	bufp,
		TSMLoc	obj
	)

Definition at line 4834 of file InkAPI.cc.

References HttpTransact::State::cache_info, URL::copy(), HdrHeapSDKHandle::m_heap, URL::m_url_impl, sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_txn(), sdk_sanity_check_url_handle(), HttpSM::t_state, TS_ERROR, TS_SUCCESS, and URL::valid().

sockaddr const* TSHttpTxnClientAddrGet ( TSHttpTxn txnp ) [read]

Get client address for transaction txnp.

Retrieves the socket address of the remote client that has connected to Traffic Server for transaction txnp. The return structure is the generic socket address storage in order to be address-family agnostic. The user of this function can then go on to do the appropriate thing with the type specified in the ss_family field of the structure whether that be for IPv4, IPv6, or any other address family.

Returns:: Client address for connection to client in transaction txnp.

Definition at line 5203 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), TS_SUCCESS, TSHttpSsnClientAddrGet(), and TSHttpTxnSsnGet().

Referenced by checkHttpTxnClientAddrGet(), and checkHttpTxnClientIPGet().

TSReturnCode TSHttpTxnClientFdGet	(	TSHttpTxn	txnp,
		int *	fdp
	)

Definition at line 6922 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), TS_SUCCESS, TSHttpSsnClientFdGet(), and TSHttpTxnSsnGet().

void TSHttpTxnClientIncomingPortSet	(	TSHttpTxn	txnp,
		int	port
	)

Definition at line 5258 of file InkAPI.cc.

References HttpTransact::State::client_info, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

void TSHttpTxnClientKeepaliveSet	(	TSHttpTxn	txnp,
		int	set
	)

Definition at line 4519 of file InkAPI.cc.

References HttpTransact::State::hdr_info, and HttpSM::t_state.

TSReturnCode TSHttpTxnClientPacketMarkSet	(	TSHttpTxn	txnp,
		int	mark
	)

Change packet firewall mark for the client side connection.

Note:: The change takes effect immediately

Returns:: TS_SUCCESS if the client connection was modified

Definition at line 5322 of file InkAPI.cc.

References NetVConnection::apply_options(), HttpClientSession::get_netvc(), NetVConnection::options, NetVCOptions::packet_mark, sdk_assert, sdk_sanity_check_txn(), TS_SUCCESS, and HttpSM::ua_session.

TSReturnCode TSHttpTxnClientPacketTosSet	(	TSHttpTxn	txnp,
		int	tos
	)

Change packet TOS for the client side connection.

Note:: The change takes effect immediately; TOS is deprecated and replaced by DSCP, this is still used to set DSCP however the first 2 bits of this value will be ignored as they now belong to the ECN field.

Returns:: TS_SUCCESS if the client connection was modified

Definition at line 5364 of file InkAPI.cc.

References NetVConnection::apply_options(), HttpClientSession::get_netvc(), NetVConnection::options, NetVCOptions::packet_tos, sdk_assert, sdk_sanity_check_txn(), TS_SUCCESS, and HttpSM::ua_session.

int64_t TSHttpTxnClientReqBodyBytesGet ( TSHttpTxn txnp )

Definition at line 5759 of file InkAPI.cc.

References HttpSM::client_request_body_bytes, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

TSReturnCode TSHttpTxnClientReqGet	(	TSHttpTxn	txnp,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 4528 of file InkAPI.cc.

References HttpTransact::State::hdr_info, HTTPHdr::m_http, HTTPHdr::mark_target_dirty(), sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, and HTTPHdr::valid().

Referenced by checkHttpTxnClientReqGet(), get_request_id(), and transform_hook_handler().

int TSHttpTxnClientReqHdrBytesGet ( TSHttpTxn txnp )

Definition at line 5750 of file InkAPI.cc.

References HttpSM::client_request_hdr_bytes, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

int TSHttpTxnClientReqIsServerStyle ( TSHttpTxn txnp )

Definition at line 5115 of file InkAPI.cc.

References HttpTransact::State::hdr_info, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

int64_t TSHttpTxnClientRespBodyBytesGet ( TSHttpTxn txnp )

Definition at line 5813 of file InkAPI.cc.

References HttpSM::client_response_body_bytes, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

TSReturnCode TSHttpTxnClientRespGet	(	TSHttpTxn	txnp,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 4581 of file InkAPI.cc.

References HttpTransact::State::hdr_info, HTTPHdr::m_http, sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, and HTTPHdr::valid().

Referenced by checkHttpTxnClientRespGet().

int TSHttpTxnClientRespHdrBytesGet ( TSHttpTxn txnp )

Definition at line 5804 of file InkAPI.cc.

References HttpSM::client_response_hdr_bytes, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

TSReturnCode TSHttpTxnCloseAfterResponse	(	TSHttpTxn	txnp,
		int	should_close
	)

Definition at line 8507 of file InkAPI.cc.

References HttpTransact::State::client_info, HTTP_NO_KEEPALIVE, sdk_sanity_check_txn(), HttpSM::set_ua_half_close_flag(), HttpSM::t_state, TS_SUCCESS, and HttpSM::ua_session.

TSReturnCode TSHttpTxnCntl	(	TSHttpTxn	txnp,
		TSHttpCntlType	cntl,
		void *	data
	)

Definition at line 5647 of file InkAPI.cc.

References HttpTransact::State::api_info, _HttpApiInfo::logging_enabled, _HttpApiInfo::retry_intercept_failures, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, TS_HTTP_CNTL_GET_INTERCEPT_RETRY_MODE, TS_HTTP_CNTL_GET_LOGGING_MODE, TS_HTTP_CNTL_OFF, TS_HTTP_CNTL_ON, TS_HTTP_CNTL_SET_INTERCEPT_RETRY_MODE, TS_HTTP_CNTL_SET_LOGGING_MODE, and TS_SUCCESS.

TSReturnCode TSHttpTxnConfigFind	(	const char *	name,
		int	length,
		TSOverridableConfigKey *	conf,
		TSRecordDataType *	type
	)

Definition at line 8041 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_null_ptr(), TS_CONFIG_NULL, TS_ERROR, and TS_SUCCESS.

Referenced by SDK_API_OVERRIDABLE_CONFIGS().

TSReturnCode TSHttpTxnConfigFloatGet	(	TSHttpTxn	txnp,
		TSOverridableConfigKey	conf,
		TSMgmtFloat *	value
	)

Definition at line 7953 of file InkAPI.cc.

References _conf_to_memberp(), OVERRIDABLE_TYPE_FLOAT, sdk_assert, sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), and TS_SUCCESS.

Referenced by SDK_API_OVERRIDABLE_CONFIGS().

TSReturnCode TSHttpTxnConfigFloatSet	(	TSHttpTxn	txnp,
		TSOverridableConfigKey	conf,
		TSMgmtFloat	value
	)

Definition at line 7930 of file InkAPI.cc.

References _conf_to_memberp(), OVERRIDABLE_TYPE_FLOAT, sdk_assert, sdk_sanity_check_txn(), HttpTransact::State::setup_per_txn_configs(), HttpSM::t_state, TS_SUCCESS, and HttpTransact::State::txn_conf.

Referenced by SDK_API_OVERRIDABLE_CONFIGS().

TSReturnCode TSHttpTxnConfigIntGet	(	TSHttpTxn	txnp,
		TSOverridableConfigKey	conf,
		TSMgmtInt *	value
	)

Definition at line 7886 of file InkAPI.cc.

References _conf_to_memberp(), OVERRIDABLE_TYPE_BYTE, OVERRIDABLE_TYPE_INT, sdk_assert, sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), OverridableHttpConfigParams::server_session_sharing_match, OverridableHttpConfigParams::server_session_sharing_pool, HttpSM::t_state, TS_CONFIG_HTTP_SHARE_SERVER_SESSIONS, TS_SERVER_SESSION_SHARING_MATCH_BOTH, TS_SERVER_SESSION_SHARING_MATCH_NONE, TS_SERVER_SESSION_SHARING_POOL_GLOBAL, TS_SERVER_SESSION_SHARING_POOL_THREAD, TS_SUCCESS, and HttpTransact::State::txn_conf.

Referenced by SDK_API_OVERRIDABLE_CONFIGS().

TSReturnCode TSHttpTxnConfigIntSet	(	TSHttpTxn	txnp,
		TSOverridableConfigKey	conf,
		TSMgmtInt	value
	)

Definition at line 7837 of file InkAPI.cc.

References _conf_to_memberp(), OVERRIDABLE_TYPE_BYTE, OVERRIDABLE_TYPE_INT, sdk_assert, sdk_sanity_check_txn(), OverridableHttpConfigParams::server_session_sharing_match, OverridableHttpConfigParams::server_session_sharing_pool, HttpTransact::State::setup_per_txn_configs(), HttpSM::t_state, TS_CONFIG_HTTP_SHARE_SERVER_SESSIONS, TS_SUCCESS, and HttpTransact::State::txn_conf.

Referenced by SDK_API_OVERRIDABLE_CONFIGS(), TSHttpTxnServerPacketMarkSet(), and TSHttpTxnServerPacketTosSet().

TSReturnCode TSHttpTxnConfigStringGet	(	TSHttpTxn	txnp,
		TSOverridableConfigKey	conf,
		const char **	value,
		int *	length
	)

Definition at line 8013 of file InkAPI.cc.

References OverridableHttpConfigParams::global_user_agent_header, OverridableHttpConfigParams::global_user_agent_header_size, OverridableHttpConfigParams::proxy_response_server_string, OverridableHttpConfigParams::proxy_response_server_string_len, sdk_assert, sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, TS_CONFIG_HTTP_GLOBAL_USER_AGENT_HEADER, TS_CONFIG_HTTP_RESPONSE_SERVER_STR, TS_SUCCESS, and HttpTransact::State::txn_conf.

Referenced by SDK_API_OVERRIDABLE_CONFIGS().

TSReturnCode TSHttpTxnConfigStringSet	(	TSHttpTxn	txnp,
		TSOverridableConfigKey	conf,
		const char *	value,
		int	length
	)

Definition at line 7973 of file InkAPI.cc.

References OverridableHttpConfigParams::global_user_agent_header, OverridableHttpConfigParams::global_user_agent_header_size, OverridableHttpConfigParams::proxy_response_server_string, OverridableHttpConfigParams::proxy_response_server_string_len, sdk_assert, sdk_sanity_check_txn(), HttpTransact::State::setup_per_txn_configs(), HttpSM::t_state, TS_CONFIG_HTTP_GLOBAL_USER_AGENT_HEADER, TS_CONFIG_HTTP_RESPONSE_SERVER_STR, TS_SUCCESS, and HttpTransact::State::txn_conf.

Referenced by SDK_API_OVERRIDABLE_CONFIGS().

void TSHttpTxnConnectTimeoutSet	(	TSHttpTxn	txnp,
		int	timeout
	)

timeout is in msec overrides as proxy.config.http.connect_attempts_timeout

Definition at line 4991 of file InkAPI.cc.

References HttpTransact::State::api_txn_connect_timeout_value, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

int TSHttpTxnDebugGet ( TSHttpTxn txnp )

Returns the transaction specific debugging flag for this transaction.

Parameters:

txnp

transaction to check.

Returns:: 1 if enabled, 0 otherwise.

Definition at line 5729 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

void TSHttpTxnDebugSet	(	TSHttpTxn	txnp,
		int	on
	)

Set the transaction specific debugging flag for this transaction.

When turned on, internal debug messages related to this transaction will be written even if the debug tag isn't on.

Parameters:

	txnp	transaction to change.
	on	set to 1 to turn on, 0 to turn off.

Definition at line 5722 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

void TSHttpTxnDNSTimeoutSet	(	TSHttpTxn	txnp,
		int	timeout
	)

timeout is in msec overrides as proxy.config.dns.lookup_timeout

Definition at line 5004 of file InkAPI.cc.

References HttpTransact::State::api_txn_dns_timeout_value, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

char* TSHttpTxnEffectiveUrlStringGet	(	TSHttpTxn	txnp,
		int *	length
	)

Get the effective URL for the transaction.

The effective URL is the URL taking in to account both the explicit URL in the request and the HOST field.

A possibly non-null terminated string is returned.

Note:: The returned string is allocated and must be freed by the caller after use with TSfree.

Parameters:

length String length return, may be NULL.

Definition at line 4571 of file InkAPI.cc.

References HttpTransact::State::hdr_info, sdk_assert, sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

void TSHttpTxnErrorBodySet	(	TSHttpTxn	txnp,
		char *	buf,
		size_t	buflength,
		char *	mimetype
	)

Sets an error type body to a transaction.

Note that both string arguments must be allocated with TSmalloc() or TSstrdup(). The mimetype argument is optional, if not provided it defaults to "text/html". Sending an emptry string would prevent setting a content type header (but that is not adviced).

Parameters:

	txnp	HTTP transaction whose parent proxy to get.
	buf	The body message (must be heap allocated).
	buflength	Length of the body message.
	mimetype	The MIME type to set the response to (can be NULL, but must be heap allocated if non-NULL).

Definition at line 5407 of file InkAPI.cc.

References ats_free(), HttpTransact::State::free_internal_msg_buffer(), HttpTransact::State::internal_msg_buffer, HttpTransact::State::internal_msg_buffer_fast_allocator_size, HttpTransact::State::internal_msg_buffer_size, HttpTransact::State::internal_msg_buffer_type, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

Referenced by ssn_handler().

TSReturnCode TSHttpTxnFollowRedirect	(	TSHttpTxn	txnp,
		int	on
	)

This API informs the core to try to follow redirections (e.g.

301 responses. The new URL would be provided in the standard Location header.

Parameters:

	txnp	the transaction pointer
	on	turn this on or off (0 or 1)

Returns:: TS_SUCCESS if it succeeded

Definition at line 7137 of file InkAPI.cc.

References HttpSM::enable_redirection, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

void TSHttpTxnHookAdd	(	TSHttpTxn	txnp,
		TSHttpHookID	id,
		TSCont	contp
	)

Definition at line 4479 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_continuation(), sdk_sanity_check_hook_id(), sdk_sanity_check_txn(), TS_SUCCESS, and HttpSM::txn_hook_append().

Referenced by check_n_attach_prefetch_transform(), ssn_handler(), transform_add(), and transform_hook_handler().

TSReturnCode TSHttpTxnHookRegisteredFor	(	TSHttpTxn	txnp,
		TSHttpHookID	id,
		TSEventFunc	funcp
	)

Definition at line 4493 of file InkAPI.cc.

References APIHook::m_cont, INKContInternal::m_event_func, APIHook::next(), and HttpSM::txn_hook_get().

sockaddr const* TSHttpTxnIncomingAddrGet ( TSHttpTxn txnp ) [read]

Get the incoming address.

Note:: The pointer is valid only for the current callback. Clients that need to keep the value across callbacks must maintain their own storage.

Returns:: Local address of the client connection for transaction txnp.

Definition at line 5224 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), TS_SUCCESS, TSHttpSsnIncomingAddrGet(), and TSHttpTxnSsnGet().

Referenced by checkHttpTxnIncomingAddrGet().

void TSHttpTxnIntercept	(	TSCont	contp,
		TSHttpTxn	txnp
	)

Allows a plugin take over the servicing of the request as though it was the origin server.

contp will be sent TS_EVENT_NET_ACCEPT. The edata passed with TS_NET_EVENT_ACCEPT is an TSVConn just as it would be for a normal accept. The plugin must act as if it is an http server and read the http request and body off the TSVConn and send an http response header and body.

TSHttpTxnIntercept() must be called be called from only TS_HTTP_READ_REQUEST_HOOK. Using TSHttpTxnIntercept will bypass the Traffic Server cache. If response sent by the plugin should be cached, use TSHttpTxnServerIntercept() instead. TSHttpTxnIntercept() primary use is allow plugins to serve data about their functioning directly.

TSHttpTxnIntercept() must only be called once per transaction.

Parameters:

	contp	continuation called to handle the interception.
	txnp	transaction to be intercepted.

Definition at line 6379 of file InkAPI.cc.

References PluginVCCore::alloc(), Continuation::mutex, HttpSM::plugin_tunnel, HttpSM::plugin_tunnel_type, sdk_assert, sdk_sanity_check_continuation(), sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), PluginVCCore::set_accept_cont(), and TS_SUCCESS.

Referenced by cont_test_handler().

int TSHttpTxnIsCacheable	(	TSHttpTxn	txnp,
		TSMBuffer	request,
		TSMBuffer	response
	)

Test whether a request / response header pair would be cacheable under the current configuration.

This would typically be used in TS_HTTP_READ_RESPONSE_HDR_HOOK, when you have both the client request and server response ready.

Parameters:

	txnp	the transaction pointer
	request	the client request header. If NULL, use the transactions client request.
	response	the server response header. If NULL, use the transactions origin response.

Returns:: 1 if the request / response is cacheable, 0 otherwise

Definition at line 8583 of file InkAPI.cc.

References HttpTransact::State::hdr_info, HttpTransact::is_response_cacheable(), sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, and HTTPHdr::valid().

int TSHttpTxnLookingUpTypeGet ( TSHttpTxn txnp )

Definition at line 5932 of file InkAPI.cc.

References HttpTransact::State::current, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

TSReturnCode TSHttpTxnMilestoneGet	(	TSHttpTxn	txnp,
		TSMilestonesType	milestone,
		ink_hrtime *	time
	)

Definition at line 5842 of file InkAPI.cc.

TSReturnCode TSHttpTxnNewCacheLookupDo	(	TSHttpTxn	txnp,
		TSMBuffer	bufp,
		TSMLoc	url_loc
	)

sockaddr const* TSHttpTxnNextHopAddrGet ( TSHttpTxn txnp ) [read]

Get the next hop address.

Note:: The pointer is valid only for the current callback. Clients that need to keep the value across callbacks must maintain their own storage.

Returns:: The address of the next hop for transaction txnp.

Return zero if the server structure is not yet constructed.

Definition at line 5288 of file InkAPI.cc.

References HttpTransact::State::current, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

Referenced by checkHttpTxnNextHopIPGet().

void TSHttpTxnNoActivityTimeoutSet	(	TSHttpTxn	txnp,
		int	timeout
	)

timeout is in msec overrides as proxy.config.http.transaction_no_activity_timeout_out

Definition at line 5019 of file InkAPI.cc.

References HttpTransact::State::api_txn_no_activity_timeout_value, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

TSReturnCode TSHttpTxnOutgoingAddrSet	(	TSHttpTxn	txnp,
		const struct sockaddr *	addr
	)

Definition at line 5269 of file InkAPI.cc.

References IpAddr::assign(), ats_ip_port_host_order(), ats_is_ip4(), ats_is_ip6(), IpAddr::invalidate(), HttpClientSession::outbound_ip4, HttpClientSession::outbound_ip6, HttpClientSession::outbound_port, sdk_assert, sdk_sanity_check_txn(), TS_SUCCESS, and HttpSM::ua_session.

TSReturnCode TSHttpTxnOutgoingTransparencySet	(	TSHttpTxn	txnp,
		int	flag
	)

Definition at line 5304 of file InkAPI.cc.

References HttpClientSession::f_outbound_transparent, sdk_sanity_check_txn(), TS_SUCCESS, and HttpSM::ua_session.

void TSHttpTxnOverwriteExpireTime	(	TSHttpTxn	txnp,
		time_t	expire_time
	)

Definition at line 5124 of file InkAPI.cc.

References HttpTransact::State::plugin_set_expire_time, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

TSReturnCode TSHttpTxnParentProxyGet	(	TSHttpTxn	txnp,
		char **	hostname,
		int *	port
	)

Retrieves the parent proxy hostname and port, if parent proxying is enabled.

If parent proxying is not enabled, TSHttpTxnParentProxyGet() sets hostname to NULL and port to -1.

Parameters:

	txnp	HTTP transaction whose parent proxy to get.
	hostname	of the parent proxy.
	port	parent proxy's port.

Definition at line 5449 of file InkAPI.cc.

References HttpTransact::State::api_info, _HttpApiInfo::parent_proxy_name, _HttpApiInfo::parent_proxy_port, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

Referenced by checkHttpTxnParentProxy().

void TSHttpTxnParentProxySet	(	TSHttpTxn	txnp,
		char *	hostname,
		int	port
	)

Sets the parent proxy name and port.

The string hostname is copied into the TSHttpTxn; you can modify or delete the string after calling TSHttpTxnParentProxySet().

Parameters:

	txnp	HTTP transaction whose parent proxy to set.
	hostname	parent proxy host name string.
	port	parent proxy port to set.

Definition at line 5462 of file InkAPI.cc.

References HttpTransact::State::api_info, HttpTransact::State::arena, _HttpApiInfo::parent_proxy_name, _HttpApiInfo::parent_proxy_port, sdk_assert, sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), Arena::str_store(), HttpSM::t_state, and TS_SUCCESS.

Referenced by checkHttpTxnParentProxy().

TSReturnCode TSHttpTxnPristineUrlGet	(	TSHttpTxn	txnp,
		TSMBuffer *	bufp,
		TSMLoc *	url_loc
	)

Definition at line 4550 of file InkAPI.cc.

References HttpTransact::State::hdr_info, URL::m_url_impl, HttpTransact::State::pristine_url, sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, and HTTPHdr::valid().

TSReturnCode TSHttpTxnPrivateSessionSet	(	TSHttpTxn	txnp,
		int	private_session
	)

Definition at line 8465 of file InkAPI.cc.

References sdk_sanity_check_txn(), HttpSM::set_server_session_private(), and TS_SUCCESS.

int64_t TSHttpTxnPushedRespBodyBytesGet ( TSHttpTxn txnp )

Definition at line 5831 of file InkAPI.cc.

References HttpSM::pushed_response_body_bytes, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

int TSHttpTxnPushedRespHdrBytesGet ( TSHttpTxn txnp )

Definition at line 5822 of file InkAPI.cc.

References HttpSM::pushed_response_hdr_bytes, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

TSReturnCode TSHttpTxnRedirectRequest	(	TSHttpTxn	txnp,
		TSMBuffer	bufp,
		TSMLoc	url_loc
	)

int TSHttpTxnRedirectRetries ( TSHttpTxn txnp )

Return the number of redirection retries we have done.

This starts off at zero, and can be used to select different URLs based on which attempt this is. This can be useful for example when providing a list of URLs to try, and do so in order until one succeeds.

Parameters:

txnp

the transaction pointer

Returns:: the redirect try count

Definition at line 7213 of file InkAPI.cc.

References HttpSM::redirection_tries, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

const char* TSHttpTxnRedirectUrlGet	(	TSHttpTxn	txnp,
		int *	url_len_ptr
	)

Return the current (if set) redirection URL string.

This is still owned by the core, and must not be free'd.

Parameters:

	txnp	the transaction pointer
	url_len_ptr	a pointer to where the URL length is to be stored

Returns:: the url string

Definition at line 7195 of file InkAPI.cc.

References HttpSM::redirect_url, HttpSM::redirect_url_len, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

Referenced by TSRedirectUrlGet().

void TSHttpTxnRedirectUrlSet	(	TSHttpTxn	txnp,
		const char *	url,
		const int	url_len
	)

This is a generalization of the TSHttpTxnFollowRedirect(), but gives finer control over the behavior.

Instead of using the Location: header for the new destination, this API takes the new URL as a parameter. Calling this API transfers the ownership of the URL from the plugin to the core, so you must make sure it is heap allocated, and that you do not free it.

Calling this API implicitly also enables the "Follow Redirect" feature, so there is no rason to call TSHttpTxnFollowRedirect() as well.

Parameters:

	txnp	the transaction pointer
	url	a heap allocated string with the URL
	url_len	the length of the URL

Definition at line 7149 of file InkAPI.cc.

References ats_free(), HttpSM::enable_redirection, HttpSM::redirect_url, HttpSM::redirect_url_len, sdk_assert, sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), and TS_SUCCESS.

void TSHttpTxnReenable	(	TSHttpTxn	txnp,
		TSEvent	event
	)

Notifies the HTTP transaction txnp that the plugin is finished processing the current hook.

The plugin tells the transaction to either continue (TS_EVENT_HTTP_CONTINUE) or stop (TS_EVENT_HTTP_ERROR).

You must always reenable the HTTP transaction after the processing of each transaction event. However, never reenable twice. Reenabling twice is a serious error.

Parameters:

txnp

transaction to be reenabled.

event

tells the transaction how to continue:

TS_EVENT_HTTP_CONTINUE, which means that the transaction should continue.
TS_EVENT_HTTP_ERROR which terminates the transaction and sends an error to the client if no response has already been sent.

Definition at line 5517 of file InkAPI.cc.

References ET_NET, eventProcessor, Continuation::mutex, MUTEX_TRY_LOCK, REGULAR, EventProcessor::schedule_imm(), sdk_assert, sdk_sanity_check_txn(), HttpSM::state_api_callback(), this_ethread(), TS_SUCCESS, and EThread::tt.

Referenced by altinfo_hook_handler(), cache_hook_handler(), cont_test_handler(), mytest_handler(), PrefetchPlugin(), ssn_handler(), and transform_hook_handler().

void TSHttpTxnReqCacheableSet	(	TSHttpTxn	txnp,
		int	flag
	)

Definition at line 5097 of file InkAPI.cc.

References HttpTransact::State::api_req_cacheable, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

void TSHttpTxnRespCacheableSet	(	TSHttpTxn	txnp,
		int	flag
	)

Definition at line 5106 of file InkAPI.cc.

References HttpTransact::State::api_resp_cacheable, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

TSReturnCode TSHttpTxnSecondUrlTryLock ( TSHttpTxn txnp )

Definition at line 4913 of file InkAPI.cc.

References HttpSM::add_cache_sm(), HttpTransact::State::api_lock_url, HttpTransact::State::cache_info, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, TS_ERROR, and TS_SUCCESS.

sockaddr const* TSHttpTxnServerAddrGet ( TSHttpTxn txnp ) [read]

Get the origin server address.

Note:: The pointer is valid only for the current callback. Clients that need to keep the value across callbacks must maintain their own storage.

Returns:: The address of the origin server for transaction txnp.

Definition at line 5233 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), HttpTransact::State::server_info, HttpSM::t_state, and TS_SUCCESS.

Referenced by checkHttpTxnServerIPGet().

TSReturnCode TSHttpTxnServerAddrSet	(	TSHttpTxn	txnp,
		struct sockaddr const *	addr
	)

Set the origin server address.

This must be invoked before the origin server address is looked up. If called no lookup is done, the address addr is used instead.

Returns:: TS_SUCCESS if the origin server address is set, TS_ERROR otherwise.

Parameters:

addr

Address for origin server.

Definition at line 5242 of file InkAPI.cc.

References HttpTransact::State::api_server_addr_set, ats_ip_copy(), ats_ip_port_cast(), sdk_assert, sdk_sanity_check_txn(), HttpTransact::State::server_info, HttpSM::t_state, and TS_SUCCESS.

void TSHttpTxnServerIntercept	(	TSCont	contp,
		TSHttpTxn	txnp
	)

Allows a plugin take over the servicing of the request as though it was the origin server.

In the event a request needs to be made to the server for transaction txnp, contp will be sent TS_EVENT_NET_ACCEPT. The edata passed with TS_NET_EVENT_ACCEPT is an TSVConn just as it would be for a normal accept. The plugin must act as if it is an http server and read the http request and body off the TSVConn and send an http response header and body.

TSHttpTxnInterceptServer() must be not be called after the connection to the server has taken place. The last hook last hook in that TSHttpTxnIntercept() can be called from is TS_HTTP_READ_CACHE_HDR_HOOK. If a connection to the server is not necessary, contp is not called.

The response from the plugin is cached subject to standard and configured http caching rules. Should the plugin wish the response not be cached, the plugin must use appropriate http response headers to prevent caching. The primary purpose of TSHttpTxnInterceptServer() is allow plugins to provide gateways to other protocols or to allow to plugin to it's own transport for the next hop to the server. TSHttpTxnInterceptServer() overrides parent cache configuration.

TSHttpTxnInterceptServer() must only be called once per transaction.

Parameters:

	contp	continuation called to handle the interception
	txnp	transaction to be intercepted.

Definition at line 6362 of file InkAPI.cc.

References PluginVCCore::alloc(), Continuation::mutex, HttpSM::plugin_tunnel, HttpSM::plugin_tunnel_type, sdk_assert, sdk_sanity_check_continuation(), sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), PluginVCCore::set_accept_cont(), and TS_SUCCESS.

Referenced by cont_test_handler().

TSReturnCode TSHttpTxnServerPacketMarkSet	(	TSHttpTxn	txnp,
		int	mark
	)

Change packet firewall mark for the server side connection.

Note:: The change takes effect immediately, if no OS connection has been made, then this sets the mark that will be used IF an OS connection is established

Returns:: TS_SUCCESS if the (future?) server connection was modified

Definition at line 5341 of file InkAPI.cc.

References NetVConnection::apply_options(), HttpServerSession::get_netvc(), HttpClientSession::get_server_session(), NetVConnection::options, NetVCOptions::packet_mark, sdk_assert, sdk_sanity_check_txn(), TS_CONFIG_NET_SOCK_PACKET_MARK_OUT, TS_SUCCESS, TSHttpTxnConfigIntSet(), and HttpSM::ua_session.

TSReturnCode TSHttpTxnServerPacketTosSet	(	TSHttpTxn	txnp,
		int	tos
	)

Change packet TOS for the server side connection.

Note:: The change takes effect immediately, if no OS connection has been made, then this sets the mark that will be used IF an OS connection is established; TOS is deprecated and replaced by DSCP, this is still used to set DSCP however the first 2 bits of this value will be ignored as they now belong to the ECN field.

Returns:: TS_SUCCESS if the (future?) server connection was modified

Definition at line 5383 of file InkAPI.cc.

References NetVConnection::apply_options(), HttpServerSession::get_netvc(), HttpClientSession::get_server_session(), NetVConnection::options, NetVCOptions::packet_tos, sdk_assert, sdk_sanity_check_txn(), TS_CONFIG_NET_SOCK_PACKET_TOS_OUT, TS_SUCCESS, TSHttpTxnConfigIntSet(), and HttpSM::ua_session.

int64_t TSHttpTxnServerReqBodyBytesGet ( TSHttpTxn txnp )

Definition at line 5777 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), HttpSM::server_request_body_bytes, and TS_SUCCESS.

TSReturnCode TSHttpTxnServerReqGet	(	TSHttpTxn	txnp,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 4602 of file InkAPI.cc.

References HttpTransact::State::hdr_info, HTTPHdr::m_http, sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, and HTTPHdr::valid().

Referenced by checkHttpTxnServerReqGet().

int TSHttpTxnServerReqHdrBytesGet ( TSHttpTxn txnp )

Definition at line 5768 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), HttpSM::server_request_hdr_bytes, and TS_SUCCESS.

void TSHttpTxnServerRequestBodySet	(	TSHttpTxn	txnp,
		char *	buf,
		int64_t	buflength
	)

Definition at line 5426 of file InkAPI.cc.

References HttpTransact::State::api_server_request_body_set, HttpTransact::State::free_internal_msg_buffer(), HttpTransact::State::internal_msg_buffer, HttpTransact::State::internal_msg_buffer_fast_allocator_size, HttpTransact::State::internal_msg_buffer_size, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

int64_t TSHttpTxnServerRespBodyBytesGet ( TSHttpTxn txnp )

Definition at line 5795 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), HttpSM::server_response_body_bytes, and TS_SUCCESS.

TSReturnCode TSHttpTxnServerRespGet	(	TSHttpTxn	txnp,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 4622 of file InkAPI.cc.

References HttpTransact::State::hdr_info, HTTPHdr::m_http, sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, and HTTPHdr::valid().

Referenced by checkHttpTxnServerRespGet(), and transformable().

int TSHttpTxnServerRespHdrBytesGet ( TSHttpTxn txnp )

Definition at line 5786 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), HttpSM::server_response_hdr_bytes, and TS_SUCCESS.

TSReturnCode TSHttpTxnServerRespIgnore ( TSHttpTxn txnp )

Definition at line 5039 of file InkAPI.cc.

References HttpTransact::State::api_server_response_ignore, HttpTransact::State::cache_info, HTTPInfo::response_get(), sdk_assert, sdk_sanity_check_txn(), TS_ERROR, TS_SUCCESS, HTTPHdr::valid(), and HTTPInfo::valid().

TSReturnCode TSHttpTxnServerRespNoStoreSet	(	TSHttpTxn	txnp,
		int	flag
	)

Set flag indicating whether or not to cache the server response for given TSHttpTxn.

Note:: This should be done in the HTTP_READ_RESPONSE_HDR_HOOK or earlier.; If TSHttpTxnRespCacheableSet() is not working the way you expect, this may be the function you should use instead.

Parameters:

	txnp	The transaction whose server response you do not want to store.
	flag	Set 0 to allow storing and 1 to disable storing.

Returns:: TS_SUCCESS.

Definition at line 5028 of file InkAPI.cc.

References HttpTransact::State::api_server_response_no_store, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

TSServerState TSHttpTxnServerStateGet ( TSHttpTxn txnp )

Definition at line 5713 of file InkAPI.cc.

References HttpTransact::State::current, sdk_assert, sdk_sanity_check_txn(), and TS_SUCCESS.

void TSHttpTxnSetHttpRetStatus	(	TSHttpTxn	txnp,
		TSHttpStatus	http_retstatus
	)

Definition at line 5637 of file InkAPI.cc.

References HttpTransact::State::http_return_code, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

TSReturnCode TSHttpTxnShutDown	(	TSHttpTxn	txnp,
		TSEvent	event
	)

Definition at line 5060 of file InkAPI.cc.

References HttpTransact::State::api_http_sm_shutdown, sdk_assert, sdk_sanity_check_txn(), TS_EVENT_HTTP_TXN_CLOSE, and TS_SUCCESS.

TSHttpSsn TSHttpTxnSsnGet ( TSHttpTxn txnp )

Definition at line 4509 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), TS_SUCCESS, and HttpSM::ua_session.

Referenced by ssn_handler(), TSHttpIsInternalRequest(), TSHttpTxnClientAddrGet(), TSHttpTxnClientFdGet(), and TSHttpTxnIncomingAddrGet().

void TSHttpTxnTransformedRespCache	(	TSHttpTxn	txnp,
		int	on
	)

Definition at line 5484 of file InkAPI.cc.

References HttpTransact::State::api_info, _HttpApiInfo::cache_transformed, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

Referenced by transform_hook_handler().

TSReturnCode TSHttpTxnTransformRespGet	(	TSHttpTxn	txnp,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 5156 of file InkAPI.cc.

References HttpTransact::State::hdr_info, HTTPHdr::m_http, sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_txn(), HttpSM::t_state, TS_SUCCESS, and HTTPHdr::valid().

Referenced by transform_hook_handler().

void TSHttpTxnUntransformedRespCache	(	TSHttpTxn	txnp,
		int	on
	)

Definition at line 5475 of file InkAPI.cc.

References HttpTransact::State::api_info, _HttpApiInfo::cache_untransformed, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

Referenced by transform_hook_handler().

TSReturnCode TSHttpTxnUpdateCachedObject ( TSHttpTxn txnp )

Definition at line 5133 of file InkAPI.cc.

References HttpTransact::State::api_update_cached_object, HttpTransact::State::cache_info, HttpTransact::CACHE_WL_READ_RETRY, HttpTransact::State::hdr_info, HTTPInfo::request_get(), HTTPInfo::response_get(), sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, TS_ERROR, TS_SUCCESS, HTTPHdr::valid(), and HTTPInfo::valid().

TSReturnCode TSICPCachedReqGet	(	TSCont	contp,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 7026 of file InkAPI.cc.

References ICPPeerReadCont::_cache_req_hdr_heap_handle, ICPPeerReadCont::_object_read, ats_malloc(), HdrHeapSDKHandle::m_heap, HTTPHdr::m_http, HTTPInfo::request_get(), sdk_assert, sdk_sanity_check_continuation(), sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), TS_ERROR, TS_SUCCESS, HTTPHdr::valid(), and HTTPInfo::valid().

TSReturnCode TSICPCachedRespGet	(	TSCont	contp,
		TSMBuffer *	bufp,
		TSMLoc *	obj
	)

Definition at line 7059 of file InkAPI.cc.

References ICPPeerReadCont::_cache_resp_hdr_heap_handle, ICPPeerReadCont::_object_read, ats_malloc(), HdrHeapSDKHandle::m_heap, HTTPHdr::m_http, HTTPInfo::response_get(), sdk_assert, sdk_sanity_check_continuation(), sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), TS_ERROR, TS_SUCCESS, HTTPHdr::valid(), and HTTPInfo::valid().

void TSICPFreshnessFuncSet ( TSPluginFreshnessCalcFunc funcp )

Definition at line 7020 of file InkAPI.cc.

References pluginFreshnessCalcFunc.

const char* TSInstallDirGet ( void )

Gets the path of the directory in which Traffic Server is installed.

Use this function to specify the location of files that the plugin uses.

Returns:: pointer to Traffic Server install directory.

Definition at line 1715 of file InkAPI.cc.

References Layout::get(), and Layout::prefix.

Referenced by SDK_API_TSfopen(), and SDK_API_TSPluginDirGet().

int TSIsDebugTagSet ( const char * t )

Definition at line 6749 of file InkAPI.cc.

References diags, DiagsTagType_Debug, and Diags::on().

void TSLifecycleHookAdd	(	TSLifecycleHookID	id,
		TSCont	contp
	)

Definition at line 4388 of file InkAPI.cc.

References FeatureAPIHooks< ID, N >::append(), sdk_assert, sdk_sanity_check_continuation(), sdk_sanity_check_lifecycle_hook_id(), and TS_SUCCESS.

char* TSMatcherExtractIPRange	(	char *	match_str,
		sockaddr *	addr1,
		sockaddr *	addr2
	)

Definition at line 6954 of file InkAPI.cc.

References ExtractIpRange(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

char* TSMatcherExtractIPRange	(	char *	match_str,
		uint32_t *	addr1,
		uint32_t *	addr2
	)

Definition at line 6947 of file InkAPI.cc.

References ExtractIpRange(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

TSMatcherLine TSMatcherLineCreate ( void )

Definition at line 6961 of file InkAPI.cc.

References ats_malloc().

void TSMatcherLineDestroy ( TSMatcherLine ml )

Definition at line 6967 of file InkAPI.cc.

References ats_free(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

char* TSMatcherLineName	(	TSMatcherLine	ml,
		int	element
	)

Definition at line 6981 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

char* TSMatcherLineValue	(	TSMatcherLine	ml,
		int	element
	)

Definition at line 6988 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

const char* TSMatcherParseSrcIPConfigLine	(	char *	line,
		TSMatcherLine	ml
	)

Definition at line 6974 of file InkAPI.cc.

References ip_allow_tags, parseConfigLine(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

char* TSMatcherReadIntoBuffer	(	char *	file_name,
		int *	file_len
	)

Definition at line 6933 of file InkAPI.cc.

References readIntoBuffer(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

char* TSMatcherTokLine	(	char *	buffer,
		char **	last
	)

Definition at line 6940 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_null_ptr(), tokLine(), and TS_SUCCESS.

TSMBuffer TSMBufferCreate ( void )

Creates a new marshal buffer and initializes the reference count to 1.

Definition at line 1893 of file InkAPI.cc.

References HdrHeapSDKHandle::m_heap, new_HdrHeap(), sdk_assert, sdk_sanity_check_mbuffer(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr(), SDK_API_TSHttpHdrParse(), SDK_API_TSMimeHdrField(), SDK_API_TSMimeHdrParse(), SDK_API_TSUrl(), and SDK_API_TSUrlParse().

TSReturnCode TSMBufferDestroy ( TSMBuffer bufp )

Ignores the reference count and destroys the marshal buffer bufp.

The internal data buffer associated with the marshal buffer is also destroyed if the marshal buffer allocated it.

Parameters:

bufp

marshal buffer to be destroyed.

Definition at line 1906 of file InkAPI.cc.

References HdrHeap::destroy(), isWriteable(), HdrHeapSDKHandle::m_heap, sdk_assert, sdk_sanity_check_mbuffer(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr(), SDK_API_TSHttpHdrParse(), SDK_API_TSMimeHdrField(), SDK_API_TSMimeHdrParse(), SDK_API_TSUrl(), and SDK_API_TSUrlParse().

TSReturnCode TSMgmtConfigIntSet	(	const char *	var_name,
		TSMgmtInt	value
	)

Definition at line 6996 of file InkAPI.cc.

References RecSignalManager(), TS_SUCCESS, and TSMgmtIntGet().

TSReturnCode TSMgmtCounterGet	(	const char *	var_name,
		TSMgmtCounter *	result
	)

Definition at line 4168 of file InkAPI.cc.

References REC_ERR_OKAY, RecGetRecordCounter(), and TS_SUCCESS.

Referenced by SDK_API_TSMgmtGet().

TSReturnCode TSMgmtFloatGet	(	const char *	var_name,
		TSMgmtFloat *	result
	)

Definition at line 4174 of file InkAPI.cc.

References REC_ERR_OKAY, RecGetRecordFloat(), and TS_SUCCESS.

Referenced by SDK_API_TSMgmtGet().

TSReturnCode TSMgmtIntCreate	(	TSRecordType	rec_type,
		const char *	name,
		TSMgmtInt	data_default,
		TSRecordUpdateType	update_type,
		TSRecordCheckType	check_type,
		const char *	check_regex,
		TSRecordAccessType	access_type
	)

Definition at line 8493 of file InkAPI.cc.

References REC_ERR_OKAY, RecRegisterConfigInt(), and TS_RECORDCHECK_NULL.

TSReturnCode TSMgmtIntGet	(	const char *	var_name,
		TSMgmtInt *	result
	)

Definition at line 4162 of file InkAPI.cc.

References REC_ERR_OKAY, RecGetRecordInt(), and TS_SUCCESS.

Referenced by SDK_API_TSMgmtGet(), and TSMgmtConfigIntSet().

TSReturnCode TSMgmtStringCreate	(	TSRecordType	rec_type,
		const char *	name,
		const TSMgmtString	data_default,
		TSRecordUpdateType	update_type,
		TSRecordCheckType	check_type,
		const char *	check_regex,
		TSRecordAccessType	access_type
	)

Definition at line 8479 of file InkAPI.cc.

References REC_ERR_OKAY, RecRegisterConfigString(), and TS_RECORDCHECK_NULL.

TSReturnCode TSMgmtStringGet	(	const char *	var_name,
		TSMgmtString *	result
	)

Definition at line 4180 of file InkAPI.cc.

References RecGetRecordString_Xmalloc().

Referenced by SDK_API_TSMgmtGet().

void TSMgmtUpdateRegister	(	TSCont	contp,
		const char *	plugin_name
	)

Definition at line 4153 of file InkAPI.cc.

References ConfigUpdateCbTable::insert(), sdk_assert, sdk_sanity_check_iocore_structure(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

const char* TSMimeFieldValueGet	(	TSMBuffer	,
		TSMLoc	field_obj,
		int	idx,
		int *	value_len_ptr
	)

Definition at line 2577 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, mime_field_value_get(), and mime_field_value_get_comma_val().

Referenced by TSMimeHdrFieldValueDateGet(), TSMimeHdrFieldValueInt64Get(), TSMimeHdrFieldValueIntGet(), TSMimeHdrFieldValueStringGet(), and TSMimeHdrFieldValueUintGet().

void TSMimeFieldValueInsert	(	TSMBuffer	bufp,
		TSMLoc	field_obj,
		const char *	value,
		int	length,
		int	idx
	)

Definition at line 2607 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, MIMEFieldSDKHandle::mh, and mime_field_value_insert_comma_val().

Referenced by TSMimeHdrFieldValueIntInsert(), TSMimeHdrFieldValueStringInsert(), and TSMimeHdrFieldValueUintInsert().

void TSMimeFieldValueSet	(	TSMBuffer	bufp,
		TSMLoc	field_obj,
		int	idx,
		const char *	value,
		int	length
	)

Definition at line 2592 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, MIMEFieldSDKHandle::mh, mime_field_value_set(), and mime_field_value_set_comma_val().

Referenced by TSMimeHdrFieldValueDateInsert(), TSMimeHdrFieldValueDateSet(), TSMimeHdrFieldValueInt64Set(), TSMimeHdrFieldValueIntSet(), TSMimeHdrFieldValueStringSet(), and TSMimeHdrFieldValueUintSet().

TSReturnCode TSMimeHdrClone	(	TSMBuffer	dest_bufp,
		TSMBuffer	src_bufp,
		TSMLoc	src_hdr,
		TSMLoc *	locp
	)

Copies a specified MIME header to a specified marshal buffer, and returns the location of the copied MIME header within the destination marshal buffer.

Unlike TSMimeHdrCopy(), you do not have to create the destination MIME header before cloning. Release the returned TSMLoc handle with a call to TSHandleMLocRelease().

Parameters:

	dest_bufp	destination marshal buffer.
	src_bufp	source marshal buffer.
	src_hdr	location of the source MIME header.
	locp	where to store the location of the copied MIME header.

Definition at line 2428 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), isWriteable(), mime_hdr_clone(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

TSReturnCode TSMimeHdrCopy	(	TSMBuffer	dest_bufp,
		TSMLoc	dest_offset,
		TSMBuffer	src_bufp,
		TSMLoc	src_offset
	)

Copies the contents of the MIME header located at src_loc within src_bufp to the MIME header located at dest_loc within dest_bufp.

TSMimeHdrCopy() works correctly even if src_bufp and dest_bufp point to different marshal buffers. Important: you must create the destination MIME header before copying into it--use TSMimeHdrCreate().

Parameters:

	dest_bufp	is the destination marshal buffer.
	dest_offset
	src_bufp	is the source marshal buffer.
	src_offset

Definition at line 2456 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), isWriteable(), mime_hdr_copy_onto(), mime_hdr_fields_clear(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrParse().

TSReturnCode TSMimeHdrCreate	(	TSMBuffer	bufp,
		TSMLoc *	locp
	)

Creates a new MIME header within bufp.

Release with a call to TSHandleMLocRelease().

Parameters:

	bufp	marshal buffer to contain the new MIME header.
	locp	buffer pointer to contain the MLoc

Definition at line 2392 of file InkAPI.cc.

References isWriteable(), mime_hdr_create(), sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField(), and SDK_API_TSMimeHdrParse().

TSReturnCode TSMimeHdrDestroy	(	TSMBuffer	bufp,
		TSMLoc	offset
	)

Destroys the MIME header located at hdr_loc within bufp.

Parameters:

	bufp	marshal buffer containing the MIME header to destroy.
	offset	location of the MIME header.

Definition at line 2408 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), isWriteable(), mime_hdr_destroy(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdrParse(), SDK_API_TSMimeHdrField(), and SDK_API_TSMimeHdrParse().

TSReturnCode TSMimeHdrFieldAppend	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field
	)

Returns the TSMLoc location of a specified MIME field from within the MIME header located at hdr.

The retrieved_str parameter specifies which field to retrieve. For each MIME field in the MIME header, a pointer comparison is done between the field name and retrieved_str. This is a much quicker retrieval function than TSMimeHdrFieldFind() since it obviates the need for a string comparison. However, retrieved_str must be one of the predefined field names of the form TS_MIME_FIELD_XXX for the call to succeed. Release the returned TSMLoc handle with a call to TSHandleMLocRelease().

Parameters:

	bufp	marshal buffer containing the MIME field.
	hdr	location of the MIME header containing the field.
	retrieved_str	specifies the field to retrieve. Must be one of the predefined field names of the form TS_MIME_FIELD_XXX.

Returns:: location of the requested MIME field. If the requested field cannot be found, returns 0.

Definition at line 2685 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), MIMEFieldSDKHandle::field_ptr, ink_assert, isWriteable(), MIMEField::m_ptr_name, memcpy, MIMEFieldSDKHandle::mh, mime_field_create(), mime_hdr_field_attach(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField(), and SDK_API_TSMimeHdrParse().

TSReturnCode TSMimeHdrFieldClone	(	TSMBuffer	dest_bufp,
		TSMLoc	dest_hdr,
		TSMBuffer	src_bufp,
		TSMLoc	src_hdr,
		TSMLoc	src_field,
		TSMLoc *	locp
	)

Definition at line 2888 of file InkAPI.cc.

References isWriteable(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), TS_SUCCESS, TSMimeHdrFieldCopy(), and TSMimeHdrFieldCreate().

Referenced by SDK_API_TSMimeHdrParse().

TSReturnCode TSMimeHdrFieldCopy	(	TSMBuffer	dest_bufp,
		TSMLoc	dest_hdr,
		TSMLoc	dest_field,
		TSMBuffer	src_bufp,
		TSMLoc	src_hdr,
		TSMLoc	src_field
	)

TSReturnCode TSMimeHdrFieldCopyValues	(	TSMBuffer	dest_bufp,
		TSMLoc	dest_hdr,
		TSMLoc	dest_field,
		TSMBuffer	src_bufp,
		TSMLoc	src_hdr,
		TSMLoc	src_field
	)

Definition at line 2915 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, isWriteable(), MIMEField::m_len_value, MIMEField::m_ptr_value, MIMEFieldSDKHandle::mh, mime_field_value_set(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrParse().

TSReturnCode TSMimeHdrFieldCreate	(	TSMBuffer	bufp,
		TSMLoc	mh_mloc,
		TSMLoc *	locp
	)

Definition at line 2796 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), MIMEFieldSDKHandle::field_ptr, isWriteable(), mime_field_create(), sdk_alloc_field_handle(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField(), SDK_API_TSMimeHdrParse(), and TSMimeHdrFieldClone().

TSReturnCode TSMimeHdrFieldCreateNamed	(	TSMBuffer	bufp,
		TSMLoc	mh_mloc,
		const char *	name,
		int	name_len,
		TSMLoc *	locp
	)

Definition at line 2819 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), MIMEFieldSDKHandle::field_ptr, isWriteable(), mime_field_create_named(), sdk_alloc_field_handle(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

TSReturnCode TSMimeHdrFieldDestroy	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field
	)

Destroys the MIME field located at field within bufp.

You must release the TSMLoc field with a call to TSHandleMLocRelease().

Parameters:

	bufp	contains the MIME field to be destroyed.
	hdr	location of the parent header containing the field to be destroyed. This could be the location of a MIME header or HTTP header.
	field	location of the field to be destroyed.

Definition at line 2761 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), MIMEFieldSDKHandle::field_ptr, ink_assert, ink_release_assert, isWriteable(), MIMEFieldSDKHandle::mh, mime_hdr_field_delete(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField().

int TSMimeHdrFieldEqual	(	TSMBuffer	bufp,
		TSMLoc	hdr_obj,
		TSMLoc	field1_obj,
		TSMLoc	field2_obj
	)

Definition at line 2627 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_mbuffer(), and TS_SUCCESS.

TSMLoc TSMimeHdrFieldFind	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		const char *	name,
		int	length
	)

Retrieves the TSMLoc location of a specified MIME field from within the MIME header located at hdr.

The name and length parameters specify which field to retrieve. For each MIME field in the MIME header, a case insensitive string comparison is done between the field name and name. If TSMimeHdrFieldFind() cannot find the requested field, it returns TS_NULL_MLOC. Release the returned TSMLoc handle with a call to TSHandleMLocRelease().

Parameters:

	bufp	marshal buffer containing the MIME header field to find.
	hdr	location of the MIME header containing the field.
	name	of the field to retrieve.
	length	string length of the string name. If length is -1, then name is assumed to be null-terminated.

Returns:: location of the requested MIME field. If the field could not be found, returns TS_NULL_MLOC.

Definition at line 2662 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), MIMEFieldSDKHandle::field_ptr, mime_hdr_field_find(), sdk_alloc_field_handle(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), TS_NULL_MLOC, and TS_SUCCESS.

Referenced by get_request_id(), SDK_API_TSMimeHdrField(), SDK_API_TSMimeHdrParse(), and transform_hook_handler().

TSMLoc TSMimeHdrFieldGet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		int	idx
	)

Retrieves the location of a specified MIME field within the MIME header located at hdr_loc within bufp.

The idx parameter specifies which field to retrieve. The fields are numbered from 0 to TSMimeHdrFieldsCount(bufp, hdr_loc) - 1. If idx does not lie within that range then TSMimeHdrFieldGet returns 0. Release the returned handle with a call to TSHandleMLocRelease.

Parameters:

	bufp	marshal buffer containing the MIME header.
	hdr	location of the MIME header.
	idx	index of the field to get with base at 0.

Returns:: location of the specified MIME field.

Definition at line 2642 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), MIMEFieldSDKHandle::field_ptr, mime_hdr_field_get(), sdk_alloc_field_handle(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_NULL_MLOC, and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField(), SDK_API_TSMimeHdrParse(), and SpdyNV::SpdyNV().

int TSMimeHdrFieldLengthGet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field
	)

Definition at line 3002 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, mime_field_length_get(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField().

const char* TSMimeHdrFieldNameGet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int *	length
	)

Definition at line 3014 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, mime_field_name_get(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

Referenced by compare_field_names(), SDK_API_TSMimeHdrField(), SDK_API_TSMimeHdrParse(), and SpdyNV::SpdyNV().

TSReturnCode TSMimeHdrFieldNameSet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		const char *	name,
		int	length
	)

Definition at line 3027 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, MIMEField::is_live(), isWriteable(), MIMEFieldSDKHandle::mh, mime_hdr_field_attach(), mime_hdr_field_detach(), MIMEField::name_set(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField().

TSMLoc TSMimeHdrFieldNext	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field
	)

Definition at line 2950 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, MIMEField::is_live(), MIMEFieldSDKHandle::mh, mime_hdr_field_get_slotnum(), mime_hdr_field_slotnum(), sdk_alloc_field_handle(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_NULL_MLOC, and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField(), and SpdyNV::SpdyNV().

TSMLoc TSMimeHdrFieldNextDup	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field
	)

Definition at line 2983 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), MIMEFieldSDKHandle::field_ptr, MIMEField::m_next_dup, sdk_alloc_field_handle(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_NULL_MLOC, and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrParse().

TSReturnCode TSMimeHdrFieldRemove	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field
	)

Removes the MIME field located at field within bufp from the header located at hdr within bufp.

If the specified field cannot be found in the list of fields associated with the header then nothing is done.

Note: removing the field does not destroy the field, it only detaches the field, hiding it from the printed output. The field can be reattached with a call to TSMimeHdrFieldAppend(). If you do not use the detached field you should destroy it with a call to TSMimeHdrFieldDestroy() and release the handle field with a call to TSHandleMLocRelease().

Parameters:

	bufp	contains the MIME field to remove.
	hdr	location of the header containing the MIME field to be removed. This header could be an HTTP header or MIME header.
	field	is the location of the field to remove.

Definition at line 2735 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), MIMEFieldSDKHandle::field_ptr, ink_assert, isWriteable(), MIMEFieldSDKHandle::mh, mime_hdr_field_detach(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrParse().

TSReturnCode TSMimeHdrFieldsClear	(	TSMBuffer	bufp,
		TSMLoc	offset
	)

Removes and destroys all the MIME fields within the MIME header located at hdr_loc within the marshal buffer bufp.

Parameters:

	bufp	marshal buffer containing the MIME header.
	offset	location of the MIME header.

Definition at line 2548 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), isWriteable(), mime_hdr_fields_clear(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField().

int TSMimeHdrFieldsCount	(	TSMBuffer	bufp,
		TSMLoc	offset
	)

Returns a count of the number of MIME fields within the MIME header located at hdr_loc within the marshal buffer bufp.

Parameters:

	bufp	marshal buffer containing the MIME header.
	offset	location of the MIME header within bufp.

Returns:: number of MIME fields within the MIME header located at hdr_loc.

Definition at line 2564 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), mime_hdr_fields_count(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField(), and SpdyNV::SpdyNV().

TSReturnCode TSMimeHdrFieldValueAppend	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx,
		const char *	value,
		int	length
	)

Definition at line 3292 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, isWriteable(), MIMEFieldSDKHandle::mh, mime_field_value_extend_comma_val(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField().

time_t TSMimeHdrFieldValueDateGet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field
	)

Definition at line 3111 of file InkAPI.cc.

References mime_parse_date(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_SUCCESS, and TSMimeFieldValueGet().

Referenced by SDK_API_TSMimeHdrField().

TSReturnCode TSMimeHdrFieldValueDateInsert	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		time_t	value
	)

Definition at line 3381 of file InkAPI.cc.

References isWriteable(), mime_format_date(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_ERROR, TS_SUCCESS, TSMimeFieldValueSet(), and TSMimeHdrFieldValuesClear().

Referenced by SDK_API_TSMimeHdrField().

TSReturnCode TSMimeHdrFieldValueDateSet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		time_t	value
	)

Definition at line 3202 of file InkAPI.cc.

References isWriteable(), mime_format_date(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_SUCCESS, and TSMimeFieldValueSet().

Referenced by SDK_API_TSMimeHdrField().

TSReturnCode TSMimeHdrFieldValueDelete	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx
	)

Definition at line 3406 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, isWriteable(), MIMEFieldSDKHandle::mh, mime_field_value_delete_comma_val(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField().

int64_t TSMimeHdrFieldValueInt64Get	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx
	)

Definition at line 3145 of file InkAPI.cc.

References mime_parse_int64(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_SUCCESS, and TSMimeFieldValueGet().

TSReturnCode TSMimeHdrFieldValueInt64Set	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx,
		int64_t	value
	)

Definition at line 3248 of file InkAPI.cc.

References isWriteable(), mime_format_int64(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_SUCCESS, and TSMimeFieldValueSet().

int TSMimeHdrFieldValueIntGet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx
	)

Definition at line 3128 of file InkAPI.cc.

References mime_parse_int(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_SUCCESS, and TSMimeFieldValueGet().

Referenced by get_request_id(), SDK_API_TSMimeHdrField(), and transform_hook_handler().

TSReturnCode TSMimeHdrFieldValueIntInsert	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx,
		int	value
	)

Definition at line 3339 of file InkAPI.cc.

References isWriteable(), mime_format_int(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_SUCCESS, and TSMimeFieldValueInsert().

Referenced by SDK_API_TSMimeHdrField().

TSReturnCode TSMimeHdrFieldValueIntSet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx,
		int	value
	)

Definition at line 3226 of file InkAPI.cc.

References isWriteable(), mime_format_int(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_SUCCESS, and TSMimeFieldValueSet().

Referenced by SDK_API_TSMimeHdrField().

TSReturnCode TSMimeHdrFieldValuesClear	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field
	)

Modified the string value passed from an empty string ("") to NULL. An empty string is also considered to be a token. The correct value of the field after this function should be NULL.

Definition at line 3061 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, isWriteable(), MIMEFieldSDKHandle::mh, mime_field_value_set(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrField(), and TSMimeHdrFieldValueDateInsert().

int TSMimeHdrFieldValuesCount	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field
	)

Definition at line 3088 of file InkAPI.cc.

References MIMEFieldSDKHandle::field_ptr, mime_field_value_get_comma_val_count(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by compare_field_values(), and SDK_API_TSMimeHdrField().

const char* TSMimeHdrFieldValueStringGet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx,
		int *	value_len_ptr
	)

Definition at line 3100 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), TS_SUCCESS, and TSMimeFieldValueGet().

Referenced by compare_field_values(), SDK_API_TSMimeHdrField(), and SpdyNV::SpdyNV().

TSReturnCode TSMimeHdrFieldValueStringInsert	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx,
		const char *	value,
		int	length
	)

Definition at line 3318 of file InkAPI.cc.

References isWriteable(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), TS_SUCCESS, and TSMimeFieldValueInsert().

Referenced by SDK_API_TSMimeHdrField().

TSReturnCode TSMimeHdrFieldValueStringSet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx,
		const char *	value,
		int	length
	)

Definition at line 3179 of file InkAPI.cc.

References isWriteable(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), TS_SUCCESS, and TSMimeFieldValueSet().

Referenced by SDK_API_TSMimeHdrField().

unsigned int TSMimeHdrFieldValueUintGet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx
	)

Definition at line 3162 of file InkAPI.cc.

References mime_parse_uint(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_SUCCESS, and TSMimeFieldValueGet().

Referenced by SDK_API_TSMimeHdrField().

TSReturnCode TSMimeHdrFieldValueUintInsert	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx,
		unsigned int	value
	)

Definition at line 3360 of file InkAPI.cc.

References isWriteable(), mime_format_uint(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_SUCCESS, and TSMimeFieldValueInsert().

Referenced by SDK_API_TSMimeHdrField().

TSReturnCode TSMimeHdrFieldValueUintSet	(	TSMBuffer	bufp,
		TSMLoc	hdr,
		TSMLoc	field,
		int	idx,
		unsigned int	value
	)

Definition at line 3270 of file InkAPI.cc.

References isWriteable(), mime_format_uint(), sdk_assert, sdk_sanity_check_field_handle(), sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_SUCCESS, and TSMimeFieldValueSet().

Referenced by SDK_API_TSMimeHdrField().

int TSMimeHdrLengthGet	(	TSMBuffer	bufp,
		TSMLoc	offset
	)

Calculates the length of the MIME header located at hdr_loc if it were returned as a string.

This the length of the MIME header in its unparsed form.

Parameters:

	bufp	marshal buffer containing the MIME header.
	offset	location of the MIME header.

Returns:: string length of the MIME header located at hdr_loc.

Definition at line 2537 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), mime_hdr_length_get(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrParse(), and SpdyNV::SpdyNV().

TSParseResult TSMimeHdrParse	(	TSMimeParser	parser,
		TSMBuffer	bufp,
		TSMLoc	offset,
		const char **	start,
		const char *	end
	)

Parses a MIME header.

The MIME header must have already been allocated and both bufp and hdr_loc must point within that header. It is possible to parse a MIME header a single byte at a time using repeated calls to TSMimeHdrParse(). As long as an error does not occur, TSMimeHdrParse() consumes each single byte and asks for more.

Parameters:

	parser	parses the specified MIME header.
	bufp	marshal buffer containing the MIME header to be parsed.
	offset
	start	both an input and output. On input, the start argument points to the current position of the buffer being parsed. On return, start is modified to point past the last character parsed.
	end	points to one byte after the end of the buffer.

Returns:

One of 3 possible int values:

TS_PARSE_ERROR if there is a parsing error.
TS_PARSE_DONE is returned when a "\r\n\r\n" pattern is encountered, indicating the end of the header.
TS_PARSE_CONT is returned if parsing of the header stopped because the end of the buffer was reached.

Definition at line 2518 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), isWriteable(), mime_parser_parse(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), sdk_sanity_check_null_ptr(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrParse().

void TSMimeHdrPrint	(	TSMBuffer	bufp,
		TSMLoc	offset,
		TSIOBuffer	iobufp
	)

Formats the MIME header located at hdr_loc within bufp into the TSIOBuffer iobufp.

Parameters:

	bufp	marshal buffer containing the header to be copied to an TSIOBuffer.
	offset
	iobufp	target TSIOBuffer.

Definition at line 2486 of file InkAPI.cc.

References _hdr_mloc_to_mime_hdr_impl(), MIOBuffer::add_block(), IOBufferBlock::end(), MIOBuffer::fill(), MIOBuffer::get_current_block(), mime_hdr_print(), sdk_assert, sdk_sanity_check_http_hdr_handle(), sdk_sanity_check_iocore_structure(), sdk_sanity_check_mbuffer(), sdk_sanity_check_mime_hdr_handle(), TS_SUCCESS, and IOBufferBlock::write_avail().

Referenced by convert_mime_hdr_to_string().

void TSMimeParserClear ( TSMimeParser parser )

Clears the specified MIME parser so that it can be used again.

Parameters:

parser

to be cleared.

Definition at line 2368 of file InkAPI.cc.

References mime_parser_clear(), sdk_assert, sdk_sanity_check_mime_parser(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrParse().

TSMimeParser TSMimeParserCreate ( void )

Creates a MIME parser.

The parser's data structure contains information about the header being parsed. A single MIME parser can be used multiple times, though not simultaneously. Before being used again, the parser must be cleared by calling TSMimeParserClear().

Definition at line 2359 of file InkAPI.cc.

References ats_malloc(), and mime_parser_init().

Referenced by SDK_API_TSMimeHdrParse().

void TSMimeParserDestroy ( TSMimeParser parser )

Destroys the specified MIME parser and frees the associated memory.

Parameters:

parser

to destroy.

Definition at line 2376 of file InkAPI.cc.

References ats_free(), mime_parser_clear(), sdk_assert, sdk_sanity_check_mime_parser(), and TS_SUCCESS.

Referenced by SDK_API_TSMimeHdrParse().

TSAction TSNetAccept	(	TSCont	contp,
		int	port,
		int	domain,
		int	accept_threads
	)

Definition at line 6480 of file InkAPI.cc.

References NetProcessor::accept(), NetProcessor::AcceptOptions::accept_threads, FORCE_PLUGIN_MUTEX, NetProcessor::AcceptOptions::frequent_accept, NetProcessor::AcceptOptions::ip_family, NetProcessor::AcceptOptions::local_port, netProcessor, sdk_assert, sdk_sanity_check_continuation(), and TS_SUCCESS.

Referenced by SDK_API_TSNetVConn(), and synserver_start().

TSReturnCode TSNetAcceptNamedProtocol	(	TSCont	contp,
		const char *	protocol
	)

Listen on all SSL ports for connections for the specified protocol name.

TSNetAcceptNamedProtocol registers the specified protocol for all statically configured TLS ports. When a client using the TLS Next Protocol Negotiation extension negotiates the requested protocol, TrafficServer will route the request to the given handler. Note that the protocol is not registered on ports opened by other plugins.

The event and data provided to the handler are the same as for TSNetAccept(). If a connection is successfully accepted, the event code will be TS_EVENT_NET_ACCEPT and the event data will be a valid TSVConn bound to the accepted connection.

Neither contp nor protocol are copied. They must remain valid for the lifetime of the plugin.

TSNetAcceptNamedProtocol fails if the requested protocol cannot be registered on all of the configured TLS ports. If it fails, the protocol will not be registered on any ports (ie.. no partial failure).

Definition at line 6522 of file InkAPI.cc.

TSAction TSNetConnect	(	TSCont	contp,
		sockaddr const *	addr
	)

Definition at line 6448 of file InkAPI.cc.

References ats_is_ip(), NetProcessor::connect_re(), FORCE_PLUGIN_MUTEX, netProcessor, sdk_assert, sdk_sanity_check_continuation(), and TS_SUCCESS.

TSAction TSNetConnectTransparent	(	TSCont	contp,
		sockaddr const *	client_addr,
		sockaddr const *	server_addr
	)

Definition at line 6461 of file InkAPI.cc.

References NetVCOptions::addr_binding, IpAddr::assign(), ats_ip_are_compatible(), ats_ip_port_host_order(), ats_is_ip(), NetProcessor::connect_re(), FORCE_PLUGIN_MUTEX, NetVCOptions::local_ip, NetVCOptions::local_port, netProcessor, sdk_assert, sdk_sanity_check_continuation(), and TS_SUCCESS.

sockaddr const* TSNetVConnLocalAddrGet ( TSVConn connp ) [read]

Definition at line 6433 of file InkAPI.cc.

References NetVConnection::get_local_addr(), sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

sockaddr const* TSNetVConnRemoteAddrGet ( TSVConn connp ) [read]

Definition at line 6441 of file InkAPI.cc.

References NetVConnection::get_remote_addr(), sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

Referenced by client_handler(), and spdy_fetcher_launch().

TSReturnCode TSPluginDescriptorAccept ( TSCont contp )

Attempt to attach the contp continuation to sockets that have already been opened by the traffic manager and defined as belonging to plugins (based on records.config configuration).

If a connection is successfully accepted, the TS_EVENT_NET_ACCEPT is delivered to the continuation. The event data will be a valid TSVConn bound to the accepted connection. In order to configure such a socket, add the "plugin" keyword to a port in proxy.config.http.server_ports like "8082:plugin" Transparency/IP settings can also be defined, but a port cannot have both the "ssl" or "plugin" keywords configured.

Need to update records.config comments on proxy.config.http.server_ports when this option is promoted from experimental.

Definition at line 8557 of file InkAPI.cc.

References HttpProxyPort::global(), HttpProxyPort::isPlugin(), Vec< C, A, S >::length(), HttpProxyPort::m_fd, NetProcessor::main_accept(), make_net_accept_options(), netProcessor, and TS_SUCCESS.

const char* TSPluginDirGet ( void )

Gets the path of the plugin directory relative to the Traffic Server install directory.

For example, to open the file "config_ui.txt" in the plugin directory:

      TSfopen("TSPluginInstallDirGet()/TSPluginDirGet()/config_ui.txt");

Returns:: pointer to plugin directory relative to Traffic Server install directory.

Definition at line 1737 of file InkAPI.cc.

References ats_free(), ink_strlcpy(), PATH_NAME_MAX, plugin_dir, and RecConfigReadPrefixPath().

Referenced by plugin_init(), remap_load_plugin(), and SDK_API_TSPluginDirGet().

TSReturnCode TSPluginRegister	(	TSSDKVersion	sdk_version,
		TSPluginRegistrationInfo *	plugin_info
	)

This function registers your plugin with a particular version of Traffic Server SDK.

Use this function to make sure that the Traffic Server version currently running also supports your plugin. See the SDK sample code for usage.

Parameters:

	sdk_version	earliest version of the Traffic Server SDK that supports your plugin.
	plugin_info	contains registration information about your plugin. See TSPluginRegistrationInfo.

Returns:: TS_ERROR if the plugin registration failed.

Definition at line 1757 of file InkAPI.cc.

References ats_strdup, PluginRegInfo::plugin_name, plugin_reg_current, PluginRegInfo::plugin_registered, PLUGIN_SDK_VERSION_3_0, PLUGIN_SDK_VERSION_4_0, sdk_assert, sdk_sanity_check_null_ptr(), PluginRegInfo::sdk_version, PluginRegInfo::support_email, TS_SUCCESS, and PluginRegInfo::vendor_name.

TSReturnCode TSPortDescriptorAccept	(	TSPortDescriptor	,
		TSCont
	)

Start listening on the given port descriptor.

If a connection is successfully accepted, the TS_EVENT_NET_ACCEPT is delivered to the continuation. The event data will be a valid TSVConn bound to the accepted connection.

Definition at line 8541 of file InkAPI.cc.

References HttpProxyPort::isSSL(), HttpProxyPort::m_fd, NetProcessor::main_accept(), make_net_accept_options(), netProcessor, sslNetProcessor, and TS_SUCCESS.

Referenced by SDK_API_TSPortDescriptor().

TSPortDescriptor TSPortDescriptorParse ( const char * descriptor )

Create a new port from the string specification used by the proxy.config.http.server_ports configuration value.

Definition at line 8528 of file InkAPI.cc.

References HttpProxyPort::processOptions().

Referenced by SDK_API_TSPortDescriptor().

unsigned int TSrandom ( void )

Definition at line 1691 of file InkAPI.cc.

References EThread::generator, InkRand::random(), and this_ethread().

void TSRecordDump	(	int	rec_type,
		TSRecordDumpCb	callback,
		void *	edata
	)

Definition at line 7489 of file InkAPI.cc.

References RecDumpRecords().

const char* TSRedirectUrlGet	(	TSHttpTxn	txnp,
		int *	url_len_ptr
	)

Definition at line 7207 of file InkAPI.cc.

References TSHttpTxnRedirectUrlGet().

void TSRedirectUrlSet	(	TSHttpTxn	txnp,
		const char *	url,
		const int	url_len
	)

Definition at line 7169 of file InkAPI.cc.

References ats_free(), ats_malloc(), HttpSM::enable_redirection, ink_strlcpy(), HttpConfig::m_master, HttpConfigParams::number_of_redirections, HttpSM::redirect_url, HttpSM::redirect_url_len, HttpSM::redirection_tries, sdk_assert, sdk_sanity_check_null_ptr(), sdk_sanity_check_txn(), and TS_SUCCESS.

void TSSkipRemappingSet	(	TSHttpTxn	txnp,
		int	flag
	)

Definition at line 7498 of file InkAPI.cc.

References HttpTransact::State::api_skip_all_remapping, sdk_assert, sdk_sanity_check_txn(), HttpSM::t_state, and TS_SUCCESS.

Referenced by altinfo_hook_handler(), cache_hook_handler(), mytest_handler(), ssn_handler(), and transform_hook_handler().

int TSStatCreate	(	const char *	the_name,
		TSRecordDataType	the_type,
		TSStatPersistence	persist,
		TSStatSync	sync
	)

Definition at line 6652 of file InkAPI.cc.

References api_rsb_index, RECP_NON_PERSISTENT, RECP_PERSISTENT, RecRegisterRawStat, RECT_PLUGIN, sdk_sanity_check_null_ptr(), TS_STAT_NON_PERSISTENT, TS_STAT_PERSISTENT, TS_STAT_SYNC_AVG, TS_STAT_SYNC_SUM, TS_STAT_SYNC_TIMEAVG, and TS_SUCCESS.

TSReturnCode TSStatFindName	(	const char *	name,
		int *	idp
	)

Definition at line 6722 of file InkAPI.cc.

References REC_ERR_OKAY, RecGetRecordOrderAndId(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

void TSStatIntDecrement	(	int	the_stat,
		TSMgmtInt	amount
	)

Definition at line 6701 of file InkAPI.cc.

References RecDecrRawStat().

TSMgmtInt TSStatIntGet ( int the_stat )

Definition at line 6707 of file InkAPI.cc.

References RecGetGlobalRawStatSum().

void TSStatIntIncrement	(	int	the_stat,
		TSMgmtInt	amount
	)

Definition at line 6695 of file InkAPI.cc.

References RecIncrRawStat().

void TSStatIntSet	(	int	the_stat,
		TSMgmtInt	value
	)

Definition at line 6716 of file InkAPI.cc.

References RecSetGlobalRawStatSum().

TSReturnCode TSStringPercentDecode	(	const char *	str,
		size_t	str_len,
		char *	dst,
		size_t	dst_size,
		size_t *	length
	)

Perform percent-decoding of the string in the buffer, writing to the output buffer.

The source and destination can be the same, in which case they overwrite. The decoded string is always guaranteed to be no longer than the source string.

Parameters:

	str	the string to decode (and possibly write to).
	str_len	length of the input string (or 0).
	dst	output buffer (can be the same as src).
	dst_len	size of the output buffer.
	length	amount of data written to the destination buffer.

Definition at line 2306 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_null_ptr(), TS_SUCCESS, and unescape_str().

Referenced by SDK_API_ENCODING().

TSReturnCode TSStringPercentEncode	(	const char *	str,
		int	str_len,
		char *	dst,
		size_t	dst_size,
		size_t *	length,
		const unsigned char *	map
	)

Perform percent-encoding of the string in the buffer, storing the new string in the destination buffer.

The length parameter will be set to the new (encoded) string length, or 0 if the encoding failed.

Parameters:

	str	the string buffer to encode.
	str_len	length of the string buffer.
	dst	destination buffer.
	dst_size	size of the destination buffer.
	length	amount of data written to the destination buffer.
	map	optional (can be NULL) map of characters to encode.

Definition at line 2280 of file InkAPI.cc.

References LogUtils::escapify_url(), sdk_assert, sdk_sanity_check_null_ptr(), and TS_SUCCESS.

Referenced by SDK_API_ENCODING(), and TSUrlPercentEncode().

TSReturnCode TSTextLogObjectCreate	(	const char *	filename,
		int	mode,
		TSTextLogObject *	new_log_obj
	)

Creates a new custom log file that your plugin can write to.

You can design the fields and inputs to the log file using the TSTextLogObjectWrite() function. The logs you create are treated like ordinary logs; they are rolled if log rolling is enabled. (Log collation is not supported though).

Parameters:

filename

new log file being created. The new log file is created in the logs directory. You can specify a path to a subdirectory within the log directory, e.g. subdir/filename, but make sure you create the subdirectory first. If you do not specify a file name extension, the extension ".log" is automatically added.

mode

is one (or both) of the following:

TS_LOG_MODE_ADD_TIMESTAMP Whenever the plugin makes a log entry using TSTextLogObjectWrite (see below), it prepends the entry with a timestamp.
TS_LOG_MODE_DO_NOT_RENAME This means that if there is a filename conflict, Traffic Server should not attempt to rename the custom log. The consequence of a name conflict is that the custom log will simply not be created, e.g. suppose you call:
```
            log = TSTextLogObjectCreate("squid" , mode, NULL, &error);
```
If mode is TS_LOG_MODE_DO_NOT_RENAME, you will NOT get a new log (you'll get a null pointer) if squid.log already exists. If mode is not TS_LOG_MODE_DO_NOT_RENAME, Traffic Server tries to rename the log to a new name (it will try squid_1.log).

new_log_obj

new custom log file.

Returns:

error code:

TS_LOG_ERROR_NO_ERROR No error; the log object has been created successfully.
TS_LOG_ERROR_OBJECT_CREATION Log object not created. This error is rare and would most likely be caused by the system running out of memory.
TS_LOG_ERROR_FILENAME_CONFLICTS You get this error if mode = TS_LOG_MODE_DO_NOT_RENAME, and if there is a naming conflict. The log object is not created.
TS_LOG_ERROR_FILE_ACCESS Log object not created because of a file access problem (for example, no write permission to the logging directory, or a specified subdirectory for the log file does not exist).

Definition at line 6783 of file InkAPI.cc.

References Log::config, LogConfig::log_object_manager, LogObjectManager::manage_api_object(), LogObjectManager::NO_FILENAME_CONFLICTS, sdk_assert, sdk_sanity_check_null_ptr(), TS_LOG_MODE_ADD_TIMESTAMP, TS_LOG_MODE_DO_NOT_RENAME, TS_LOG_MODE_INVALID_FLAG, and TS_SUCCESS.

Referenced by SDK_API_TSTextLog().

TSReturnCode TSTextLogObjectDestroy ( TSTextLogObject the_object )

Destroys a log object and releases the memory allocated to it.

Use this call if you are done with the log.

Parameters:

the_object

custom log to be destroyed.

Definition at line 6857 of file InkAPI.cc.

References Log::config, sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

Referenced by log_test_handler().

void TSTextLogObjectFlush ( TSTextLogObject the_object )

This immediately flushes the contents of the log write buffer for the_object to disk.

Use this call only if you want to make sure that log entries are flushed immediately. This call has a performance cost. Traffic Server flushes the log buffer automatically about every 1 second.

Parameters:

the_object

custom log file whose write buffer is to be flushed.

Definition at line 6849 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

Referenced by SDK_API_TSTextLog().

void TSTextLogObjectHeaderSet	(	TSTextLogObject	the_object,
		const char *	header
	)

Set log header.

Definition at line 6868 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

TSReturnCode TSTextLogObjectRollingEnabledSet	(	TSTextLogObject	the_object,
		int	rolling_enabled
	)

Enable/disable rolling.

Parameters:

rolling_enabled

a valid proxy.config.log.rolling_enabled value.

Definition at line 6876 of file InkAPI.cc.

References LogRollingEnabledIsValid(), sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

void TSTextLogObjectRollingIntervalSecSet	(	TSTextLogObject	the_object,
		int	rolling_interval_sec
	)

Set the rolling interval.

Definition at line 6889 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

void TSTextLogObjectRollingOffsetHrSet	(	TSTextLogObject	the_object,
		int	rolling_offset_hr
	)

Set the rolling offset.

rolling_offset_hr specifies the hour (between 0 and 23) when log rolling should take place.

Definition at line 6897 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_iocore_structure(), and TS_SUCCESS.

TSReturnCode TSTextLogObjectWrite	(	TSTextLogObject	the_object,
		const char *	format,
			...
	)

Definition at line 6820 of file InkAPI.cc.

References Log::AGGR, Log::FAIL, Log::FULL, ink_assert, Log::LOG_OK, sdk_assert, sdk_sanity_check_iocore_structure(), sdk_sanity_check_null_ptr(), Log::SKIP, and TS_SUCCESS.

const char* TSTrafficServerVersionGet ( void )

Gets the version of Traffic Server currently running.

Use this function to make sure that the plugin version and Traffic Server version are compatible. See the SDK sample code for usage.

Returns:: pointer to version of Traffic Server running the plugin.

Definition at line 1727 of file InkAPI.cc.

References traffic_server_version.

Referenced by SDK_API_TSTrafficServerVersionGet().

int TSTrafficServerVersionGetMajor ( void )

Get the major version of Traffic Server currently running.

This is the same as the first element of the string returned by TSTrafficServerVersionGet

Returns:: The major version as an integer.

Definition at line 1732 of file InkAPI.cc.

References ts_major_version.

int TSTrafficServerVersionGetMinor ( void )

Get the minor version of Traffic Server currently running.

This is the same as the second element of the string returned by TSTrafficServerVersionGet

Returns:: The minor version as an integer.

Definition at line 1733 of file InkAPI.cc.

References ts_minor_version.

int TSTrafficServerVersionGetPatch ( void )

Get the patch version of Traffic Server currently running.

This is the same as the third element of the string returned by TSTrafficServerVersionGet

Returns:: The patch version as an integer.

Definition at line 1734 of file InkAPI.cc.

References ts_patch_version.

TSVConn TSTransformCreate	(	TSEventFunc	event_funcp,
		TSHttpTxn	txnp
	)

Definition at line 6341 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_txn(), TS_SUCCESS, TSContMutexGet(), and TSVConnCreate().

Referenced by transform_add().

TSVConn TSTransformOutputVConnGet ( TSVConn connp )

Definition at line 6350 of file InkAPI.cc.

References VConnection::get_data(), sdk_assert, sdk_sanity_check_iocore_structure(), TS_API_DATA_OUTPUT_VC, and TS_SUCCESS.

Referenced by handle_transform(), and transformtest_transform().

TSReturnCode TSUrlClone	(	TSMBuffer	dest_bufp,
		TSMBuffer	src_bufp,
		TSMLoc	src_url,
		TSMLoc *	locp
	)

Copies the URL located at src_url within src_bufp to a URL location within the marshal buffer dest_bufp, and returns the TSMLoc location of the copied URL.

Unlike TSUrlCopy(), you do not have to create the destination URL before cloning. Release the returned TSMLoc handle with a call to TSHandleMLocRelease().

Parameters:

	dest_bufp	marshal buffer containing the cloned URL.
	src_bufp	marshal buffer containing the URL to be cloned.
	src_url	location of the URL to be cloned, within the marshal buffer src_bufp.
	locp	pointer to a TSMLoc to store the MLoc into.

Definition at line 1951 of file InkAPI.cc.

References isWriteable(), sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), sdk_sanity_check_url_handle(), TS_SUCCESS, and url_copy().

Referenced by SDK_API_TSUrl().

TSReturnCode TSUrlCopy	(	TSMBuffer	dest_bufp,
		TSMLoc	dest_offset,
		TSMBuffer	src_bufp,
		TSMLoc	src_offset
	)

Copies the contents of the URL at location src_loc within the marshal buffer src_bufp to the location dest_loc within the marshal buffer dest_bufp.

TSUrlCopy() works correctly even if src_bufp and dest_bufp point to different marshal buffers. Important: create the destination URL before copying into it. Use TSUrlCreate().

Parameters:

	dest_bufp	marshal buffer to contain the copied URL.
	dest_offset	location of the URL to be copied.
	src_bufp	marshal buffer containing the source URL.
	src_offset	location of the source URL within src_bufp.

Definition at line 1974 of file InkAPI.cc.

References isWriteable(), sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_url_handle(), TS_SUCCESS, and url_copy_onto().

Referenced by SDK_API_TSUrl().

TSReturnCode TSUrlCreate	(	TSMBuffer	bufp,
		TSMLoc *	locp
	)

Creates a new URL within the marshal buffer bufp.

Returns a location for the URL within the marshal buffer.

Parameters:

	bufp	marshal buffer containing the new URL.
	locp	pointer to a TSMLoc to store the MLoc into.

Definition at line 1931 of file InkAPI.cc.

References isWriteable(), sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), TS_SUCCESS, and url_create().

Referenced by SDK_API_TSHttpHdr(), SDK_API_TSUrl(), and SDK_API_TSUrlParse().

TSReturnCode TSUrlDestroy	(	TSMBuffer	bufp,
		TSMLoc	offset
	)

Destroys the URL located at url_loc within the marshal buffer bufp.

Do not forget to release the TSMLoc url_loc with a call to TSHandleMLocRelease().

Parameters:

	bufp	marshal buffer containing the URL to be destroyed.
	offset	location of the URL to be destroyed.

Deprecated:: There is no reason to destroy the URL, just release the marshal buffers.

Should be removed for v5.0.0

Definition at line 1945 of file InkAPI.cc.

int TSUrlFtpTypeGet	(	TSMBuffer	bufp,
		TSMLoc	offset
	)

Retrieves the FTP type of the URL located at url_loc within bufp.

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.

Returns:: FTP type of the URL.

Definition at line 2208 of file InkAPI.cc.

References HdrHeapSDKHandle::m_heap, URL::m_url_impl, sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_url_handle(), TS_SUCCESS, and URL::type_get().

Referenced by SDK_API_TSUrl().

TSReturnCode TSUrlFtpTypeSet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		int	type
	)

Sets the FTP type portion of the URL located at url_loc within bufp to the value type.

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL to modify.
	type	new FTP type for the URL.

Definition at line 2220 of file InkAPI.cc.

References isWriteable(), HdrHeapSDKHandle::m_heap, URL::m_url_impl, sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_url_handle(), TS_SUCCESS, and URL::type_set().

Referenced by SDK_API_TSUrl().

const char* TSUrlHostGet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		int *	length
	)

Retrieves the host portion of the URL located at url_loc within bufp.

Note: the returned string is not guaranteed to be null-terminated.

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.
	length	of the returned string.

Returns:: Host portion of the URL.

Definition at line 2150 of file InkAPI.cc.

References URL::host_get(), and URLPartGet().

Referenced by SDK_API_TSHttpHdr(), and SDK_API_TSUrl().

TSReturnCode TSUrlHostSet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		const char *	value,
		int	length
	)

Sets the host portion of the URL at url_loc to the string value.

If length is -1 then TSUrlHostSet() assumes that value is null-terminated. Otherwise, the length of the string value is taken to be length. The string is copied to within bufp, so you can modify or delete value after calling TSUrlHostSet().

Parameters:

	bufp	marshal buffer containing the URL to modify.
	offset	location of the URL.
	value	new host name for the URL.
	length	string length of the new host name of the URL.

Definition at line 2156 of file InkAPI.cc.

References URL::host_set(), and URLPartSet().

Referenced by SDK_API_TSHttpHdr(), and SDK_API_TSUrl().

const char* TSUrlHttpFragmentGet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		int *	length
	)

Retrieves the HTTP fragment portion of the URL located at url_loc within bufp.

The length of the returned string is in the length argument. Note: the returned string is not guaranteed to be null-terminated.

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.
	length	of the returned string.

Returns:: HTTP fragment portion of the URL.

Definition at line 2267 of file InkAPI.cc.

References URL::fragment_get(), and URLPartGet().

Referenced by SDK_API_TSUrl().

TSReturnCode TSUrlHttpFragmentSet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		const char *	value,
		int	length
	)

Sets the HTTP fragment portion of the URL located at url_loc within bufp to value.

If length is -1, the string value is assumed to be null-terminated; otherwise, the length of value is taken to be length. TSUrlHttpFragmentSet() copies the string to within bufp, so you can modify or delete value after calling TSUrlHttpFragmentSet().

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL within bufp.
	value	new HTTP fragment string for the URL.
	length	of the new HTTP query string.

Definition at line 2273 of file InkAPI.cc.

References URL::fragment_set(), and URLPartSet().

Referenced by SDK_API_TSUrl().

const char* TSUrlHttpParamsGet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		int *	length
	)

Retrieves the HTTP params portion of the URL located at url_loc within bufp.

The length of the returned string is in the length argument. Note: the returned string is not guaranteed to be null-terminated.

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.
	length	of the returned string.

Returns:: HTTP params portion of the URL.

Definition at line 2243 of file InkAPI.cc.

References URL::params_get(), and URLPartGet().

Referenced by SDK_API_TSUrl().

TSReturnCode TSUrlHttpParamsSet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		const char *	value,
		int	length
	)

Sets the HTTP params portion of the URL located at url_loc within bufp to the string value.

If length is -1 that TSUrlHttpParamsSet() assumes that value is null-terminated. Otherwise, the length of the string value is taken to be length. TSUrlHttpParamsSet() copies the string to within bufp, so you can modify or delete value after calling TSUrlHttpParamsSet().

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.
	value	HTTP params string to set in the URL.
	length	string length of the new HTTP params value.

Definition at line 2249 of file InkAPI.cc.

References URL::params_set(), and URLPartSet().

Referenced by SDK_API_TSUrl().

const char* TSUrlHttpQueryGet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		int *	length
	)

Retrieves the HTTP query portion of the URL located at url_loc within bufp.

The length of the returned string is in the length argument. Note: the returned string is not guaranteed to be null-terminated.

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.
	length	of the returned string.

Returns:: HTTP query portion of the URL.

Definition at line 2255 of file InkAPI.cc.

References URL::query_get(), and URLPartGet().

Referenced by SDK_API_TSUrl().

TSReturnCode TSUrlHttpQuerySet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		const char *	value,
		int	length
	)

Sets the HTTP query portion of the URL located at url_loc within bufp to value.

If length is -1, the string value is assumed to be null-terminated; otherwise, the length of value is taken to be length. TSUrlHttpQuerySet() copies the string to within bufp, so you can modify or delete value after calling TSUrlHttpQuerySet().

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL within bufp.
	value	new HTTP query string for the URL.
	length	of the new HTTP query string.

Definition at line 2261 of file InkAPI.cc.

References URL::query_set(), and URLPartSet().

Referenced by SDK_API_TSUrl().

int TSUrlLengthGet	(	TSMBuffer	bufp,
		TSMLoc	offset
	)

Calculates the length of the URL located at url_loc within the marshal buffer bufp if it were returned as a string.

This length is the same as the length returned by TSUrlStringGet().

Parameters:

	bufp	marshal buffer containing the URL whose length you want.
	offset	location of the URL within the marshal buffer bufp.

Returns:: string length of the URL.

Definition at line 2051 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_url_handle(), TS_SUCCESS, and url_length_get().

Referenced by SDK_API_TSUrl().

TSParseResult TSUrlParse	(	TSMBuffer	bufp,
		TSMLoc	offset,
		const char **	start,
		const char *	end
	)

Parses a URL.

The start pointer is both an input and an output parameter and marks the start of the URL to be parsed. After a successful parse, the start pointer equals the end pointer. The end pointer must be one byte after the last character you want to parse. The URL parsing routine assumes that everything between start and end is part of the URL. It is up to higher level parsing routines, such as TSHttpHdrParseReq(), to determine the actual end of the URL. Returns TS_PARSE_ERROR if an error occurs, otherwise TS_PARSE_DONE is returned to indicate success.

Parameters:

	bufp	marshal buffer containing the URL to be parsed.
	offset	location of the URL to be parsed.
	start	points to the start of the URL to be parsed AND at the end of a successful parse it will equal the end pointer.
	end	must be one byte after the last character.

Returns:: TS_PARSE_ERROR or TS_PARSE_DONE.

Definition at line 2032 of file InkAPI.cc.

References isWriteable(), HdrHeapSDKHandle::m_heap, URL::m_url_impl, URL::parse(), sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), sdk_sanity_check_url_handle(), TS_SUCCESS, and url_clear().

Referenced by SDK_API_TSUrlParse().

const char* TSUrlPasswordGet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		int *	length
	)

Retrieves the password portion of the URL located at url_loc within bufp.

TSUrlPasswordGet() places the length of the returned string in the length argument. Note: the returned string is not guaranteed to be null-terminated.

Parameters:

	bufp	marshal buffer containing the URL.
	offset
	length	of the returned password string.

Returns:: password portion of the URL.

Definition at line 2138 of file InkAPI.cc.

References URL::password_get(), and URLPartGet().

Referenced by SDK_API_TSUrl().

TSReturnCode TSUrlPasswordSet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		const char *	value,
		int	length
	)

Sets the password portion of the URL located at url_loc within bufp to the string value.

If length is -1 then TSUrlPasswordSet() assumes that value is null-terminated. Otherwise, the length of value is taken to be length. TSUrlPasswordSet() copies the string to within bufp, so it is okay to modify or delete value after calling TSUrlPasswordSet().

Parameters:

	bufp	marshal buffer containing the URL.
	offset
	value	new password.
	length	of the new password.

Definition at line 2144 of file InkAPI.cc.

References URL::password_set(), and URLPartSet().

Referenced by SDK_API_TSUrl().

const char* TSUrlPathGet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		int *	length
	)

Retrieves the path portion of the URL located at url_loc within bufp.

TSUrlPathGet() places the length of the returned string in the length argument. Note: the returned string is not guaranteed to be null-terminated.

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.
	length	of the returned string.

Returns:: path portion of the URL.

Definition at line 2194 of file InkAPI.cc.

References URL::path_get(), and URLPartGet().

Referenced by SDK_API_TSHttpHdr(), and SDK_API_TSUrl().

TSReturnCode TSUrlPathSet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		const char *	value,
		int	length
	)

Sets the path portion of the URL located at url_loc within bufp to the string value.

If length is -1 then TSUrlPathSet() assumes that value is null-terminated. Otherwise, the length of the value is taken to be length. TSUrlPathSet() copies the string into bufp, so you can modify or delete value after calling TSUrlPathSet().

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.
	value	new path string for the URL.
	length	of the new path string.

Definition at line 2200 of file InkAPI.cc.

References URL::path_set(), and URLPartSet().

Referenced by SDK_API_TSHttpHdr(), and SDK_API_TSUrl().

TSReturnCode TSUrlPercentEncode	(	TSMBuffer	bufp,
		TSMLoc	offset,
		char *	dst,
		size_t	dst_size,
		size_t *	length,
		const unsigned char *	map
	)

Similar to TSStringPercentEncode(), but works on a URL object.

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL within bufp.
	dst	destination buffer.
	dst_size	size of the destination buffer.
	length	amount of data written to the destination buffer.
	map	optional (can be NULL) map of characters to encode.

Definition at line 2329 of file InkAPI.cc.

References ats_free(), sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_url_handle(), TS_SUCCESS, TSStringPercentEncode(), and url_string_get().

int TSUrlPortGet	(	TSMBuffer	bufp,
		TSMLoc	offset
	)

Retrieves the port portion of the URL located at url_loc.

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.

Returns:: port portion of the URL.

Definition at line 2162 of file InkAPI.cc.

References HdrHeapSDKHandle::m_heap, URL::m_url_impl, URL::port_get(), sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_url_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr(), and SDK_API_TSUrl().

TSReturnCode TSUrlPortSet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		int	port
	)

Sets the port portion of the URL located at url_loc.

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.
	port	new port setting for the URL.

Definition at line 2175 of file InkAPI.cc.

References isWriteable(), HdrHeapSDKHandle::m_heap, URL::m_url_impl, URL::port_set(), sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_url_handle(), and TS_SUCCESS.

Referenced by SDK_API_TSHttpHdr(), and SDK_API_TSUrl().

void TSUrlPrint	(	TSMBuffer	bufp,
		TSMLoc	offset,
		TSIOBuffer	iobufp
	)

Formats a URL stored in an TSMBuffer into an TSIOBuffer.

Parameters:

	bufp	marshal buffer contain the URL to be printed.
	offset	location of the URL within bufp.
	iobufp	destination TSIOBuffer for the URL.

Definition at line 1997 of file InkAPI.cc.

References MIOBuffer::add_block(), IOBufferBlock::end(), MIOBuffer::fill(), MIOBuffer::get_current_block(), HdrHeapSDKHandle::m_heap, URL::m_url_impl, URL::print(), sdk_assert, sdk_sanity_check_iocore_structure(), sdk_sanity_check_mbuffer(), sdk_sanity_check_url_handle(), TS_SUCCESS, and IOBufferBlock::write_avail().

Referenced by test_url_print().

const char* TSUrlSchemeGet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		int *	length
	)

Retrieves the scheme portion of the URL located at url_loc within the marshal buffer bufp.

TSUrlSchemeGet() places the length of the string in the length argument. If the length is NULL then no attempt is made to dereference it.

Parameters:

	bufp	marshal buffer storing the URL.
	offset	location of the URL within bufp.
	length	length of the returned string.

Returns:: The scheme portion of the URL, as a string.

Definition at line 2112 of file InkAPI.cc.

References URL::scheme_get(), and URLPartGet().

Referenced by SDK_API_TSHttpHdr(), and SDK_API_TSUrl().

TSReturnCode TSUrlSchemeSet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		const char *	value,
		int	length
	)

Sets the scheme portion of the URL located at url_loc within the marshal buffer bufp to the string value.

If length is -1 then TSUrlSchemeSet() assumes that value is null-terminated. Otherwise, the length of the string value is taken to be length. TSUrlSchemeSet() copies the string to within bufp, so it is OK to modify or delete value after calling TSUrlSchemeSet().

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.
	value	value to set the URL's scheme to.
	length	string stored in value.

Definition at line 2118 of file InkAPI.cc.

References URL::scheme_set(), and URLPartSet().

Referenced by SDK_API_TSHttpHdr(), and SDK_API_TSUrl().

char* TSUrlStringGet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		int *	length
	)

Constructs a string representation of the URL located at url_loc within bufp.

TSUrlStringGet() stores the length of the allocated string in the parameter length. This is the same length that TSUrlLengthGet() returns. The returned string is allocated by a call to TSmalloc(). It should be freed by a call to TSfree(). The length parameter must present, providing storage for the URL string length value. Note: To get the effective URL from a request, use the alternative TSHttpTxnEffectiveUrlStringGet API.

Parameters:

	bufp	marshal buffer containing the URL you want to get.
	offset	location of the URL within bufp.
	length	string length of the URL.

Returns:: The URL as a string.

Definition at line 2061 of file InkAPI.cc.

References sdk_assert, sdk_sanity_check_mbuffer(), sdk_sanity_check_null_ptr(), sdk_sanity_check_url_handle(), TS_SUCCESS, and url_string_get().

Referenced by SDK_API_TSUrl(), and SDK_API_TSUrlParse().

const char* TSUrlUserGet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		int *	length
	)

Retrieves the user portion of the URL located at url_loc within bufp.

Note: the returned string is not guaranteed to be null-terminated.

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL.
	length	length of the returned string.

Returns:: user portion of the URL.

Definition at line 2126 of file InkAPI.cc.

References URLPartGet(), and URL::user_get().

Referenced by SDK_API_TSUrl().

TSReturnCode TSUrlUserSet	(	TSMBuffer	bufp,
		TSMLoc	offset,
		const char *	value,
		int	length
	)

Sets the user portion of the URL located at url_loc within bufp to the string value.

If length is -1 then TSUrlUserSet() assumes that value is null-terminated. Otherwise, the length of the string value is taken to be length. TSUrlUserSet() copies the string to within bufp, so it is OK to modify or delete value after calling TSUrlUserSet().

Parameters:

	bufp	marshal buffer containing the URL.
	offset	location of the URL whose user is to be set.
	value	holds the new user name.
	length	string length of value.