summaryrefslogtreecommitdiff
path: root/include/sockets.h
blob: 1bcafd79fcbd849fb6b9ce296d7ef95a80dfadc7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
/*                                               
 *
 * (C) 2003-2010 Anope Team
 * Contact us at team@anope.org
 *
 * Please read COPYING and README for furhter details.
 *
 * Based on the original code of Epona by Lara.
 * Based on the original code of Services by Andy Church.
 */

#ifndef SOCKETS_H
#define SOCKETS_H

#define NET_BUFSIZE 65535

#ifdef _WIN32
# define CloseSocket closesocket
#else
# define CloseSocket close
#endif

class SocketException : public CoreException
{
 public:
	/** Default constructor for socket exceptions
	 * @param message Error message
	 */
	SocketException(const std::string &message) : CoreException(message) { }

	/** Default destructor
	 * @throws Nothing
	 */
	virtual ~SocketException() throw() { }
};

enum SocketType
{
	SOCKTYPE_CLIENT,
	SOCKTYPE_LISTEN
};

enum SocketFlag
{
	SF_DEAD
};

class CoreExport Socket : public Flags<SocketFlag, 1>
{
 private:
	/** Really recieve something from the buffer
	 * @param buf The buf to read to
	 * @param sz How much to read
	 * @return Number of bytes recieved
	 */
	virtual const int RecvInternal(char *buf, size_t sz) const;

	/** Really write something to the socket
	 * @param buf What to write
	 * @return Number of bytes written
	 */
	virtual const int SendInternal(const std::string &buf) const;

 protected:
 	/* Socket FD */
	int sock;
	/* IPv6? */
	bool IPv6;
	/* Things to be written to the socket */
	std::string WriteBuffer;
	/* Part of a message sent from the server, but not totally recieved */
	std::string extrabuf;
	/* How much data was received from this socket */
	size_t RecvLen;

 public:
	/* Type this socket is */
	SocketType Type;

	/** Default constructor
	 * @param nsock The socket to use, 0 if we need to create our own
	 * @param nIPv6 true if using ipv6
	 */
 	Socket(int nsock, bool nIPv6);
	
	/** Default destructor
	 */
	virtual ~Socket();

	/** Get the socket FD for this socket
	 * @return the fd
	 */
	int GetSock() const;

	/** Mark a socket as blockig
	 * @return true if the socket is now blocking
	 */
	bool SetBlocking();

	/** Mark a socket as non-blocking
	 * @return true if the socket is now non-blocking
	 */
	bool SetNonBlocking();

	/** Check if this socket is IPv6
	 * @return true or false
	 */
	bool IsIPv6() const;

	/** Get the length of the read buffer
	 * @return The length of the read buffer
	 */
	size_t ReadBufferLen() const;

	/** Get the length of the write buffer
	 * @return The length of the write buffer
	 */
	size_t WriteBufferLen() const;

	/** Called when there is something to be recieved for this socket
	 * @return true on success, false to drop this socket
	 */
	virtual bool ProcessRead();

	/** Called when there is something to be written to this socket
	 * @return true on success, false to drop this socket
	 */
	virtual bool ProcessWrite();

	/** Called when there is an error for this socket
	 * @return true on success, false to drop this socket
	 */
	virtual void ProcessError();

	/** Called with a line recieved from the socket
	 * @param buf The line
	 * @return true to continue reading, false to drop the socket
	 */
	virtual bool Read(const std::string &buf);

	/** Write to the socket
	 * @param message The message
	 */
	void Write(const char *message, ...);
	void Write(const std::string &message);
};

class CoreExport ClientSocket : public Socket
{
 protected:
	/* Target host we're connected to */
	std::string TargetHost;
	/* Target port we're connected to */
	int Port;
	/* The host to bind to */
	std::string BindHost;

 public:

       /** Constructor
	* @param nTargetHost The target host to connect to
	* @param nPort The target port to connect to
	* @param nBindHost The host to bind to for connecting
	* @param nIPv6 true to use IPv6
	*/
       ClientSocket(const std::string &nTargetHost, int nPort, const std::string &nBindHost, bool nIPv6);

       /** Default destructor
	*/
       virtual ~ClientSocket();

      /** Called with a line recieved from the socket
	* @param buf The line
	* @return true to continue reading, false to drop the socket
	*/
	virtual bool Read(const std::string &buf);
};

class CoreExport ListenSocket : public Socket
{
 protected:
	/* Bind IP */
	std::string BindIP;
	/* Port to bind to */
	int Port;

 public:
	/** Constructor
	 * @param bind The IP to bind to
	 * @param port The port to listen on
	 */
	ListenSocket(const std::string &bind, int port);

	/** Destructor
	 */
	virtual ~ListenSocket();

	/** Process what has come in from the connection
	 * @return false to destory this socket
	 */
	bool ProcessRead();

	/** Called when a connection is accepted
	 * @param s The socket for the new connection
	 * @return true if the listen socket should remain alive
	 */
	virtual bool OnAccept(Socket *s);

	/** Get the bind IP for this socket
	 * @return the bind ip
	 */
	const std::string &GetBindIP() const;

	/** Get the port this socket is bound to
	 * @return The port
	*/
	const int GetPort() const;
};

#endif // SOCKET_H