diff options
author | Attila Molnar <attilamolnar@hush.com> | 2015-04-12 16:20:13 +0200 |
---|---|---|
committer | Attila Molnar <attilamolnar@hush.com> | 2015-04-12 16:20:13 +0200 |
commit | 612384b3d46d06eea6fd71ee6dc60471d0f9e3d1 (patch) | |
tree | f9926b5ca8841a30c3a16916116a7d4102e91c31 /include | |
parent | e3303330f8cc04121907715d789370f492878646 (diff) |
Dispatch EventHandler events to dedicated virtual functions
Remove enum EventType
Diffstat (limited to 'include')
-rw-r--r-- | include/inspsocket.h | 25 | ||||
-rw-r--r-- | include/socket.h | 7 | ||||
-rw-r--r-- | include/socketengine.h | 39 |
3 files changed, 35 insertions, 36 deletions
diff --git a/include/inspsocket.h b/include/inspsocket.h index 1bcfbea09..8c93f884e 100644 --- a/include/inspsocket.h +++ b/include/inspsocket.h @@ -113,6 +113,12 @@ class CoreExport StreamSocket : public EventHandler size_t sendq_len; /** Error - if nonempty, the socket is dead, and this is the reason. */ std::string error; + + /** Check if the socket has an error set, if yes, call OnError + * @param err Error to pass to OnError() + */ + void CheckError(BufferedSocketError err); + protected: std::string recvq; public: @@ -120,15 +126,24 @@ class CoreExport StreamSocket : public EventHandler IOHook* GetIOHook() const; void AddIOHook(IOHook* hook); void DelIOHook(); - /** Handle event from socket engine. - * This will call OnDataReady if there is *new* data in recvq - */ - virtual void HandleEvent(EventType et, int errornum = 0); /** Dispatched from HandleEvent */ virtual void DoRead(); /** Dispatched from HandleEvent */ virtual void DoWrite(); + /** Called by the socket engine on a read event + */ + void OnEventHandlerRead() CXX11_OVERRIDE; + + /** Called by the socket engine on a write event + */ + void OnEventHandlerWrite() CXX11_OVERRIDE; + + /** Called by the socket engine on error + * @param errcode Error + */ + void OnEventHandlerError(int errcode) CXX11_OVERRIDE; + /** Sets the error message for this socket. Once set, the socket is dead. */ void SetError(const std::string& err) { if (error.empty()) error = err; } @@ -226,7 +241,7 @@ class CoreExport BufferedSocket : public StreamSocket virtual ~BufferedSocket(); protected: - virtual void DoWrite(); + void OnEventHandlerWrite() CXX11_OVERRIDE; BufferedSocketError BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned long timeout); BufferedSocketError BeginConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip); }; diff --git a/include/socket.h b/include/socket.h index c292b7010..9d69b5d22 100644 --- a/include/socket.h +++ b/include/socket.h @@ -150,16 +150,13 @@ class CoreExport ListenSocket : public EventHandler /** Create a new listening socket */ ListenSocket(ConfigTag* tag, const irc::sockets::sockaddrs& bind_to); - /** Handle an I/O event - */ - void HandleEvent(EventType et, int errornum = 0); /** Close the socket */ ~ListenSocket(); - /** Handles sockets internals crap of a connection, convenience wrapper really + /** Handles new connections, called by the socket engine */ - void AcceptInternal(); + void OnEventHandlerRead() CXX11_OVERRIDE; /** Inspects the bind block belonging to this socket to set the name of the IO hook * provider which this socket will use for incoming connections. diff --git a/include/socketengine.h b/include/socketengine.h index f30289913..ddc48f94d 100644 --- a/include/socketengine.h +++ b/include/socketengine.h @@ -37,23 +37,6 @@ #define IOV_MAX 1024 #endif -/** Types of event an EventHandler may receive. - * EVENT_READ is a readable file descriptor, - * and EVENT_WRITE is a writeable file descriptor. - * EVENT_ERROR can always occur, and indicates - * a write error or read error on the socket, - * e.g. EOF condition or broken pipe. - */ -enum EventType -{ - /** Read event */ - EVENT_READ = 0, - /** Write event */ - EVENT_WRITE = 1, - /** Error event */ - EVENT_ERROR = 2 -}; - /** * Event mask for SocketEngine events */ @@ -207,16 +190,20 @@ class CoreExport EventHandler : public classbase */ virtual ~EventHandler() {} - /** Process an I/O event. - * You MUST implement this function in your derived - * class, and it will be called whenever read or write - * events are received. - * @param et either one of EVENT_READ for read events, - * EVENT_WRITE for write events and EVENT_ERROR for - * error events. - * @param errornum The error code which goes with an EVENT_ERROR. + /** Called by the socket engine in case of a read event + */ + virtual void OnEventHandlerRead() = 0; + + /** Called by the socket engine in case of a write event. + * The default implementation does nothing. + */ + virtual void OnEventHandlerWrite(); + + /** Called by the socket engine in case of an error event. + * The default implementation does nothing. + * @param errornum Error code */ - virtual void HandleEvent(EventType et, int errornum = 0) = 0; + virtual void OnEventHandlerError(int errornum); friend class SocketEngine; }; |