X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7523de907dd77eedd33431d5ff46478a467faf5f..632c86a3e6a8e5e7e16617a53b1419d394cedb30:/include/wx/private/fdiodispatcher.h?ds=sidebyside diff --git a/include/wx/private/fdiodispatcher.h b/include/wx/private/fdiodispatcher.h index 52e8efba7b..0b85505cc0 100644 --- a/include/wx/private/fdiodispatcher.h +++ b/include/wx/private/fdiodispatcher.h @@ -4,7 +4,6 @@ // Authors: Lukasz Michalski // Created: December 2006 // Copyright: (c) Lukasz Michalski -// RCS-ID: $Id$ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -12,23 +11,7 @@ #define _WX_PRIVATE_FDIODISPATCHER_H_ #include "wx/hashmap.h" - -// handler used to process events on descriptors -class wxFDIOHandler -{ -public: - // called when descriptor is available for non-blocking read - virtual void OnReadWaiting() = 0; - - // called when descriptor is available for non-blocking write - virtual void OnWriteWaiting() = 0; - - // called when there is exception on descriptor - virtual void OnExceptionWaiting() = 0; - - // virtual dtor for the base class - virtual ~wxFDIOHandler() { } -}; +#include "wx/private/fdiohandler.h" // those flags describes sets where descriptor should be added enum wxFDIODispatcherEntryFlags @@ -45,6 +28,18 @@ class WXDLLIMPEXP_BASE wxFDIODispatcher public: enum { TIMEOUT_INFINITE = -1 }; + // return the global dispatcher to be used for IO events, can be NULL only + // if wxSelectDispatcher wasn't compiled into the library at all as + // creating it never fails + // + // don't delete the returned pointer + static wxFDIODispatcher *Get(); + + // if we have any registered handlers, check for any pending events to them + // and dispatch them -- this is used from wxX11 and wxDFB event loops + // implementation + static void DispatchPending(); + // register handler for the given descriptor with the dispatcher, return // true on success or false on error virtual bool RegisterFD(int fd, wxFDIOHandler *handler, int flags) = 0; @@ -55,8 +50,13 @@ public: // unregister descriptor previously registered with RegisterFD() virtual bool UnregisterFD(int fd) = 0; - // wait for an event for at most timeout milliseconds and process it - virtual void Dispatch(int timeout = TIMEOUT_INFINITE) = 0; + // check if any events are currently available without dispatching them + virtual bool HasPending() const = 0; + + // wait for an event for at most timeout milliseconds and process it; + // return the number of events processed (possibly 0 if timeout expired) or + // -1 if an error occurred + virtual int Dispatch(int timeout = TIMEOUT_INFINITE) = 0; virtual ~wxFDIODispatcher() { } };