| User | Revision | Line number | New contents of line |
|---|
| zoot661 |
0:f993b6d8b1d8
|
1
|
|
| zoot661 |
0:f993b6d8b1d8
|
2
|
/*
|
| zoot661 |
0:f993b6d8b1d8
|
3
|
Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
|
| zoot661 |
0:f993b6d8b1d8
|
4
|
|
| zoot661 |
0:f993b6d8b1d8
|
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
| zoot661 |
0:f993b6d8b1d8
|
6
|
of this software and associated documentation files (the "Software"), to deal
|
| zoot661 |
0:f993b6d8b1d8
|
7
|
in the Software without restriction, including without limitation the rights
|
| zoot661 |
0:f993b6d8b1d8
|
8
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| zoot661 |
0:f993b6d8b1d8
|
9
|
copies of the Software, and to permit persons to whom the Software is
|
| zoot661 |
0:f993b6d8b1d8
|
10
|
furnished to do so, subject to the following conditions:
|
| zoot661 |
0:f993b6d8b1d8
|
11
|
|
| zoot661 |
0:f993b6d8b1d8
|
12
|
The above copyright notice and this permission notice shall be included in
|
| zoot661 |
0:f993b6d8b1d8
|
13
|
all copies or substantial portions of the Software.
|
| zoot661 |
0:f993b6d8b1d8
|
14
|
|
| zoot661 |
0:f993b6d8b1d8
|
15
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| zoot661 |
0:f993b6d8b1d8
|
16
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| zoot661 |
0:f993b6d8b1d8
|
17
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| zoot661 |
0:f993b6d8b1d8
|
18
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| zoot661 |
0:f993b6d8b1d8
|
19
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| zoot661 |
0:f993b6d8b1d8
|
20
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
| zoot661 |
0:f993b6d8b1d8
|
21
|
THE SOFTWARE.
|
| zoot661 |
0:f993b6d8b1d8
|
22
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
23
|
|
| zoot661 |
0:f993b6d8b1d8
|
24
|
/** \file
|
| zoot661 |
0:f993b6d8b1d8
|
25
|
TCP Socket header file
|
| zoot661 |
0:f993b6d8b1d8
|
26
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
27
|
|
| zoot661 |
0:f993b6d8b1d8
|
28
|
#ifndef TCPSOCKET_H
|
| zoot661 |
0:f993b6d8b1d8
|
29
|
#define TCPSOCKET_H
|
| zoot661 |
0:f993b6d8b1d8
|
30
|
|
| zoot661 |
0:f993b6d8b1d8
|
31
|
#include "core/net.h"
|
| zoot661 |
0:f993b6d8b1d8
|
32
|
#include "core/host.h"
|
| zoot661 |
0:f993b6d8b1d8
|
33
|
//Essentially it is a safe interface to NetTcpSocket
|
| zoot661 |
0:f993b6d8b1d8
|
34
|
|
| zoot661 |
0:f993b6d8b1d8
|
35
|
///TCP Socket error codes
|
| zoot661 |
0:f993b6d8b1d8
|
36
|
enum TCPSocketErr
|
| zoot661 |
0:f993b6d8b1d8
|
37
|
{
|
| zoot661 |
0:f993b6d8b1d8
|
38
|
__TCPSOCKET_MIN = -0xFFFF,
|
| zoot661 |
0:f993b6d8b1d8
|
39
|
TCPSOCKET_SETUP, ///<TCPSocket not properly configured
|
| zoot661 |
0:f993b6d8b1d8
|
40
|
TCPSOCKET_TIMEOUT, ///<Connection timed out
|
| zoot661 |
0:f993b6d8b1d8
|
41
|
TCPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized
|
| zoot661 |
0:f993b6d8b1d8
|
42
|
TCPSOCKET_MEM, ///<Not enough mem
|
| zoot661 |
0:f993b6d8b1d8
|
43
|
TCPSOCKET_INUSE, ///<Interface / Port is in use
|
| zoot661 |
0:f993b6d8b1d8
|
44
|
TCPSOCKET_EMPTY, ///<Connections queue is empty
|
| zoot661 |
0:f993b6d8b1d8
|
45
|
TCPSOCKET_RST, ///<Connection was reset by remote host
|
| zoot661 |
0:f993b6d8b1d8
|
46
|
//...
|
| zoot661 |
0:f993b6d8b1d8
|
47
|
TCPSOCKET_OK = 0 ///<Success
|
| zoot661 |
0:f993b6d8b1d8
|
48
|
};
|
| zoot661 |
0:f993b6d8b1d8
|
49
|
|
| zoot661 |
0:f993b6d8b1d8
|
50
|
///TCP Socket Events
|
| zoot661 |
0:f993b6d8b1d8
|
51
|
enum TCPSocketEvent
|
| zoot661 |
0:f993b6d8b1d8
|
52
|
{
|
| zoot661 |
0:f993b6d8b1d8
|
53
|
TCPSOCKET_CONNECTED, ///<Connected to host
|
| zoot661 |
0:f993b6d8b1d8
|
54
|
TCPSOCKET_ACCEPT, ///<Client is connected, must call accept() to get a new Socket
|
| zoot661 |
0:f993b6d8b1d8
|
55
|
TCPSOCKET_READABLE, ///<Data in buf
|
| zoot661 |
0:f993b6d8b1d8
|
56
|
TCPSOCKET_WRITEABLE, ///<Can write data to buf
|
| zoot661 |
0:f993b6d8b1d8
|
57
|
TCPSOCKET_CONTIMEOUT, ///<Connection timed out
|
| zoot661 |
0:f993b6d8b1d8
|
58
|
TCPSOCKET_CONRST, ///<Connection was reset by remote host
|
| zoot661 |
0:f993b6d8b1d8
|
59
|
TCPSOCKET_CONABRT, ///<Connection was aborted
|
| zoot661 |
0:f993b6d8b1d8
|
60
|
TCPSOCKET_ERROR, ///<Unknown error
|
| zoot661 |
0:f993b6d8b1d8
|
61
|
TCPSOCKET_DISCONNECTED ///<Disconnected
|
| zoot661 |
0:f993b6d8b1d8
|
62
|
};
|
| zoot661 |
0:f993b6d8b1d8
|
63
|
|
| zoot661 |
0:f993b6d8b1d8
|
64
|
class NetTcpSocket;
|
| zoot661 |
0:f993b6d8b1d8
|
65
|
enum NetTcpSocketEvent;
|
| zoot661 |
0:f993b6d8b1d8
|
66
|
|
| zoot661 |
0:f993b6d8b1d8
|
67
|
///This is a simple TCP Socket class
|
| zoot661 |
0:f993b6d8b1d8
|
68
|
/**
|
| zoot661 |
0:f993b6d8b1d8
|
69
|
This class exposes an API to deal with TCP Sockets
|
| zoot661 |
0:f993b6d8b1d8
|
70
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
71
|
class TCPSocket
|
| zoot661 |
0:f993b6d8b1d8
|
72
|
{
|
| zoot661 |
0:f993b6d8b1d8
|
73
|
public:
|
| zoot661 |
0:f993b6d8b1d8
|
74
|
///Creates a new socket
|
| zoot661 |
0:f993b6d8b1d8
|
75
|
TCPSocket();
|
| zoot661 |
0:f993b6d8b1d8
|
76
|
protected:
|
| zoot661 |
0:f993b6d8b1d8
|
77
|
TCPSocket(NetTcpSocket* pNetTcpSocket);
|
| zoot661 |
0:f993b6d8b1d8
|
78
|
public:
|
| zoot661 |
0:f993b6d8b1d8
|
79
|
///Closes if needed and destroys the socket
|
| zoot661 |
0:f993b6d8b1d8
|
80
|
~TCPSocket(); //close()
|
| zoot661 |
0:f993b6d8b1d8
|
81
|
|
| zoot661 |
0:f993b6d8b1d8
|
82
|
///Binds the socket to (local) host
|
| zoot661 |
0:f993b6d8b1d8
|
83
|
TCPSocketErr bind(const Host& me);
|
| zoot661 |
0:f993b6d8b1d8
|
84
|
|
| zoot661 |
0:f993b6d8b1d8
|
85
|
///Starts listening
|
| zoot661 |
0:f993b6d8b1d8
|
86
|
TCPSocketErr listen();
|
| zoot661 |
0:f993b6d8b1d8
|
87
|
|
| zoot661 |
0:f993b6d8b1d8
|
88
|
///Connects socket to host
|
| zoot661 |
0:f993b6d8b1d8
|
89
|
TCPSocketErr connect(const Host& host);
|
| zoot661 |
0:f993b6d8b1d8
|
90
|
|
| zoot661 |
0:f993b6d8b1d8
|
91
|
///Accepts connection from client and gets connected socket
|
| zoot661 |
0:f993b6d8b1d8
|
92
|
TCPSocketErr accept(Host* pClient, TCPSocket** ppNewTcpSocket);
|
| zoot661 |
0:f993b6d8b1d8
|
93
|
|
| zoot661 |
0:f993b6d8b1d8
|
94
|
///Sends data
|
| zoot661 |
0:f993b6d8b1d8
|
95
|
/*
|
| zoot661 |
0:f993b6d8b1d8
|
96
|
@return a negative error code or the number of bytes transmitted
|
| zoot661 |
0:f993b6d8b1d8
|
97
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
98
|
int /*if < 0 : TCPSocketErr*/ send(const char* buf, int len);
|
| zoot661 |
0:f993b6d8b1d8
|
99
|
|
| zoot661 |
0:f993b6d8b1d8
|
100
|
///Receives data
|
| zoot661 |
0:f993b6d8b1d8
|
101
|
/*
|
| zoot661 |
0:f993b6d8b1d8
|
102
|
@return a negative error code or the number of bytes received
|
| zoot661 |
0:f993b6d8b1d8
|
103
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
104
|
int /*if < 0 : TCPSocketErr*/ recv(char* buf, int len);
|
| zoot661 |
0:f993b6d8b1d8
|
105
|
|
| zoot661 |
0:f993b6d8b1d8
|
106
|
/* TODO NTH : printf / scanf helpers that call send/recv */
|
| zoot661 |
0:f993b6d8b1d8
|
107
|
|
| zoot661 |
0:f993b6d8b1d8
|
108
|
///Closes socket
|
| zoot661 |
0:f993b6d8b1d8
|
109
|
TCPSocketErr close();
|
| zoot661 |
0:f993b6d8b1d8
|
110
|
|
| zoot661 |
0:f993b6d8b1d8
|
111
|
//Callbacks
|
| zoot661 |
0:f993b6d8b1d8
|
112
|
///Setups callback
|
| zoot661 |
0:f993b6d8b1d8
|
113
|
/**
|
| zoot661 |
0:f993b6d8b1d8
|
114
|
@param pMethod : callback function
|
| zoot661 |
0:f993b6d8b1d8
|
115
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
116
|
void setOnEvent( void (*pMethod)(TCPSocketEvent) );
|
| zoot661 |
0:f993b6d8b1d8
|
117
|
|
| zoot661 |
0:f993b6d8b1d8
|
118
|
class CDummy;
|
| zoot661 |
0:f993b6d8b1d8
|
119
|
///Setups callback
|
| zoot661 |
0:f993b6d8b1d8
|
120
|
/**
|
| zoot661 |
0:f993b6d8b1d8
|
121
|
@param pItem : instance of class on which to execute the callback method
|
| zoot661 |
0:f993b6d8b1d8
|
122
|
@param pMethod : callback method
|
| zoot661 |
0:f993b6d8b1d8
|
123
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
124
|
template<class T>
|
| zoot661 |
0:f993b6d8b1d8
|
125
|
void setOnEvent( T* pItem, void (T::*pMethod)(TCPSocketEvent) )
|
| zoot661 |
0:f993b6d8b1d8
|
126
|
{
|
| zoot661 |
0:f993b6d8b1d8
|
127
|
m_pCbItem = (CDummy*) pItem;
|
| zoot661 |
0:f993b6d8b1d8
|
128
|
m_pCbMeth = (void (CDummy::*)(TCPSocketEvent)) pMethod;
|
| zoot661 |
0:f993b6d8b1d8
|
129
|
}
|
| zoot661 |
0:f993b6d8b1d8
|
130
|
|
| zoot661 |
0:f993b6d8b1d8
|
131
|
///Disables callback
|
| zoot661 |
0:f993b6d8b1d8
|
132
|
void resetOnEvent();
|
| zoot661 |
0:f993b6d8b1d8
|
133
|
|
| zoot661 |
0:f993b6d8b1d8
|
134
|
protected:
|
| zoot661 |
0:f993b6d8b1d8
|
135
|
void onNetTcpSocketEvent(NetTcpSocketEvent e);
|
| zoot661 |
0:f993b6d8b1d8
|
136
|
TCPSocketErr checkInst();
|
| zoot661 |
0:f993b6d8b1d8
|
137
|
|
| zoot661 |
0:f993b6d8b1d8
|
138
|
private:
|
| zoot661 |
0:f993b6d8b1d8
|
139
|
NetTcpSocket* m_pNetTcpSocket;
|
| zoot661 |
0:f993b6d8b1d8
|
140
|
|
| zoot661 |
0:f993b6d8b1d8
|
141
|
CDummy* m_pCbItem;
|
| zoot661 |
0:f993b6d8b1d8
|
142
|
void (CDummy::*m_pCbMeth)(TCPSocketEvent);
|
| zoot661 |
0:f993b6d8b1d8
|
143
|
|
| zoot661 |
0:f993b6d8b1d8
|
144
|
void (*m_pCb)(TCPSocketEvent);
|
| zoot661 |
0:f993b6d8b1d8
|
145
|
|
| zoot661 |
0:f993b6d8b1d8
|
146
|
};
|
| zoot661 |
0:f993b6d8b1d8
|
147
|
|
| zoot661 |
0:f993b6d8b1d8
|
148
|
#endif
|
Rob Greenhill