NAME

       TSUrlHostGet - traffic Server URL component retrieval API

SYNOPSIS

       #include <ts/ts.h>

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

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

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

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

       int TSUrlPortGet(TSMBuffer bufp, TSMLoc offset)

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

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

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

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

DESCRIPTION

       The  URL data structure is a parsed version of a standard internet URL. The Traffic Server
       URL API provides access to URL data stored in  marshal  buffers.  The  URL  functions  can
       create,  copy,  retrieve or delete entire URLs, and retrieve or modify parts of URLs, such
       as their host, port or scheme information.

       TSUrlSchemeGet(),        TSUrlUserGet(),        TSUrlPasswordGet(),        TSUrlHostGet(),
       TSUrlHttpParamsGet(),  TSUrlHttpQueryGet()  and  TSUrlHttpFragmentGet()  each  retrieve an
       internal pointer to the specified portion of the URL from the marshall  buffer  bufp.  The
       length  of  the  returned  string  is placed in length and a pointer to the URL portion is
       returned.

       TSUrlPortGet() retrieves the port number portion of the URL located at offset  within  the
       marshal  buffer  bufp.  If  there  is  no explicit port number in the URL, a canonicalized
       valued is returned based on the URL scheme.

RETURN VALUES

       All APIs except TSUrlPortGet() returns a string,  which  is  not  guaranteed  to  be  NULL
       terminated.  You must therefore always use the length value to determine the actual length
       of the returned string.

       TSUrlPortGet() simply returns the port number as an integer, possibly  canonicalized  with
       80  for  HTTP  and  443 for HTTPS schemes. If there is neither port nor scheme information
       available in the URL, 0 is returned.

SEE ALSO

       TSAPI(3ts),        TSUrlCreate(3ts),        TSUrlHostSet(3ts),        TSUrlStringGet(3ts),
       TSUrlPercentEncode(3ts)

COPYRIGHT

       2018, dev@trafficserver.apache.org