| 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
|
UDP Socket header file
|
| zoot661 |
0:f993b6d8b1d8
|
26
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
27
|
|
| zoot661 |
0:f993b6d8b1d8
|
28
|
#ifndef UDPSOCKET_H
|
| zoot661 |
0:f993b6d8b1d8
|
29
|
#define UDPSOCKET_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 NetUdpSocket
|
| zoot661 |
0:f993b6d8b1d8
|
34
|
|
| zoot661 |
0:f993b6d8b1d8
|
35
|
///UDP Socket error codes
|
| zoot661 |
0:f993b6d8b1d8
|
36
|
enum UDPSocketErr
|
| zoot661 |
0:f993b6d8b1d8
|
37
|
{
|
| zoot661 |
0:f993b6d8b1d8
|
38
|
__UDPSOCKET_MIN = -0xFFFF,
|
| zoot661 |
0:f993b6d8b1d8
|
39
|
UDPSOCKET_SETUP, ///<UDPSocket not properly configured
|
| zoot661 |
0:f993b6d8b1d8
|
40
|
UDPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized
|
| zoot661 |
0:f993b6d8b1d8
|
41
|
UDPSOCKET_MEM, ///<Not enough mem
|
| zoot661 |
0:f993b6d8b1d8
|
42
|
UDPSOCKET_INUSE, ///<Interface / Port is in use
|
| zoot661 |
0:f993b6d8b1d8
|
43
|
//...
|
| zoot661 |
0:f993b6d8b1d8
|
44
|
UDPSOCKET_OK = 0 ///<Success
|
| zoot661 |
0:f993b6d8b1d8
|
45
|
};
|
| zoot661 |
0:f993b6d8b1d8
|
46
|
|
| zoot661 |
0:f993b6d8b1d8
|
47
|
///UDP Socket Event(s)
|
| zoot661 |
0:f993b6d8b1d8
|
48
|
enum UDPSocketEvent //Only one event here for now, but keeps that model in case we need to implement some others
|
| zoot661 |
0:f993b6d8b1d8
|
49
|
{
|
| zoot661 |
0:f993b6d8b1d8
|
50
|
UDPSOCKET_READABLE, ///<Data in buf
|
| zoot661 |
0:f993b6d8b1d8
|
51
|
};
|
| zoot661 |
0:f993b6d8b1d8
|
52
|
|
| zoot661 |
0:f993b6d8b1d8
|
53
|
class NetUdpSocket;
|
| zoot661 |
0:f993b6d8b1d8
|
54
|
enum NetUdpSocketEvent;
|
| zoot661 |
0:f993b6d8b1d8
|
55
|
|
| zoot661 |
0:f993b6d8b1d8
|
56
|
///This is a simple UDP Socket class
|
| zoot661 |
0:f993b6d8b1d8
|
57
|
/**
|
| zoot661 |
0:f993b6d8b1d8
|
58
|
This class exposes an API to deal with UDP Sockets
|
| zoot661 |
0:f993b6d8b1d8
|
59
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
60
|
class UDPSocket
|
| zoot661 |
0:f993b6d8b1d8
|
61
|
{
|
| zoot661 |
0:f993b6d8b1d8
|
62
|
public:
|
| zoot661 |
0:f993b6d8b1d8
|
63
|
///Creates a new socket
|
| zoot661 |
0:f993b6d8b1d8
|
64
|
UDPSocket();
|
| zoot661 |
0:f993b6d8b1d8
|
65
|
|
| zoot661 |
0:f993b6d8b1d8
|
66
|
///Closes and destroys socket
|
| zoot661 |
0:f993b6d8b1d8
|
67
|
~UDPSocket(); //close()
|
| zoot661 |
0:f993b6d8b1d8
|
68
|
|
| zoot661 |
0:f993b6d8b1d8
|
69
|
///Binds the socket to local host or a multicast address
|
| zoot661 |
0:f993b6d8b1d8
|
70
|
UDPSocketErr bind(const Host& me);
|
| zoot661 |
0:f993b6d8b1d8
|
71
|
|
| zoot661 |
0:f993b6d8b1d8
|
72
|
///Sends data
|
| zoot661 |
0:f993b6d8b1d8
|
73
|
/*
|
| zoot661 |
0:f993b6d8b1d8
|
74
|
@param pHost : host to send data to
|
| zoot661 |
0:f993b6d8b1d8
|
75
|
@return a negative error code or the number of bytes transmitted
|
| zoot661 |
0:f993b6d8b1d8
|
76
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
77
|
int /*if < 0 : UDPSocketErr*/ sendto(const char* buf, int len, Host* pHost);
|
| zoot661 |
0:f993b6d8b1d8
|
78
|
|
| zoot661 |
0:f993b6d8b1d8
|
79
|
///Receives data
|
| zoot661 |
0:f993b6d8b1d8
|
80
|
/*
|
| zoot661 |
0:f993b6d8b1d8
|
81
|
@param pHost : host from which this piece of data comes from
|
| zoot661 |
0:f993b6d8b1d8
|
82
|
@return a negative error code or the number of bytes received
|
| zoot661 |
0:f993b6d8b1d8
|
83
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
84
|
int /*if < 0 : UDPSocketErr*/ recvfrom(char* buf, int len, Host* pHost);
|
| zoot661 |
0:f993b6d8b1d8
|
85
|
|
| zoot661 |
0:f993b6d8b1d8
|
86
|
/* TODO NTH : printf / scanf helpers that call send/recv */
|
| zoot661 |
0:f993b6d8b1d8
|
87
|
|
| zoot661 |
0:f993b6d8b1d8
|
88
|
///Closes socket
|
| zoot661 |
0:f993b6d8b1d8
|
89
|
UDPSocketErr close();
|
| zoot661 |
0:f993b6d8b1d8
|
90
|
|
| zoot661 |
0:f993b6d8b1d8
|
91
|
//Callbacks
|
| zoot661 |
0:f993b6d8b1d8
|
92
|
///Setups callback
|
| zoot661 |
0:f993b6d8b1d8
|
93
|
/**
|
| zoot661 |
0:f993b6d8b1d8
|
94
|
@param pMethod : callback function
|
| zoot661 |
0:f993b6d8b1d8
|
95
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
96
|
void setOnEvent( void (*pMethod)(UDPSocketEvent) );
|
| zoot661 |
0:f993b6d8b1d8
|
97
|
|
| zoot661 |
0:f993b6d8b1d8
|
98
|
class CDummy;
|
| zoot661 |
0:f993b6d8b1d8
|
99
|
///Setups callback
|
| zoot661 |
0:f993b6d8b1d8
|
100
|
/**
|
| zoot661 |
0:f993b6d8b1d8
|
101
|
@param pItem : instance of class on which to execute the callback method
|
| zoot661 |
0:f993b6d8b1d8
|
102
|
@param pMethod : callback method
|
| zoot661 |
0:f993b6d8b1d8
|
103
|
*/
|
| zoot661 |
0:f993b6d8b1d8
|
104
|
template<class T>
|
| zoot661 |
0:f993b6d8b1d8
|
105
|
void setOnEvent( T* pItem, void (T::*pMethod)(UDPSocketEvent) )
|
| zoot661 |
0:f993b6d8b1d8
|
106
|
{
|
| zoot661 |
0:f993b6d8b1d8
|
107
|
m_pCbItem = (CDummy*) pItem;
|
| zoot661 |
0:f993b6d8b1d8
|
108
|
m_pCbMeth = (void (CDummy::*)(UDPSocketEvent)) pMethod;
|
| zoot661 |
0:f993b6d8b1d8
|
109
|
}
|
| zoot661 |
0:f993b6d8b1d8
|
110
|
|
| zoot661 |
0:f993b6d8b1d8
|
111
|
///Disables callback
|
| zoot661 |
0:f993b6d8b1d8
|
112
|
void resetOnEvent();
|
| zoot661 |
0:f993b6d8b1d8
|
113
|
|
| zoot661 |
0:f993b6d8b1d8
|
114
|
protected:
|
| zoot661 |
0:f993b6d8b1d8
|
115
|
void onNetUdpSocketEvent(NetUdpSocketEvent e);
|
| zoot661 |
0:f993b6d8b1d8
|
116
|
UDPSocketErr checkInst();
|
| zoot661 |
0:f993b6d8b1d8
|
117
|
|
| zoot661 |
0:f993b6d8b1d8
|
118
|
private:
|
| zoot661 |
0:f993b6d8b1d8
|
119
|
NetUdpSocket* m_pNetUdpSocket;
|
| zoot661 |
0:f993b6d8b1d8
|
120
|
|
| zoot661 |
0:f993b6d8b1d8
|
121
|
CDummy* m_pCbItem;
|
| zoot661 |
0:f993b6d8b1d8
|
122
|
void (CDummy::*m_pCbMeth)(UDPSocketEvent);
|
| zoot661 |
0:f993b6d8b1d8
|
123
|
|
| zoot661 |
0:f993b6d8b1d8
|
124
|
void (*m_pCb)(UDPSocketEvent);
|
| zoot661 |
0:f993b6d8b1d8
|
125
|
|
| zoot661 |
0:f993b6d8b1d8
|
126
|
};
|
| zoot661 |
0:f993b6d8b1d8
|
127
|
|
| zoot661 |
0:f993b6d8b1d8
|
128
|
#endif
|
Rob Greenhill