Committer:
donatien
Date:
Fri Aug 06 10:42:05 2010 +0000
Revision:
3:e02ec42cf9c8
Parent:
0:0f5a52711275

        

Who changed what in which revision?

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