| User | Revision | Line number | New contents of line |
|---|
| mbed714 |
0:d616ece2d859
|
1
|
|
| mbed714 |
0:d616ece2d859
|
2
|
/*
|
| mbed714 |
0:d616ece2d859
|
3
|
Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
|
| mbed714 |
0:d616ece2d859
|
4
|
|
| mbed714 |
0:d616ece2d859
|
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
| mbed714 |
0:d616ece2d859
|
6
|
of this software and associated documentation files (the "Software"), to deal
|
| mbed714 |
0:d616ece2d859
|
7
|
in the Software without restriction, including without limitation the rights
|
| mbed714 |
0:d616ece2d859
|
8
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| mbed714 |
0:d616ece2d859
|
9
|
copies of the Software, and to permit persons to whom the Software is
|
| mbed714 |
0:d616ece2d859
|
10
|
furnished to do so, subject to the following conditions:
|
| mbed714 |
0:d616ece2d859
|
11
|
|
| mbed714 |
0:d616ece2d859
|
12
|
The above copyright notice and this permission notice shall be included in
|
| mbed714 |
0:d616ece2d859
|
13
|
all copies or substantial portions of the Software.
|
| mbed714 |
0:d616ece2d859
|
14
|
|
| mbed714 |
0:d616ece2d859
|
15
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| mbed714 |
0:d616ece2d859
|
16
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| mbed714 |
0:d616ece2d859
|
17
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| mbed714 |
0:d616ece2d859
|
18
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| mbed714 |
0:d616ece2d859
|
19
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| mbed714 |
0:d616ece2d859
|
20
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
| mbed714 |
0:d616ece2d859
|
21
|
THE SOFTWARE.
|
| mbed714 |
0:d616ece2d859
|
22
|
*/
|
| mbed714 |
0:d616ece2d859
|
23
|
|
| mbed714 |
0:d616ece2d859
|
24
|
/** \file
|
| mbed714 |
0:d616ece2d859
|
25
|
DNS Request header file
|
| mbed714 |
0:d616ece2d859
|
26
|
*/
|
| mbed714 |
0:d616ece2d859
|
27
|
|
| mbed714 |
0:d616ece2d859
|
28
|
#ifndef DNSREQUEST_H
|
| mbed714 |
0:d616ece2d859
|
29
|
#define DNSREQUEST_H
|
| mbed714 |
0:d616ece2d859
|
30
|
|
| mbed714 |
0:d616ece2d859
|
31
|
#include "core/net.h"
|
| mbed714 |
0:d616ece2d859
|
32
|
#include "core/ipaddr.h"
|
| mbed714 |
0:d616ece2d859
|
33
|
#include "core/host.h"
|
| mbed714 |
0:d616ece2d859
|
34
|
//Essentially it is a safe interface to NetDnsRequest
|
| mbed714 |
0:d616ece2d859
|
35
|
|
| mbed714 |
0:d616ece2d859
|
36
|
///DNS Request error codes
|
| mbed714 |
0:d616ece2d859
|
37
|
enum DNSRequestErr
|
| mbed714 |
0:d616ece2d859
|
38
|
{
|
| mbed714 |
0:d616ece2d859
|
39
|
__DNS_MIN = -0xFFFF,
|
| mbed714 |
0:d616ece2d859
|
40
|
DNS_SETUP, ///<DNSRequest not properly configured
|
| mbed714 |
0:d616ece2d859
|
41
|
DNS_IF, ///<Interface has problems, does not exist or is not initialized
|
| mbed714 |
0:d616ece2d859
|
42
|
DNS_MEM, ///<Not enough mem
|
| mbed714 |
0:d616ece2d859
|
43
|
DNS_INUSE, ///<Interface / Port is in use
|
| mbed714 |
0:d616ece2d859
|
44
|
DNS_PROCESSING, ///<Request has not completed
|
| mbed714 |
0:d616ece2d859
|
45
|
//...
|
| mbed714 |
0:d616ece2d859
|
46
|
DNS_OK = 0 ///<Success
|
| mbed714 |
0:d616ece2d859
|
47
|
};
|
| mbed714 |
0:d616ece2d859
|
48
|
|
| mbed714 |
0:d616ece2d859
|
49
|
///DNS Request Result Events
|
| mbed714 |
0:d616ece2d859
|
50
|
enum DNSReply
|
| mbed714 |
0:d616ece2d859
|
51
|
{
|
| mbed714 |
0:d616ece2d859
|
52
|
DNS_PRTCL,
|
| mbed714 |
0:d616ece2d859
|
53
|
DNS_NOTFOUND, ///Hostname is unknown
|
| mbed714 |
0:d616ece2d859
|
54
|
DNS_ERROR, ///Problem with DNS Service
|
| mbed714 |
0:d616ece2d859
|
55
|
//...
|
| mbed714 |
0:d616ece2d859
|
56
|
DNS_FOUND,
|
| mbed714 |
0:d616ece2d859
|
57
|
};
|
| mbed714 |
0:d616ece2d859
|
58
|
|
| mbed714 |
0:d616ece2d859
|
59
|
class NetDnsRequest;
|
| mbed714 |
0:d616ece2d859
|
60
|
enum NetDnsReply;
|
| mbed714 |
0:d616ece2d859
|
61
|
|
| mbed714 |
0:d616ece2d859
|
62
|
///This is a simple DNS Request class
|
| mbed714 |
0:d616ece2d859
|
63
|
/**
|
| mbed714 |
0:d616ece2d859
|
64
|
This class exposes an API to deal with DNS Requests
|
| mbed714 |
0:d616ece2d859
|
65
|
*/
|
| mbed714 |
0:d616ece2d859
|
66
|
class DNSRequest
|
| mbed714 |
0:d616ece2d859
|
67
|
{
|
| mbed714 |
0:d616ece2d859
|
68
|
public:
|
| mbed714 |
0:d616ece2d859
|
69
|
///Creates a new request
|
| mbed714 |
0:d616ece2d859
|
70
|
DNSRequest();
|
| mbed714 |
0:d616ece2d859
|
71
|
|
| mbed714 |
0:d616ece2d859
|
72
|
///Terminates and closes request
|
| mbed714 |
0:d616ece2d859
|
73
|
~DNSRequest();
|
| mbed714 |
0:d616ece2d859
|
74
|
|
| mbed714 |
0:d616ece2d859
|
75
|
///Resolves an hostname
|
| mbed714 |
0:d616ece2d859
|
76
|
/**
|
| mbed714 |
0:d616ece2d859
|
77
|
@param hostname : hostname to resolve
|
| mbed714 |
0:d616ece2d859
|
78
|
*/
|
| mbed714 |
0:d616ece2d859
|
79
|
DNSRequestErr resolve(const char* hostname);
|
| mbed714 |
0:d616ece2d859
|
80
|
|
| mbed714 |
0:d616ece2d859
|
81
|
///Resolves an hostname
|
| mbed714 |
0:d616ece2d859
|
82
|
/**
|
| mbed714 |
0:d616ece2d859
|
83
|
@param host : hostname to resolve, the result will be stored in the IpAddr field of this object
|
| mbed714 |
0:d616ece2d859
|
84
|
*/
|
| mbed714 |
0:d616ece2d859
|
85
|
DNSRequestErr resolve(Host* pHost);
|
| mbed714 |
0:d616ece2d859
|
86
|
|
| mbed714 |
0:d616ece2d859
|
87
|
///Setups callback
|
| mbed714 |
0:d616ece2d859
|
88
|
/**
|
| mbed714 |
0:d616ece2d859
|
89
|
The callback function will be called on result.
|
| mbed714 |
0:d616ece2d859
|
90
|
@param pMethod : callback function
|
| mbed714 |
0:d616ece2d859
|
91
|
*/
|
| mbed714 |
0:d616ece2d859
|
92
|
void setOnReply( void (*pMethod)(DNSReply) );
|
| mbed714 |
0:d616ece2d859
|
93
|
|
| mbed714 |
0:d616ece2d859
|
94
|
class CDummy;
|
| mbed714 |
0:d616ece2d859
|
95
|
///Setups callback
|
| mbed714 |
0:d616ece2d859
|
96
|
/**
|
| mbed714 |
0:d616ece2d859
|
97
|
The callback function will be called on result.
|
| mbed714 |
0:d616ece2d859
|
98
|
@param pItem : instance of class on which to execute the callback method
|
| mbed714 |
0:d616ece2d859
|
99
|
@param pMethod : callback method
|
| mbed714 |
0:d616ece2d859
|
100
|
*/
|
| mbed714 |
0:d616ece2d859
|
101
|
template<class T>
|
| mbed714 |
0:d616ece2d859
|
102
|
void setOnReply( T* pItem, void (T::*pMethod)(DNSReply) )
|
| mbed714 |
0:d616ece2d859
|
103
|
{
|
| mbed714 |
0:d616ece2d859
|
104
|
m_pCbItem = (CDummy*) pItem;
|
| mbed714 |
0:d616ece2d859
|
105
|
m_pCbMeth = (void (CDummy::*)(DNSReply)) pMethod;
|
| mbed714 |
0:d616ece2d859
|
106
|
}
|
| mbed714 |
0:d616ece2d859
|
107
|
|
| mbed714 |
0:d616ece2d859
|
108
|
///Gets IP address once it has been resolved
|
| mbed714 |
0:d616ece2d859
|
109
|
/**
|
| mbed714 |
0:d616ece2d859
|
110
|
@param pIp : pointer to an IpAddr instance in which to store the resolved IP address
|
| mbed714 |
0:d616ece2d859
|
111
|
*/
|
| mbed714 |
0:d616ece2d859
|
112
|
DNSRequestErr getResult(IpAddr* pIp);
|
| mbed714 |
0:d616ece2d859
|
113
|
|
| mbed714 |
0:d616ece2d859
|
114
|
///Closes DNS Request before completion
|
| mbed714 |
0:d616ece2d859
|
115
|
DNSRequestErr close();
|
| mbed714 |
0:d616ece2d859
|
116
|
|
| mbed714 |
0:d616ece2d859
|
117
|
protected:
|
| mbed714 |
0:d616ece2d859
|
118
|
void onNetDnsReply(NetDnsReply r);
|
| mbed714 |
0:d616ece2d859
|
119
|
DNSRequestErr checkInst();
|
| mbed714 |
0:d616ece2d859
|
120
|
|
| mbed714 |
0:d616ece2d859
|
121
|
private:
|
| mbed714 |
0:d616ece2d859
|
122
|
NetDnsRequest* m_pNetDnsRequest;
|
| mbed714 |
0:d616ece2d859
|
123
|
|
| mbed714 |
0:d616ece2d859
|
124
|
CDummy* m_pCbItem;
|
| mbed714 |
0:d616ece2d859
|
125
|
void (CDummy::*m_pCbMeth)(DNSReply);
|
| mbed714 |
0:d616ece2d859
|
126
|
|
| mbed714 |
0:d616ece2d859
|
127
|
void (*m_pCb)(DNSReply);
|
| mbed714 |
0:d616ece2d859
|
128
|
|
| mbed714 |
0:d616ece2d859
|
129
|
};
|
| mbed714 |
0:d616ece2d859
|
130
|
|
| mbed714 |
0:d616ece2d859
|
131
|
#endif
|
Daniel Peter