GME  13
Classes | Typedefs | Functions | Variables
Portability Routines

Classes

struct  apr_os_proc_mutex_t
struct  apr_os_sock_info_t
struct  apr_os_global_mutex_t

Typedefs

typedef int apr_os_file_t
typedef DIR apr_os_dir_t
typedef int apr_os_sock_t
typedef struct apr_os_proc_mutex_t apr_os_proc_mutex_t
typedef pid_t apr_os_proc_t
typedef struct timeval apr_os_imp_time_t
typedef struct tm apr_os_exp_time_t
typedef void * apr_os_dso_handle_t
typedef void * apr_os_shm_t
typedef struct apr_os_sock_info_t apr_os_sock_info_t
 alias for local OS socket
typedef struct
apr_os_global_mutex_t 
apr_os_global_mutex_t

Functions

 APR_DECLARE (apr_status_t) apr_os_global_mutex_get(apr_os_global_mutex_t *ospmutex
 APR_DECLARE (const char *) apr_os_default_encoding(apr_pool_t *pool)

Variables

apr_global_mutex_tpmutex
apr_file_tfile
apr_dir_tdir
apr_socket_tsock
apr_time_exp_taprtime
apr_shm_tshm
apr_os_file_tthefile
apr_os_file_t apr_int32_t flags
apr_os_file_t apr_int32_t
apr_pool_t
cont
apr_os_file_t int register_cleanup
apr_os_dir_tthedir
apr_os_sock_tthesock
apr_os_sock_info_tos_sock_info
apr_os_proc_mutex_tospmutex
apr_os_imp_time_t ** ostime
apr_os_shm_tosshm

Typedef Documentation

typedef DIR apr_os_dir_t

native dir

Definition at line 146 of file apr_portable.h.

native dso types

Definition at line 169 of file apr_portable.h.

typedef struct tm apr_os_exp_time_t

native tm

Definition at line 158 of file apr_portable.h.

typedef int apr_os_file_t

native file

Definition at line 145 of file apr_portable.h.

Definition at line 210 of file apr_portable.h.

typedef struct timeval apr_os_imp_time_t

native timeval

Definition at line 157 of file apr_portable.h.

native process mutex

Definition at line 148 of file apr_portable.h.

typedef pid_t apr_os_proc_t

native pid

Definition at line 156 of file apr_portable.h.

typedef void* apr_os_shm_t

native SHM

Definition at line 171 of file apr_portable.h.

alias for local OS socket

Definition at line 192 of file apr_portable.h.

typedef int apr_os_sock_t

native dir

Definition at line 147 of file apr_portable.h.


Function Documentation

convert the file from apr type to os specific type.

Parameters:
thefileThe os specific file we are converting to
fileThe apr file to convert.
Remarks:
On Unix, it is only possible to get a file descriptor from an apr file type.

convert the dir from apr type to os specific type.

Parameters:
thedirThe os specific dir we are converting to
dirThe apr dir to convert.

Convert the socket from an apr type to an OS specific socket

Parameters:
thesockThe socket to convert.
sockThe os specific equivalent of the apr socket..

Convert the proc mutex from os specific type to apr type

Parameters:
ospmutexThe os specific proc mutex we are converting to.
pmutexThe apr proc mutex to convert.

Get the exploded time in the platforms native format.

Parameters:
ostimethe native time format
aprtimethe time to convert

Get the imploded time in the platforms native format.

Parameters:
ostimethe native time format
aprtimethe time to convert

convert the shm from apr type to os specific type.

Parameters:
osshmThe os specific shm representation
shmThe apr shm to convert.

convert the file from os specific type to apr type.

Parameters:
fileThe apr file we are converting to.
thefileThe os specific file to convert
flagsThe flags that were used to open this file.
contThe pool to use if it is needed.
Remarks:
On Unix, it is only possible to put a file descriptor into an apr file type.

convert the file from os specific type to apr type.

Parameters:
fileThe apr file we are converting to.
thefileThe os specific pipe to convert
contThe pool to use if it is needed.
Remarks:
On Unix, it is only possible to put a file descriptor into an apr file type.

convert the file from os specific type to apr type.

Parameters:
fileThe apr file we are converting to.
thefileThe os specific pipe to convert
register_cleanupA cleanup will be registered on the apr_file_t to issue apr_file_close().
contThe pool to use if it is needed.
Remarks:
On Unix, it is only possible to put a file descriptor into an apr file type.

convert the dir from os specific type to apr type.

Parameters:
dirThe apr dir we are converting to.
thedirThe os specific dir to convert
contThe pool to use when creating to apr directory.

Convert a socket from the os specific type to the apr type

Parameters:
sockThe pool to use.
thesockThe socket to convert to.
contThe socket we are converting to an apr type.
Remarks:
If it is a true socket, it is best to call apr_os_sock_make() and provide APR with more information about the socket.

Create a socket from an existing descriptor and local and remote socket addresses.

Parameters:
apr_sockThe new socket that has been set up
os_sock_infoThe os representation of the socket handle and other characteristics of the socket
contThe pool to use
Remarks:
If you only know the descriptor/handle or if it isn't really a true socket, use apr_os_sock_put() instead.

Convert the proc mutex from os specific type to apr type

Parameters:
pmutexThe apr proc mutex we are converting to.
ospmutexThe os specific proc mutex to convert.
contThe pool to use if it is needed.

Put the imploded time in the APR format.

Parameters:
aprtimethe APR time format
ostimethe time to convert
contthe pool to use if necessary

Put the exploded time in the APR format.

Parameters:
aprtimethe APR time format
ostimethe time to convert
contthe pool to use if necessary

convert the shared memory from os specific type to apr type.

Parameters:
shmThe apr shm representation of osshm
osshmThe os specific shm identity
contThe pool to use if it is needed.
Remarks:
On fork()ed architectures, this is typically nothing more than the memory block mapped. On non-fork architectures, this is typically some internal handle to pass the mapping from process to process.
APR_DECLARE ( const char *  )

Get the name of the system default character set.

Parameters:
poolthe pool to allocate the name from, if needed

Get the name of the current locale character set.

Parameters:
poolthe pool to allocate the name from, if needed
Remarks:
Defers to apr_os_default_encoding if the current locale's data can't be retrieved on this system.

Variable Documentation

Definition at line 257 of file apr_portable.h.

Definition at line 342 of file apr_portable.h.

Definition at line 233 of file apr_portable.h.

Definition at line 225 of file apr_portable.h.

apr_os_file_t apr_int32_t flags

Definition at line 342 of file apr_portable.h.

Definition at line 405 of file apr_portable.h.

Definition at line 415 of file apr_portable.h.

Definition at line 448 of file apr_portable.h.

Definition at line 425 of file apr_portable.h.

Definition at line 213 of file apr_portable.h.

Definition at line 368 of file apr_portable.h.

Definition at line 273 of file apr_portable.h.

Definition at line 241 of file apr_portable.h.

Definition at line 379 of file apr_portable.h.

Definition at line 342 of file apr_portable.h.

Definition at line 391 of file apr_portable.h.