Class Poll
java.lang.Object
org.apache.tomcat.jni.Poll
Deprecated.
The scope of the APR/Native Library will be reduced in Tomcat
9.1.x / Tomcat Native 2.x and has been reduced in Tomcat
10.1.x / Tomcat Native 2.x onwards to only include those
components required to provide OpenSSL integration with the NIO
and NIO2 connectors.
Poll
- Author:
- Mladen Turk
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intDeprecated.nothing herestatic final intDeprecated.descriptor refers to a filestatic final intDeprecated.descriptor is the last one in the liststatic final intDeprecated.descriptor refers to a socketstatic final intDeprecated.Pending errorstatic final intDeprecated.Hangup occurredstatic final intDeprecated.Can read without blockingstatic final intDeprecated.Descriptor invalidstatic final intDeprecated.Can write without blockingstatic final intDeprecated.Priority data availablestatic final intDeprecated.Adding or Removing a Descriptor is thread safe -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic intadd(long pollset, long sock, int reqevents) Deprecated.Add a socket to a pollset with the default timeout.static intaddWithTimeout(long pollset, long sock, int reqevents, long timeout) Deprecated.Add a socket to a pollset with a specific timeout.static longcreate(int size, long p, int flags, long ttl) Deprecated.Setup a pollset object.static intdestroy(long pollset) Deprecated.Destroy a pollset objectstatic longgetTtl(long pollset) Deprecated.Get the socket time to live.static intinterrupt(long pollset) Deprecated.Make poll() return.static intmaintain(long pollset, long[] descriptors, boolean remove) Deprecated.Maintain on the descriptor(s) in a pollsetstatic intpoll(long pollset, long timeout, long[] descriptors, boolean remove) Deprecated.Block for activity on the descriptor(s) in a pollsetstatic intpollset(long pollset, long[] descriptors) Deprecated.Return all descriptor(s) in a pollsetstatic intremove(long pollset, long sock) Deprecated.Remove a descriptor from a pollsetstatic voidsetTtl(long pollset, long ttl) Deprecated.Set the socket time to live.static booleanwakeable(long pollset) Deprecated.Check if interrupt() is allowed.
-
Field Details
-
APR_POLLIN
public static final int APR_POLLINDeprecated.Can read without blocking- See Also:
-
APR_POLLPRI
public static final int APR_POLLPRIDeprecated.Priority data available- See Also:
-
APR_POLLOUT
public static final int APR_POLLOUTDeprecated.Can write without blocking- See Also:
-
APR_POLLERR
public static final int APR_POLLERRDeprecated.Pending error- See Also:
-
APR_POLLHUP
public static final int APR_POLLHUPDeprecated.Hangup occurred- See Also:
-
APR_POLLNVAL
public static final int APR_POLLNVALDeprecated.Descriptor invalid- See Also:
-
APR_POLLSET_THREADSAFE
public static final int APR_POLLSET_THREADSAFEDeprecated.Adding or Removing a Descriptor is thread safe- See Also:
-
APR_NO_DESC
public static final int APR_NO_DESCDeprecated.nothing here- See Also:
-
APR_POLL_SOCKET
public static final int APR_POLL_SOCKETDeprecated.descriptor refers to a socket- See Also:
-
APR_POLL_FILE
public static final int APR_POLL_FILEDeprecated.descriptor refers to a file- See Also:
-
APR_POLL_LASTDESC
public static final int APR_POLL_LASTDESCDeprecated.descriptor is the last one in the list- See Also:
-
-
Constructor Details
-
Poll
public Poll()Deprecated.
-
-
Method Details
-
create
Deprecated.Setup a pollset object. 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.- Parameters:
size- The maximum number of descriptors that this pollset can holdp- The pool from which to allocate the pollsetflags- Optional flags to modify the operation of the pollset.ttl- Maximum time to live for a particular socket.- Returns:
- The pointer in which to return the newly created object
- Throws:
Error- Pollset creation failed
-
destroy
public static int destroy(long pollset) Deprecated.Destroy a pollset object- Parameters:
pollset- The pollset to destroy- Returns:
- the operation status
-
add
public static int add(long pollset, long sock, int reqevents) Deprecated.Add a socket to a pollset with the default timeout.- Parameters:
pollset- The pollset to which to add the socketsock- The sockets to addreqevents- requested events- Returns:
- the operation status
-
addWithTimeout
public static int addWithTimeout(long pollset, long sock, int reqevents, long timeout) Deprecated.Add a socket to a pollset with a specific timeout.- Parameters:
pollset- The pollset to which to add the socketsock- The sockets to addreqevents- requested eventstimeout- requested timeout in microseconds (-1 for infinite)- Returns:
- the operation status
-
remove
public static int remove(long pollset, long sock) Deprecated.Remove a descriptor from a pollset- Parameters:
pollset- The pollset from which to remove the descriptorsock- The socket to remove- Returns:
- the operation status
-
poll
public static int poll(long pollset, long timeout, long[] descriptors, boolean remove) Deprecated.Block for activity on the descriptor(s) in a pollset- Parameters:
pollset- The pollset to usetimeout- Timeout in microsecondsdescriptors- Array of signaled descriptors (output parameter) The descriptor array must be two times the size of pollset. and are populated as follows:descriptors[2n + 0] -> returned events descriptors[2n + 1] -> socket
remove- Remove signaled descriptors from pollset- Returns:
- Number of signaled descriptors (output parameter) or negative APR error code.
-
maintain
public static int maintain(long pollset, long[] descriptors, boolean remove) Deprecated.Maintain on the descriptor(s) in a pollset- Parameters:
pollset- The pollset to usedescriptors- Array of signaled descriptors (output parameter) The descriptor array must be the size of pollset. and are populated as follows:descriptors[n] -> socket
remove- Remove signaled descriptors from pollset- Returns:
- Number of signaled descriptors (output parameter) or negative APR error code.
-
setTtl
public static void setTtl(long pollset, long ttl) Deprecated.Set the socket time to live.- Parameters:
pollset- The pollset to usettl- Timeout in microseconds
-
getTtl
public static long getTtl(long pollset) Deprecated.Get the socket time to live.- Parameters:
pollset- The pollset to use- Returns:
- Timeout in microseconds
-
pollset
public static int pollset(long pollset, long[] descriptors) Deprecated.Return all descriptor(s) in a pollset- Parameters:
pollset- The pollset to usedescriptors- Array of descriptors (output parameter) The descriptor array must be two times the size of pollset. and are populated as follows:descriptors[2n + 0] -> returned events descriptors[2n + 1] -> socket
- Returns:
- Number of descriptors (output parameter) in the Poll or negative APR error code.
-
interrupt
public static int interrupt(long pollset) Deprecated.Make poll() return.- Parameters:
pollset- The pollset to use- Returns:
- Negative APR error code
-
wakeable
public static boolean wakeable(long pollset) Deprecated.Check if interrupt() is allowed.- Parameters:
pollset- The pollset to use- Returns:
trueifinterrupt(long)is allowed, elsefalse
-