Classes
struct	apr_getopt_t

struct	apr_getopt_option_t

Typedefs
typedef void()	apr_getopt_err_fn_t(void arg, const char err,...)

typedef struct apr_getopt_t	apr_getopt_t

typedef struct apr_getopt_option_t	apr_getopt_option_t

Functions
	APR_DECLARE (apr_status_t) apr_getopt_init(apr_getopt_t **os

Variables
apr_pool_t *	cont

apr_pool_t int	argc

apr_pool_t int const char const	argv

const char *	opts

const char char *	option_ch

const char char const char **	option_arg

Detailed Description

Typedef Documentation

◆ apr_getopt_err_fn_t

typedef void() apr_getopt_err_fn_t(void *arg, const char *err,...)

An apr_getopt_t error callback function.

arg is this apr_getopt_t's errarg member.

Definition at line 42 of file apr_getopt.h.

◆ apr_getopt_option_t

typedef struct apr_getopt_option_t apr_getopt_option_t

See also: apr_getopt_option_t

Definition at line 78 of file apr_getopt.h.

◆ apr_getopt_t

typedef struct apr_getopt_t apr_getopt_t

See also: apr_getopt_t

Definition at line 45 of file apr_getopt.h.

Function Documentation

◆ APR_DECLARE()

APR_DECLARE ( apr_status_t )

Initialize the arguments for parsing by apr_getopt().

Parameters

os	The options structure created for apr_getopt()
cont	The pool to operate on
argc	The number of arguments to parse
argv	The array of arguments to parse

Remarks: Arguments 3 and 4 are most commonly argc and argv from main(argc, argv) The (*os)->errfn is initialized to fprintf(stderr... but may be overridden.

Parse the options initialized by apr_getopt_init().

Parameters

os	The apr_opt_t structure returned by apr_getopt_init()
opts	A string of characters that are acceptable options to the program. Characters followed by ":" are required to have an option associated
option_ch	The next option character parsed
option_arg	The argument following the option character:

Returns

There are four potential status values on exit. They are:

            APR_EOF      --  No more options to parse
            APR_BADCH    --  Found a bad option character
            APR_BADARG   --  No argument followed the option flag
            APR_SUCCESS  --  The next option was found.

Parse the options initialized by apr_getopt_init(), accepting long options beginning with "--" in addition to single-character options beginning with "-".

Parameters

os	The apr_getopt_t structure created by apr_getopt_init()
opts	A pointer to a list of apr_getopt_option_t structures, which can be initialized with { "name", optch, has_args }. has_args is nonzero if the option requires an argument. A structure with an optch value of 0 terminates the list.
option_ch	Receives the value of "optch" from the apr_getopt_option_t structure corresponding to the next option matched.
option_arg	Receives the argument following the option, if any.

Returns

There are four potential status values on exit. They are:

            APR_EOF      --  No more options to parse
            APR_BADCH    --  Found a bad option character
            APR_BADARG   --  No argument followed the option flag
            APR_SUCCESS  --  The next option was found.

When APR_SUCCESS is returned, os->ind gives the index of the first non-option argument. On error, a message will be printed to stdout unless os->err is set to 0. If os->interleave is set to nonzero, options can come after arguments, and os->argv will be permuted to leave non-option arguments at the end (the original argv is unaffected).

< File is read-only

< File is executable

< all protections

< File is read-only

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< File is executable

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Stat the link not the file itself if it is a link

< ->name in proper case

< Access Time

< Create the file if not there

< Open the file for reading

< Open the file for writing

< Delete the file after close

< Open should fail if APR_FOPEN_CREATE and file exists.

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Read by user

<

Deprecated:

See also: APR_FPROT_UREAD

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< ->name in proper case

< Modification Time

< Access Time

< Creation or inode-changed time

< Type

< Size of the file

< Storage size consumed by the file

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< ->name in proper case

< Type

< all protections

< ->name in proper case

< File is read-only

< File is hidden

< File is read-only

< File is hidden

< Platform dependent flag to enable * non blocking file io

< Open the file for reading

< Open the file for writing

< Open the file for reading

< Open the file for writing

< Open the file for buffered I/O

< Create the file if not there

< Open should fail if APR_FOPEN_CREATE and file exists.

< Open the file and truncate to 0 length

< Open should fail if APR_FOPEN_CREATE and file exists.

< Create the file if not there

< Open the file and truncate to 0 length

< Append to the end of the file

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Delete the file after close

< Open the file for buffered I/O

< Open the file for writing

< Open the file for reading

< Append to the end of the file

< an atomic unix apr_stat()

< Open the file for writing

< Create the file if not there

< Open the file and truncate to 0 length

< Open the file for writing

< Create the file if not there

< Append to the end of the file

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< File is read-only

< File is executable

< all protections

< File is read-only

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< File is executable

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Access Time

< Stat the link not the file itself if it is a link

< Create the file if not there

< Open the file for reading

< Open the file for writing

< Open should fail if APR_FOPEN_CREATE and file exists.

< Delete the file after close

< Open the file for reading

< Open the file for writing

< Open the file for reading

< Open the file for writing

< Create the file if not there

< Open should fail if APR_FOPEN_CREATE and file exists.

< Create the file if not there

< Append to the end of the file

< Open the file and truncate to 0 length

< Platform dependent flag to enable * non blocking file io

< use OS's default permissions

<

Deprecated:

See also: APR_FPROT_OS_DEFAULT

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Open the file for buffered I/O

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Open the file for buffered I/O

< Open the file for writing

< Open the file for reading

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

The problem with trying to output the entire iovec is that we cannot maintain the behaviour that a real writev would have. If we iterate over the iovec one at a time, we lose the atomic properties of writev(). The other option is to combine the entire iovec into one buffer that we could then send in one call to write(). This is not reasonable since we do not know how much data an iovec could contain.

The only reasonable option, that maintains the semantics of a real writev(), is to only write the first iovec. Callers of file_writev() must deal with partial writes as they normally would. If you want to ensure an entire iovec is written, use apr_file_writev_full().

< ->name in proper case

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Size of the file

< dev and inode

< Number of links

< ->name in proper case

< Type

< ->name in proper case

< File is read-only

< File is hidden

< File is read-only

< File is hidden

< Open the file for reading

< use OS's default permissions

<

Deprecated:

See also: APR_FPROT_OS_DEFAULT

< Platform dependent flag to enable * non blocking file io

< Open the file for reading

< Open the file for writing

< Create the file if not there

< Open should fail if APR_FOPEN_CREATE and file exists.

< Open the file and truncate to 0 length

< Open should fail if APR_FOPEN_CREATE and file exists.

< Create the file if not there

< Delete the file after close

< Open the file for reading

< Open the file for writing

< Platform dependent tag to open the file for use across multiple threads

< Append to the end of the file

< Open the file for buffered I/O

< Platform dependent flag to enable * sparse file support, see WARNING below

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Append to the end of the file

< Open the file for buffered I/O

< Open the file for writing

< Open the file for reading

< Platform dependent tag to open the file for use across multiple threads

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

< Platform dependent tag to open the file for use across multiple threads

< Size of the file

< Platform dependent tag to open the file for use across multiple threads

< Size of the file

Definition at line 74 of file apr_atomic.c.

Variable Documentation

◆ argc

apr_pool_t int argc

Definition at line 104 of file apr_getopt.h.

◆ argv

apr_pool_t int const char* const* argv

Definition at line 104 of file apr_getopt.h.

◆ cont

apr_pool_t* cont

Definition at line 103 of file apr_getopt.h.

◆ option_arg

const apr_getopt_option_t int const char ** option_arg

Definition at line 123 of file apr_getopt.h.

◆ option_ch

const apr_getopt_option_t int * option_ch

Definition at line 123 of file apr_getopt.h.

◆ opts

const apr_getopt_option_t * opts

Definition at line 122 of file apr_getopt.h.

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ apr_getopt_err_fn_t

◆ apr_getopt_option_t

◆ apr_getopt_t

Function Documentation

◆ APR_DECLARE()

Variable Documentation

◆ argc

◆ argv

◆ cont

◆ option_arg

◆ option_ch

◆ opts