Apache Portable Runtime
apr_support.h
Go to the documentation of this file.
1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2  * contributor license agreements. See the NOTICE file distributed with
3  * this work for additional information regarding copyright ownership.
4  * The ASF licenses this file to You under the Apache License, Version 2.0
5  * (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef APR_SUPPORT_H
18 #define APR_SUPPORT_H
19 
20 /**
21  * @file apr_support.h
22  * @brief APR Support functions
23  */
24 
25 #include "apr.h"
26 #include "apr_network_io.h"
27 #include "apr_file_io.h"
28 #include "apr_private.h"
29 
30 #if HAVE_VALGRIND
31 #include <valgrind.h>
32 #include <memcheck.h>
33 
34 extern int apr_running_on_valgrind;
35 
36 #define APR_IF_VALGRIND(x) \
37  do { if (apr_running_on_valgrind) { x; } } while (0)
38 
39 #else
40 #define APR_IF_VALGRIND(x)
41 #endif /* HAVE_VALGRIND */
42 
43 #define APR_VALGRIND_NOACCESS(addr_, size_) \
44  APR_IF_VALGRIND(VALGRIND_MAKE_MEM_NOACCESS(addr_, size_))
45 #define APR_VALGRIND_UNDEFINED(addr_, size_) \
46  APR_IF_VALGRIND(VALGRIND_MAKE_MEM_UNDEFINED(addr_, size_))
47 
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif /* __cplusplus */
52 
53 /**
54  * @defgroup apr_support Internal APR support functions
55  * @ingroup APR
56  * @{
57  */
58 
59 /**
60  * Wait for IO to occur or timeout.
61  *
62  * @param f The file to wait on.
63  * @param s The socket to wait on if @a f is @c NULL.
64  * @param for_read If non-zero wait for data to be available to read,
65  * otherwise wait for data to be able to be written.
66  * @return APR_TIMEUP if we run out of time.
67  */
69  int for_read);
70 
71 /** @} */
72 
73 #ifdef __cplusplus
74 }
75 #endif
76 
77 #endif /* ! APR_SUPPORT_H */
struct apr_socket_t apr_socket_t
Definition: apr_network_io.h:246
APR Network library.
APR File I/O Handling.
apr_status_t apr_wait_for_io_or_timeout(apr_file_t *f, apr_socket_t *s, int for_read)
struct apr_file_t apr_file_t
Definition: apr_file_io.h:216
APR Platform Definitions.
int apr_status_t
Definition: apr_errno.h:44