Dependencies:   mbed

Committer:
gbeardall
Date:
Mon Oct 17 10:39:17 2011 +0000
Revision:
0:715023d993d6

        

Who changed what in which revision?

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