1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
17 #include "inspircd_config.h"
21 #include <sys/types.h>
22 #include <sys/socket.h>
24 #include <netinet/in.h>
32 #ifndef __CONNECTION_H__
33 #define __CONNECTION_H__
35 #define STATE_DISCONNECTED 0
36 #define STATE_CONNECTED 1
38 #define STATE_NOAUTH_INBOUND 3
39 #define STATE_NOAUTH_OUTBOUND 4
40 #define STATE_SERVICES 5
42 std::string CreateSum();
44 /** Each connection has one or more of these
45 * each represents ONE outbound connection to another ircd
46 * so each inbound has multiple outbounds. A listening socket
47 * that accepts server type connections is represented by one
48 * class serverrec. Class serverrec will instantiate several
49 * objects of type ircd_connector to represent each established
50 * connection, inbound or outbound. So, to determine all linked
51 * servers you must walk through all the serverrecs that the
52 * core defines, and in each one iterate through until you find
53 * connection(s) relating to the server you want information on.
54 * The core and module API provide functions for this.
56 class ircd_connector : public Extensible
59 /** Sockaddr of the outbound ip and port
63 /** File descriptor of the connection
69 std::string servername;
73 std::string description;
75 /** State. STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND
76 * STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTED
80 /** PRIVATE function to set the host address and port to connect to
82 bool SetHostAddress(char* host, int port);
84 /** This string holds the ircd's version response
88 /** SendQ of the outbound connector, does not have a limit
92 /** Write error of connection
94 std::string WriteError;
98 /** IRCD Buffer for input characters, holds as many lines as are
99 * pending - Note that the final line may not be complete and should
100 * only be read when there is a \n seperator.
102 std::string ircdbuffer;
105 /** When MakeOutboundConnection is called, these public members are
106 * filled with the details passed to the function, for future
111 /** When MakeOutboundConnection is called, these public members are
112 * filled with the details passed to the function, for future
117 /** Server names of servers that this server is linked to
118 * So for A->B->C, if this was the record for B it would contain A and C
119 * whilever both servers are connected to B.
121 std::vector<std::string> routes;
123 /** Constructor clears the sendq and initialises the fd to -1
127 /** Create an outbound connection to a listening socket
129 bool MakeOutboundConnection(char* newhost, int newport);
131 /** Return the servername on this established connection
133 std::string GetServerName();
135 /** Set the server name of this connection
137 void SetServerName(std::string serv);
139 /** Get the file descriptor associated with this connection
143 /** Set the file descriptor for this connection
145 void SetDescriptor(int fd);
147 /** Get the state flags for this connection
151 /** Set the state flags for this connection
153 void SetState(int state);
155 /** Get the ip address (not servername) associated with this connection
159 /** Get the server description of this connection
161 std::string GetDescription();
163 /** Set the server description of this connection
165 void SetDescription(std::string desc);
167 /** Get the port number being used for this connection
168 * If the connection is outbound this will be the remote port
169 * otherwise it will be the local port, so it can always be
170 * gautanteed as open at the address given in GetServerIP().
174 /** Set the port used by this connection
176 void SetServerPort(int p);
178 /** Set both the host and the port in one operation for this connection
180 bool SetHostAndPort(char* newhost, int newport);
182 /** Close the connection by calling close() on its file descriptor
183 * This function call updates no other data.
185 void CloseConnection();
187 /** This method adds text to the ircd connection's buffer
188 * This buffer's maximum size is one megabyte, the method returning false
189 * if the buffer is full.
191 bool AddBuffer(std::string a);
193 /** This method returns true if the buffer contains at least one
194 * carriage return character, e.g. one line can be read from the
195 * buffer successfully.
197 bool BufferIsComplete();
199 /** This method clears the server's buffer by setting it to an empty string.
203 /** This method retrieves the first string from the tail end of the
204 * buffer and advances the tail end of the buffer past the returned
205 * string, in a similar manner to strtok().
207 std::string GetBuffer();
209 /** This method sets the version string of the remote server
211 void SetVersionString(std::string newversion);
213 /** This method returns the version string of the remote server.
214 * If the server has no version string an empty string is returned.
216 std::string GetVersionString();
218 /** Adds data to the connection's sendQ to be flushed later
219 * Fails if there is an error pending on the connection.
221 bool AddWriteBuf(std::string data);
223 /** Flushes as much of the data from the buffer as possible,
224 * and advances the queue pointer to what is left.
226 bool FlushWriteBuf();
228 /** Sets the error string for this connection
230 void SetWriteError(std::string error);
232 /** Gets the error string for this connection
234 std::string GetWriteError();
236 /** Returns true if there is data to be written that hasn't been sent yet
238 bool HasBufferedOutput();
242 /** Please note: classes serverrec and userrec both inherit from class connection.
244 class connection : public Extensible
247 /** File descriptor of the connection
251 /** Hostname of connection. Not used if this is a serverrec
255 /** IP of connection.
259 /** Stats counter for bytes inbound
263 /** Stats counter for bytes outbound
267 /** Stats counter for commands inbound
271 /** Stats counter for commands outbound
275 /** True if server/user has authenticated, false if otherwise
280 * For a userrec, this is the port they connected to the network on.
281 * For a serverrec this is the current listening port of the serverrec object.
285 /** Used by userrec to indicate the registration status of the connection
289 /** Time the connection was last pinged
293 /** Time the connection was created, set in the constructor
297 /** Time that the connection last sent data, used to calculate idle time
301 /** Used by PING checks with clients
305 /** Default constructor