Apache HTTPD
Classes | Macros | Typedefs | Functions | Variables
URI

Classes

struct  apr_uri_t
 

Macros

#define APR_URI_FTP_DEFAULT_PORT   21
 
#define APR_URI_SSH_DEFAULT_PORT   22
 
#define APR_URI_TELNET_DEFAULT_PORT   23
 
#define APR_URI_GOPHER_DEFAULT_PORT   70
 
#define APR_URI_HTTP_DEFAULT_PORT   80
 
#define APR_URI_POP_DEFAULT_PORT   110
 
#define APR_URI_NNTP_DEFAULT_PORT   119
 
#define APR_URI_IMAP_DEFAULT_PORT   143
 
#define APR_URI_PROSPERO_DEFAULT_PORT   191
 
#define APR_URI_WAIS_DEFAULT_PORT   210
 
#define APR_URI_LDAP_DEFAULT_PORT   389
 
#define APR_URI_HTTPS_DEFAULT_PORT   443
 
#define APR_URI_RTSP_DEFAULT_PORT   554
 
#define APR_URI_SNEWS_DEFAULT_PORT   563
 
#define APR_URI_ACAP_DEFAULT_PORT   674
 
#define APR_URI_NFS_DEFAULT_PORT   2049
 
#define APR_URI_TIP_DEFAULT_PORT   3372
 
#define APR_URI_SIP_DEFAULT_PORT   5060
 
#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 struct apr_uri_t apr_uri_t
 

