Dependencies:   mbed

Dependents:   TCP

Committer:
slowness
Date:
Tue Sep 06 18:05:46 2011 +0000
Revision:
0:58c3d014a4e7

        

Who changed what in which revision?

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