File indexing completed on 2024-04-28 15:53:59

0001 # AUTO-GENERATED FILE -- DO NOT EDIT
0002 
0003 """ This module supports asynchronous I/O on multiple file descriptors.
0004 
0005 *** IMPORTANT NOTICE ***
0006 On Windows and OpenVMS, only sockets are supported; on Unix, all file descriptors. """
0007 
0008 EPOLLERR = 8
0009 EPOLLET = -2147483648
0010 EPOLLHUP = 16
0011 EPOLLIN = 1
0012 EPOLLMSG = 1024
0013 EPOLLONESHOT = 1073741824
0014 EPOLLOUT = 4
0015 EPOLLPRI = 2
0016 EPOLLRDBAND = 128
0017 EPOLLRDNORM = 64
0018 EPOLLWRBAND = 512
0019 EPOLLWRNORM = 256
0020 PIPE_BUF = 4096
0021 POLLERR = 8
0022 POLLHUP = 16
0023 POLLIN = 1
0024 POLLMSG = 1024
0025 POLLNVAL = 32
0026 POLLOUT = 4
0027 POLLPRI = 2
0028 POLLRDBAND = 128
0029 POLLRDNORM = 64
0030 POLLWRBAND = 512
0031 POLLWRNORM = 256
0032 __package__ = None
0033 
0034 class epoll(object):
0035   """ select.epoll([sizehint=-1])
0036   
0037   Returns an epolling object
0038   
0039   sizehint must be a positive integer or -1 for the default size. The
0040   sizehint is used to optimize internal data structures. It doesn't limit
0041   the maximum number of monitored events. """
0042 
0043   def close(self):
0044     """ close() -> None
0045     
0046     Close the epoll control file descriptor. Further operations on the epoll
0047     object will raise an exception. """
0048     return None
0049 
0050   closed = property(None, None, None,
0051                     """ True if the epoll handler is closed """
0052                     )
0053 
0054 
0055   def fileno(self):
0056     """ fileno() -> int
0057     
0058     Return the epoll control file descriptor. """
0059     return 1
0060 
0061   def fromfd(self, fd):
0062     """ fromfd(fd) -> epoll
0063     
0064     Create an epoll object from a given control fd. """
0065     return None
0066 
0067   def modify(self, fd, eventmask):
0068     """ modify(fd, eventmask) -> None
0069     
0070     fd is the target file descriptor of the operation
0071     events is a bit set composed of the various EPOLL constants """
0072     return None
0073 
0074   def poll(self, timeout=_1, maxevents=_1):
0075     """ poll([timeout=-1[, maxevents=-1]]) -> [(fd, events), (...)]
0076     
0077     Wait for events on the epoll file descriptor for a maximum time of timeout
0078     in seconds (as float). -1 makes poll wait indefinitely.
0079     Up to maxevents are returned to the caller. """
0080     return []
0081 
0082   def register(self, fd, eventmask=None):
0083     """ register(fd[, eventmask]) -> None
0084     
0085     Registers a new fd or modifies an already registered fd.
0086     fd is the target file descriptor of the operation.
0087     events is a bit set composed of the various EPOLL constants; the default
0088     is EPOLL_IN | EPOLL_OUT | EPOLL_PRI.
0089     
0090     The epoll interface supports all file descriptors that support poll. """
0091     return None
0092 
0093   def unregister(self, fd):
0094     """ unregister(fd) -> None
0095     
0096     fd is the target file descriptor of the operation. """
0097     return None
0098 
0099 class error(Exception):
0100 
0101   pass
0102 
0103 def poll():
0104   """ Returns a polling object, which supports registering and
0105   unregistering file descriptors, and then polling them for I/O events. """
0106   pass
0107 
0108 def select(rlist, wlist, xlist, timeout=None):
0109   """ select(rlist, wlist, xlist[, timeout]) -> (rlist, wlist, xlist)
0110   
0111   Wait until one or more file descriptors are ready for some kind of I/O.
0112   The first three arguments are sequences of file descriptors to be waited for:
0113   rlist -- wait until ready for reading
0114   wlist -- wait until ready for writing
0115   xlist -- wait for an ``exceptional condition''
0116   If only one kind of condition is required, pass [] for the other lists.
0117   A file descriptor is either a socket or file object, or a small integer
0118   gotten from a fileno() method call on one of those.
0119   
0120   The optional 4th argument specifies a timeout in seconds; it may be
0121   a floating point number to specify fractions of seconds.  If it is absent
0122   or None, the call will never time out.
0123   
0124   The return value is a tuple of three lists corresponding to the first three
0125   arguments; each contains the subset of the corresponding file descriptors
0126   that are ready.
0127   
0128   *** IMPORTANT NOTICE ***
0129   On Windows and OpenVMS, only sockets are supported; on Unix, all file
0130   descriptors can be used. """
0131   return ([], [], [])
0132