Main Page   Packages   Modules   Data Structures   File List   Data Fields   Globals  

URI
[APR Utility Functions]


Data Structures

struct  apr_uri_t

Defines

#define APR_URI_FTP_DEFAULT_PORT   21 /**< default FTP port */
#define APR_URI_SSH_DEFAULT_PORT   22 /**< default SSH port */
#define APR_URI_TELNET_DEFAULT_PORT   23 /**< default telnet port */
#define APR_URI_GOPHER_DEFAULT_PORT   70 /**< default Gopher port */
#define APR_URI_HTTP_DEFAULT_PORT   80 /**< default HTTP port */
#define APR_URI_POP_DEFAULT_PORT   110 /**< default POP port */
#define APR_URI_NNTP_DEFAULT_PORT   119 /**< default NNTP port */
#define APR_URI_IMAP_DEFAULT_PORT   143 /**< default IMAP port */
#define APR_URI_PROSPERO_DEFAULT_PORT   191 /**< default Prospero port */
#define APR_URI_WAIS_DEFAULT_PORT   210 /**< default WAIS port */
#define APR_URI_LDAP_DEFAULT_PORT   389 /**< default LDAP port */
#define APR_URI_HTTPS_DEFAULT_PORT   443 /**< default HTTPS port */
#define APR_URI_RTSP_DEFAULT_PORT   554 /**< default RTSP port */
#define APR_URI_SNEWS_DEFAULT_PORT   563 /**< default SNEWS port */
#define APR_URI_ACAP_DEFAULT_PORT   674 /**< default ACAP port */
#define APR_URI_NFS_DEFAULT_PORT   2049 /**< default NFS port */
#define APR_URI_TIP_DEFAULT_PORT   3372 /**< default TIP port */
#define APR_URI_SIP_DEFAULT_PORT   5060 /**< default SIP port */
#define APR_URI_UNP_OMITSITEPART   (1U<<0)
#define APR_URI_UNP_OMITUSER   (1U<<1)
#define APR_URI_UNP_OMITPASSWORD   (1U<<2)
#define APR_URI_UNP_OMITUSERINFO
#define APR_URI_UNP_REVEALPASSWORD   (1U<<3)
#define APR_URI_UNP_OMITPATHINFO   (1U<<4)
#define APR_URI_UNP_OMITQUERY   (1U<<5)

Typedefs

typedef apr_uri_t apr_uri_t

Functions

apr_port_t apr_uri_port_of_scheme (const char *scheme_str)
apr_port_t apr_uri_default_port_for_scheme (const char *scheme_str)
char * apr_uri_unparse (apr_pool_t *p, const apr_uri_t *uptr, unsigned flags)
int apr_uri_parse (apr_pool_t *p, const char *uri, apr_uri_t *uptr)
int apr_uri_parse_hostinfo (apr_pool_t *p, const char *hostinfo, apr_uri_t *uptr)

Define Documentation

#define APR_URI_UNP_OMITPASSWORD   (1U<<2)
 

Just omit password

#define APR_URI_UNP_OMITPATHINFO   (1U<<4)
 

Show "scheme://user@site:port" only

#define APR_URI_UNP_OMITQUERY   (1U<<5)
 

Omit the "?queryarg" from the path

#define APR_URI_UNP_OMITSITEPART   (1U<<0)
 

suppress "scheme://user@site:port"

#define APR_URI_UNP_OMITUSER   (1U<<1)
 

Just omit user

#define APR_URI_UNP_OMITUSERINFO
 

Value:

omit "user:password@" part

#define APR_URI_UNP_REVEALPASSWORD   (1U<<3)
 

Show plain text password (default: show XXXXXXXX)


Typedef Documentation

typedef struct apr_uri_t apr_uri_t
 

See also:
apr_uri_t


Function Documentation

apr_port_t apr_uri_default_port_for_scheme const char *    scheme_str
 

Deprecated:
See also:
apr_uri_port_of_scheme

int apr_uri_parse apr_pool_t *    p,
const char *    uri,
apr_uri_t   uptr
 

Parse a given URI, fill in all supplied fields of a apr_uri_t structure. This eliminates the necessity of extracting host, port, path, query info repeatedly in the modules.

Parameters:
p  The pool to allocate out of
uri  The uri to parse
uptr  The apr_uri_t to fill out
Returns:
An HTTP status code

int apr_uri_parse_hostinfo apr_pool_t *    p,
const char *    hostinfo,
apr_uri_t   uptr
 

Special case for CONNECT parsing: it comes with the hostinfo part only

Parameters:
p  The pool to allocate out of
hostinfo  The hostinfo string to parse
uptr  The apr_uri_t to fill out
Returns:
An HTTP status code

apr_port_t apr_uri_port_of_scheme const char *    scheme_str
 

Return the default port for a given scheme. The schemes recognized are http, ftp, https, gopher, wais, nntp, snews, and prospero

Parameters:
scheme_str  The string that contains the current scheme
Returns:
The default port for this scheme

char* apr_uri_unparse apr_pool_t *    p,
const apr_uri_t   uptr,
unsigned    flags
 

Unparse a apr_uri_t structure to an URI string. Optionally suppress the password for security reasons.

Parameters:
p  The pool to allocate out of
uptr  All of the parts of the uri
flags  How to unparse the uri. One of:
    APR_URI_UNP_OMITSITEPART        Suppress "scheme://user@site:port" 
    APR_URI_UNP_OMITUSER            Just omit user 
    APR_URI_UNP_OMITPASSWORD        Just omit password 
    APR_URI_UNP_OMITUSERINFO        Omit "user:password@" part
    APR_URI_UNP_REVEALPASSWORD      Show plain text password (default: show XXXXXXXX)
    APR_URI_UNP_OMITPATHINFO        Show "scheme://user@site:port" only 
    APR_URI_UNP_OMITQUERY           Omit "?queryarg" or "fragment" 
 
Returns:
The uri as a string


Generated on Fri Dec 26 01:49:08 2003 for Apache Portable Runtime Utility Library by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002