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
|
/*******************************************************************************
* shroudBNC - an object-oriented framework for IRC *
* Copyright (C) 2005-2014 Gunnar Beutner *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License *
* as published by the Free Software Foundation; either version 2 *
* of the License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the Free Software *
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
*******************************************************************************/
#ifndef SOCKETEVENTS_H
#define SOCKETEVENTS_H
/**
* CSocketEvents
*
* An interface for socket events.
*/
struct SBNCAPI CSocketEvents {
public:
/**
* ~CSocketEvents
*
* Destructor.
*/
virtual ~CSocketEvents(void) {}
/**
* Destroy
*
* Used for destroying the object and the underlying object.
*/
virtual void Destroy(void) = 0;
/**
* Read
*
* Called when the socket is ready for reading.
*
* @param DontProcess determines whether the function should
* process the data
*/
virtual int Read(bool DontProcess = false) = 0;
/**
* Write
*
* Called when the socket is ready for writing.
*/
virtual int Write(void) = 0;
/**
* Error
*
* Called when an error occured on the socket.
*
* @param ErrorCode the error code (errno or winsock error code)
*/
virtual void Error(int ErrorCode) = 0;
/**
* HasQueuedData
*
* Called to determine whether the object wants to write
* data for the socket.
*/
virtual bool HasQueuedData(void) const = 0;
/**
* ShouldDestroy
*
* Called to determine whether the event object should be destroyed.
*/
virtual bool ShouldDestroy(void) const = 0;
/**
* GetClassName
*
* Called to get the class' name.
*/
virtual const char *GetClassName(void) const = 0;
};
#endif /* SOCKETEVENTS_H */
|