URLs

API URL functions provide access to URL data stored in marshal buffers. The URL functions can create, copy, retrieve or delete entire URLs; they can also retrieve or modify parts of URLs, such as port or scheme information.

The general form of an Internet URL is:

scheme://user:password@host:port/stuff

The URL data structure includes support for two specific types of internet URLs. HTTP URLs have the form:

http://user:password@host:port/path;params?query#fragment

The URL port is stored as integer. All remaining parts of the URL (scheme, user, etc.) are stored as strings. Traffic Server URL functions are named according to the portion of the URL on which they operate. For instance, the function that retrieves the host portion of a URL is named TSUrlHostGet.

To facilitate fast comparisons and reduce storage size, Traffic Server defines several preallocated scheme names.

TS_URL_SCHEME_FILE

"file"

TS_URL_LEN_FILE

TS_URL_SCHEME_FTP

"ftp"

TS_URL_LEN_FTP

TS_URL_SCHEME_GOPHER

"gopher"

TS_URL_LEN_GOPHER

TS_URL_SCHEME_HTTP

"http"

TS_URL_LEN_HTTP

TS_URL_SCHEME_HTTPS

"https"

TS_URL_LEN_HTTPS

TS_URL_SCHEME_MAILTO

"mailto"

TS_URL_LEN_MAILTO

TS_URL_SCHEME_NEWS

"news"

TS_URL_LEN_NEWS

TS_URL_SCHEME_NNTP

"nntp"

TS_URL_LEN_NNTP

TS_URL_SCHEME_PROSPERO

"prospero"

TS_URL_LEN_PROSPERO

TS_URL_SCHEME_TELNET

"telnet"

TS_URL_LEN_TELNET

TS_URL_SCHEME_WAIS

"wais"

TS_URL_LEN_WAIS

TS_URL_SCHEME_WS

"ws"

TS_URL_LEN_WS

TS_URL_SCHEME_WSS

"wss"

TS_URL_LEN_WSS

The scheme names above are defined in ts.h as const char* strings. When Traffic Server sets the scheme portion of the URL (or any portion for that matter), it quickly checks to see if the new value is one of the known values. If it is, then it stores a pointer into a global table (instead of storing the known value in the marshal buffer). The scheme values listed above are also pointers into this table. This allows simple pointer comparison of the value returned from TSUrlSchemeGet with one of the values listed above. You should use the Traffic Server-defined values when referring to one of the known schemes, since doing so can prevent the possibility of spelling errors.

Traffic Server URL functions are listed below:

TSUrlClone() TSUrlCopy() TSUrlCreate() TSUrlPrint() TSUrlFtpTypeGet() TSUrlFtpTypeSet() TSUrlHostGet() TSUrlHostSet() TSUrlHttpFragmentGet() TSUrlHttpFragmentSet() TSUrlHttpParamsGet() TSUrlHttpParamsSet() TSUrlHttpQueryGet() TSUrlHttpQuerySet() TSUrlLengthGet() TSUrlParse() TSUrlPasswordGet() TSUrlPasswordSet() TSUrlPathGet() TSUrlPathSet() TSUrlPortGet() TSUrlPortSet() TSUrlSchemeGet() TSUrlSchemeSet() TSUrlStringGet() TSUrlUserGet() TSUrlUserSet()