Functions

 APU_DECLARE (apr_port_t) apr_uri_port_of_scheme(const char *scheme_str)
 
 APU_DECLARE (char *) apr_uri_unparse(apr_pool_t *p
 
 APU_DECLARE (apr_status_t) apr_uri_parse(apr_pool_t *p
 

Variables

const apr_uri_tuptr
 
const apr_uri_t unsigned flags
 
const charuri
 
const charhostinfo
 

Detailed Description

Macro Definition Documentation

◆ APR_URI_ACAP_DEFAULT_PORT

#define APR_URI_ACAP_DEFAULT_PORT   674

default ACAP port

Definition at line 57 of file apr_uri.h.

◆ APR_URI_FTP_DEFAULT_PORT

#define APR_URI_FTP_DEFAULT_PORT   21

default FTP port

Definition at line 43 of file apr_uri.h.

◆ APR_URI_GOPHER_DEFAULT_PORT

#define APR_URI_GOPHER_DEFAULT_PORT   70

default Gopher port

Definition at line 46 of file apr_uri.h.

◆ APR_URI_HTTP_DEFAULT_PORT

#define APR_URI_HTTP_DEFAULT_PORT   80

default HTTP port

Definition at line 47 of file apr_uri.h.

◆ APR_URI_HTTPS_DEFAULT_PORT

#define APR_URI_HTTPS_DEFAULT_PORT   443

default HTTPS port

Definition at line 54 of file apr_uri.h.

◆ APR_URI_IMAP_DEFAULT_PORT

#define APR_URI_IMAP_DEFAULT_PORT   143

default IMAP port

Definition at line 50 of file apr_uri.h.

◆ APR_URI_LDAP_DEFAULT_PORT

#define APR_URI_LDAP_DEFAULT_PORT   389

default LDAP port

Definition at line 53 of file apr_uri.h.

◆ APR_URI_NFS_DEFAULT_PORT

#define APR_URI_NFS_DEFAULT_PORT   2049

default NFS port

Definition at line 58 of file apr_uri.h.

◆ APR_URI_NNTP_DEFAULT_PORT

#define APR_URI_NNTP_DEFAULT_PORT   119

default NNTP port

Definition at line 49 of file apr_uri.h.

◆ APR_URI_POP_DEFAULT_PORT

#define APR_URI_POP_DEFAULT_PORT   110

default POP port

Definition at line 48 of file apr_uri.h.

◆ APR_URI_PROSPERO_DEFAULT_PORT

#define APR_URI_PROSPERO_DEFAULT_PORT   191

default Prospero port

Definition at line 51 of file apr_uri.h.

◆ APR_URI_RTSP_DEFAULT_PORT

#define APR_URI_RTSP_DEFAULT_PORT   554

default RTSP port

Definition at line 55 of file apr_uri.h.

◆ APR_URI_SIP_DEFAULT_PORT

#define APR_URI_SIP_DEFAULT_PORT   5060

default SIP port

Definition at line 60 of file apr_uri.h.

◆ APR_URI_SNEWS_DEFAULT_PORT

#define APR_URI_SNEWS_DEFAULT_PORT   563

default SNEWS port

Definition at line 56 of file apr_uri.h.

◆ APR_URI_SSH_DEFAULT_PORT

#define APR_URI_SSH_DEFAULT_PORT   22

default SSH port

Definition at line 44 of file apr_uri.h.

◆ APR_URI_TELNET_DEFAULT_PORT

#define APR_URI_TELNET_DEFAULT_PORT   23

default telnet port

Definition at line 45 of file apr_uri.h.

◆ APR_URI_TIP_DEFAULT_PORT

#define APR_URI_TIP_DEFAULT_PORT   3372

default TIP port

Definition at line 59 of file apr_uri.h.

◆ APR_URI_UNP_OMITPASSWORD

#define APR_URI_UNP_OMITPASSWORD   (1U<<2)

Just omit password

Definition at line 68 of file apr_uri.h.

◆ APR_URI_UNP_OMITPATHINFO

#define APR_URI_UNP_OMITPATHINFO   (1U<<4)

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

Definition at line 75 of file apr_uri.h.

◆ APR_URI_UNP_OMITQUERY

#define APR_URI_UNP_OMITQUERY   (1U<<5)

Omit the "?queryarg" from the path

Definition at line 77 of file apr_uri.h.

◆ APR_URI_UNP_OMITSITEPART

#define APR_URI_UNP_OMITSITEPART   (1U<<0)

Flags passed to unparse_uri_components(): suppress "scheme://user\@site:port"

Definition at line 64 of file apr_uri.h.

◆ APR_URI_UNP_OMITUSER

#define APR_URI_UNP_OMITUSER   (1U<<1)

Just omit user

Definition at line 66 of file apr_uri.h.

◆ APR_URI_UNP_OMITUSERINFO

#define APR_URI_UNP_OMITUSERINFO
Value:
#define APR_URI_UNP_OMITUSER
Definition apr_uri.h:66
#define APR_URI_UNP_OMITPASSWORD
Definition apr_uri.h:68

omit "user:password\@" part

Definition at line 70 of file apr_uri.h.

◆ APR_URI_UNP_REVEALPASSWORD

#define APR_URI_UNP_REVEALPASSWORD   (1U<<3)

Show plain text password (default: show XXXXXXXX)

Definition at line 73 of file apr_uri.h.

◆ APR_URI_WAIS_DEFAULT_PORT

#define APR_URI_WAIS_DEFAULT_PORT   210

default WAIS port

Definition at line 52 of file apr_uri.h.

Typedef Documentation

◆ apr_uri_t

See also
apr_uri_t

Definition at line 80 of file apr_uri.h.

Function Documentation

◆ APU_DECLARE() [1/3]

APU_DECLARE ( apr_port_t  ) const

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

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

◆ APU_DECLARE() [2/3]

APU_DECLARE ( apr_status_t  )

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
pThe pool to allocate out of
uriThe uri to parse
uptrThe apr_uri_t to fill out
Returns
APR_SUCCESS for success or error code

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

Parameters
pThe pool to allocate out of
hostinfoThe hostinfo string to parse
uptrThe apr_uri_t to fill out
Returns
APR_SUCCESS for success or error code

< Shared lock. More than one process or thread can hold a shared lock at any given time. Essentially, this is a "read lock", preventing writers from establishing an exclusive lock.

< Shared lock. More than one process or thread can hold a shared lock at any given time. Essentially, this is a "read lock", preventing writers from establishing an exclusive lock.

< Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".

< Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".

< Replace

< Insert with duplicates

< Shared lock. More than one process or thread can hold a shared lock at any given time. Essentially, this is a "read lock", preventing writers from establishing an exclusive lock.

< Shared lock. More than one process or thread can hold a shared lock at any given time. Essentially, this is a "read lock", preventing writers from establishing an exclusive lock.

< mask to extract lock type

< Shared lock. More than one process or thread can hold a shared lock at any given time. Essentially, this is a "read lock", preventing writers from establishing an exclusive lock.

< Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".

< Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".

< Size of the file

< Shared lock. More than one process or thread can hold a shared lock at any given time. Essentially, this is a "read lock", preventing writers from establishing an exclusive lock.

< Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".

Definition at line 358 of file apr_brigade.c.

◆ APU_DECLARE() [3/3]

APU_DECLARE ( char )

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

Parameters
pThe pool to allocate out of
uptrAll of the parts of the uri
flagsHow 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

Variable Documentation

◆ flags

Definition at line 148 of file apr_uri.h.

◆ hostinfo

const char* hostinfo

Definition at line 170 of file apr_uri.h.

◆ uptr

Definition at line 147 of file apr_uri.h.

◆ uri

const char* uri

Definition at line 159 of file apr_uri.h.