X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspsocket.h;h=f945c4f9ddba6a40e739ff95da7fcc7b24482a51;hb=7a7fb7167c0e96509523c378e776cf38418cd4e5;hp=77c283f7fcb9109f9fe9333089593a62aadbf521;hpb=f1271614679843191bb247c0db2716acb5ac0e4b;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspsocket.h b/include/inspsocket.h index 77c283f7f..f945c4f9d 100644 --- a/include/inspsocket.h +++ b/include/inspsocket.h @@ -27,8 +27,6 @@ enum BufferedSocketState I_CONNECTING, /** Socket fully connected */ I_CONNECTED, - /** Socket listening for connections */ - I_LISTENING, /** Socket has an error */ I_ERROR }; @@ -106,44 +104,31 @@ class CoreExport BufferedSocket : public EventHandler { public: - /** - * Bind IP + /** Bind IP */ std::string cbindip; - /** - * Is hooked by a module for low level IO - */ - bool IsIOHooked; - - /** - * Instance we were created by + /** Instance we were created by */ InspIRCd* Instance; - /** - * Timeout class or NULL + /** Timeout class or NULL */ SocketTimeout* Timeout; - /** - * Timeout length + /** Timeout length */ unsigned long timeout_val; - /** - * Socket output buffer (binary safe) + /** Socket output buffer (binary safe) */ std::deque outbuffer; - /** - * The hostname connected to + /** The hostname connected to */ char host[MAXBUF]; - /** - * The port connected to, or the port - * this socket is listening on + /** The port connected to */ int port; @@ -154,21 +139,6 @@ class CoreExport BufferedSocket : public EventHandler */ BufferedSocketState state; - /** - * This value is true if the - * socket has timed out. - */ - bool timeout; - - /** - * Socket input buffer, used by read(). The class which - * extends BufferedSocket is expected to implement an extendable - * buffer which can grow much larger than 64k, - * this buffer is just designed to be temporary storage. - * space. - */ - char ibuf[65535]; - /** * The IP address being connected * to stored in string form for @@ -183,6 +153,7 @@ class CoreExport BufferedSocket : public EventHandler socklen_t length; /** Flushes the write buffer + * @returns true if the writing failed, false if it was successful */ bool FlushWriteBuffer(); @@ -200,12 +171,6 @@ class CoreExport BufferedSocket : public EventHandler */ bool ClosePending; - /** Set to true when we're waiting for a write event. - * If this is true and a write event comes in, we - * call the write instead of the read method. - */ - bool WaitingForWriteEvent; - /** * Bind to an address * @param ip IP to bind to @@ -230,19 +195,17 @@ class CoreExport BufferedSocket : public EventHandler BufferedSocket(InspIRCd* SI, int newfd, const char* ip); /** - * This constructor is used to create a new - * socket, either listening for connections, or an outbound connection to another host. + * This constructor is used to create a new outbound connection to another host. * Note that if you specify a hostname in the 'ipaddr' parameter, this class will not * connect. You must resolve your hostnames before passing them to BufferedSocket. To do so, * you should use the nonblocking class 'Resolver'. * @param ipaddr The IP to connect to, or bind to - * @param port The port number to connect to, or bind to - * @param listening true to listen on the given host:port pair, or false to connect to them + * @param port The port number to connect to * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated * @param connectbindip When creating an outbound connection, the IP to bind the connection to. If not defined, the port is not bound. * @return On exit, GetState() returns I_ERROR if an error occured, and errno can be used to read the socket error. */ - BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime, const std::string &connectbindip = ""); + BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, unsigned long maxtime, const std::string &connectbindip = ""); /** * This method is called when an outbound @@ -282,13 +245,23 @@ class CoreExport BufferedSocket : public EventHandler /** * When it is ok to write to the socket, and a * write event was requested, this method is - * triggered. Within this method you should call + * triggered. + * + * Within this method you should call * write() or send() etc, to send data to the - * other end of the socket. Further write events - * will not be triggered unless you call WantWrite(). + * other end of the socket. + * + * Further write events will not be triggered + * unless you call WantWrite(). + * + * The default behaviour of this method is to + * flush the write buffer, respecting the IO + * hooking modules. + * + * XXX: this used to be virtual, ask us if you need it to be so. * @return false to close the socket */ - virtual bool OnWriteReady(); + bool OnWriteReady(); /** * When an outbound connection fails, and the @@ -307,9 +280,7 @@ class CoreExport BufferedSocket : public EventHandler * Whenever close() is called, OnClose() will be * called first. Please note that this means * OnClose will be called alongside OnError(), - * OnTimeout(), and Close(), and also when - * cancelling a listening socket by calling - * the destructor indirectly. + * OnTimeout(), and Close(). */ virtual void OnClose(); @@ -318,7 +289,7 @@ class CoreExport BufferedSocket : public EventHandler * into a char* array which can be up to * 16 kilobytes in length. */ - virtual char* Read(); + virtual const char* Read(); /** * Returns the IP address associated with @@ -332,22 +303,7 @@ class CoreExport BufferedSocket : public EventHandler * returns or linefeeds are appended to the string. * @param data The data to send */ - virtual int Write(const std::string &data); - - /** - * If your socket is a listening socket, when a new - * connection comes in on the socket this method will - * be called. Given the new file descriptor in the - * parameters, and the IP, it is recommended you copy - * them to a new instance of your socket class, - * e.g.: - * - * MySocket* newsocket = new MySocket(newfd,ip); - * - * Once you have done this, you can then associate the - * new socket with the core using Server::AddSocket(). - */ - virtual int OnIncomingConnection(int newfd, char* ip); + virtual void Write(const std::string &data); /** * Changes the socket's state. The core uses this @@ -378,13 +334,6 @@ class CoreExport BufferedSocket : public EventHandler */ bool Poll(); - /** - * This method returns the socket's file descriptor - * as assigned by the operating system, or -1 - * if no descriptor has been assigned. - */ - int GetFd(); - /** * This method causes the socket to close, and may * also be triggered by other methods such as OnTimeout @@ -401,22 +350,10 @@ class CoreExport BufferedSocket : public EventHandler /** * This method attempts to connect to a hostname. - * This only occurs on a non-listening socket. This - * method is asyncronous. + * This method is asyncronous. */ virtual bool DoConnect(); - /** - * This method marks the socket closed. - * The next time the core examines a socket marked - * as closed, the socket will be closed and the - * memory reclaimed. - * - * NOTE: This method is DEPRECIATED and will be - * ignored if called! - */ - void MarkAsClosed(); - /** Handle event from EventHandler parent class */ void HandleEvent(EventType et, int errornum = 0);