Added file apr_poll.inc

git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@18 8e941d3f-bd1b-0410-a28a-d453659cc2b4
This commit is contained in:
sekelsenmat
2006-09-28 11:44:26 +00:00
parent 975bcb7659
commit fa2df4341f

View File

@ -0,0 +1,193 @@
{ Copyright 2000-2005 The Apache Software Foundation or its licensors, as
* applicable.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
}
{
* @file apr_poll.h
* @brief APR Poll interface
}
{#include "apr.h"
#include "apr_pools.h"
#include "apr_errno.h"
#include "apr_inherit.h"
#include "apr_file_io.h"
#include "apr_network_io.h"
#if APR_HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif}
{
* @defgroup apr_poll Poll Routines
* @ingroup APR
}
{
* Poll options
}
const
APR_POLLIN = $001; {< Can read without blocking }
APR_POLLPRI = $002; {< Priority data available }
APR_POLLOUT = $004; {< Can write without blocking }
APR_POLLERR = $010; {< Pending error }
APR_POLLHUP = $020; {< Hangup occurred }
APR_POLLNVAL = $040; {< Descriptior invalid }
{
* Pollset Flags
}
APR_POLLSET_THREADSAFE = $001; {< Adding or Removing a Descriptor is thread safe }
{ Used in apr_pollfd_t to determine what the apr_descriptor is }
type
apr_datatype_e = (
APR_NO_DESC, {< nothing here }
APR_POLL_SOCKET, {< descriptor refers to a socket }
APR_POLL_FILE, {< descriptor refers to a file }
APR_POLL_LASTDESC {< descriptor is the last one in the list }
);
{ Union of either an APR file or socket. }
apr_descriptor = record
case Integer of
1: (f: Papr_file_t); {< file }
2: (s: Papr_socket_t); {< socket }
end;
{ @see apr_pollfd_t }
Papr_pollfd_t = ^apr_pollfd_t;
PPapr_pollfd_t = ^Papr_pollfd_t;
{ Poll descriptor set. }
apr_pollfd_t = record
p: Papr_pool_t; {< associated pool }
desc_type: apr_datatype_e; {< descriptor type }
reqevents: apr_int16_t; {< requested events }
rtnevents: apr_int16_t; {< returned events }
desc: apr_descriptor; {< @see apr_descriptor }
client_data: Pointer; {< allows app to associate context }
end;
{ General-purpose poll API for arbitrarily large numbers of
* file descriptors
}
{ Opaque structure used for pollset API }
type
apr_pollset_t = record end;
Papr_pollset_t = ^apr_pollset_t;
PPapr_pollset_t = ^Papr_pollset_t;
{
* Setup a pollset object
* @param pollset The pointer in which to return the newly created object
* @param size The maximum number of descriptors that this pollset can hold
* @param p The pool from which to allocate the pollset
* @param flags Optional flags to modify the operation of the pollset.
*
* @remark If flags equals APR_POLLSET_THREADSAFE, then a pollset is
* created on which it is safe to make concurrent calls to
* apr_pollset_add(), apr_pollset_remove() and apr_pollset_poll() from
* separate threads. This feature is only supported on some
* platforms; the apr_pollset_create() call will fail with
* APR_ENOTIMPL on platforms where it is not supported.
}
function apr_pollset_create(pollset: PPapr_pollset_t; size: apr_uint32_tso_handle_t;
p: Papr_pool_t; flags: apr_uint32_t): apr_status_t;
{$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
external LibAPR name LibNamePrefix + 'apr_pollset_create' + LibSuff16;
{
* Destroy a pollset object
* @param pollset The pollset to destroy
}
function apr_pollset_destroy(pollset: Papr_pollset_t): apr_status_t;
{$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
external LibAPR name LibNamePrefix + 'apr_pollset_destroy' + LibSuff4;
{
* Add a socket or file descriptor to a pollset
* @param pollset The pollset to which to add the descriptor
* @param descriptor The descriptor to add
* @remark If you set client_data in the descriptor, that value
* will be returned in the client_data field whenever this
* descriptor is signalled in apr_pollset_poll().
* @remark If the pollset has been created with APR_POLLSET_THREADSAFE
* and thread T1 is blocked in a call to apr_pollset_poll() for
* this same pollset that is being modified via apr_pollset_add()
* in thread T2, the currently executing apr_pollset_poll() call in
* T1 will either: (1) automatically include the newly added descriptor
* in the set of descriptors it is watching or (2) return immediately
* with APR_EINTR. Option (1) is recommended, but option (2) is
* allowed for implementations where option (1) is impossible
* or impractical.
}
function apr_pollset_add(pollset: Papr_pollset_t;
const descriptor: Papr_pollfd_t): apr_status_t;
{$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
external LibAPR name LibNamePrefix + 'apr_pollset_add' + LibSuff8;
{
* Remove a descriptor from a pollset
* @param pollset The pollset from which to remove the descriptor
* @param descriptor The descriptor to remove
* @remark If the pollset has been created with APR_POLLSET_THREADSAFE
* and thread T1 is blocked in a call to apr_pollset_poll() for
* this same pollset that is being modified via apr_pollset_remove()
* in thread T2, the currently executing apr_pollset_poll() call in
* T1 will either: (1) automatically exclude the newly added descriptor
* in the set of descriptors it is watching or (2) return immediately
* with APR_EINTR. Option (1) is recommended, but option (2) is
* allowed for implementations where option (1) is impossible
* or impractical.
}
function apr_pollset_remove(pollset: Papr_pollset_t;
const descriptor: Papr_pollfd_t): apr_status_t;
{$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
external LibAPR name LibNamePrefix + 'apr_pollset_remove' + LibSuff8;
{
* Block for activity on the descriptor(s) in a pollset
* @param pollset The pollset to use
* @param timeout Timeout in microseconds
* @param num Number of signalled descriptors (output parameter)
* @param descriptors Array of signalled descriptors (output parameter)
}
function apr_pollset_poll(pollset: Papr_pollset_t; timeout: apr_interval_time_t;
num: Papr_int32_t; const descriptors: PPapr_pollfd_t): apr_status_t;
{$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
external LibAPR name LibNamePrefix + 'apr_pollset_poll' + LibSuff16;
{
* Poll the descriptors in the poll structure
* @param aprset The poll structure we will be using.
* @param numsock The number of descriptors we are polling
* @param nsds The number of descriptors signalled.
* @param timeout The amount of time in microseconds to wait. This is
* a maximum, not a minimum. If a descriptor is signalled, we
* will wake up before this time. A negative number means
* wait until a descriptor is signalled.
* @remark The number of descriptors signalled is returned in the third argument.
* This is a blocking call, and it will not return until either a
* descriptor has been signalled, or the timeout has expired.
* @remark The rtnevents field in the apr_pollfd_t array will only be filled-
* in if the return value is APR_SUCCESS.
}
function apr_poll(aprset: Papr_pollfd_t; numsock: apr_int32_t;
nsds: Papr_int32_t; timeout: apr_interval_time_t): apr_status_t;
{$IFDEF WINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
external LibAPR name LibNamePrefix + 'apr_poll' + LibSuff16;