Apache Portable Runtime
apr_support.h
Go to the documentation of this file.
00001 /* Licensed to the Apache Software Foundation (ASF) under one or more
00002  * contributor license agreements.  See the NOTICE file distributed with
00003  * this work for additional information regarding copyright ownership.
00004  * The ASF licenses this file to You under the Apache License, Version 2.0
00005  * (the "License"); you may not use this file except in compliance with
00006  * the License.  You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef APR_SUPPORT_H
00018 #define APR_SUPPORT_H
00019 
00020 /**
00021  * @file apr_support.h
00022  * @brief APR Support functions
00023  */
00024 
00025 #include "apr.h"
00026 #include "apr_network_io.h"
00027 #include "apr_file_io.h"
00028 
00029 #ifdef __cplusplus
00030 extern "C" {
00031 #endif /* __cplusplus */
00032 
00033 /**
00034  * @defgroup apr_support Internal APR support functions
00035  * @ingroup APR 
00036  * @{
00037  */
00038 
00039 /**
00040  * Wait for IO to occur or timeout.
00041  *
00042  * @param f The file to wait on.
00043  * @param s The socket to wait on if @a f is @c NULL.
00044  * @param for_read If non-zero wait for data to be available to read,
00045  *        otherwise wait for data to be able to be written. 
00046  * @return APR_TIMEUP if we run out of time.
00047  */
00048 apr_status_t apr_wait_for_io_or_timeout(apr_file_t *f, apr_socket_t *s,
00049                                         int for_read);
00050 
00051 /** @} */
00052 
00053 #ifdef __cplusplus
00054 }
00055 #endif
00056 
00057 #endif  /* ! APR_SUPPORT_H */
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines