Dependencies:   mbed

Committer:
slowness
Date:
Tue Sep 06 18:10:36 2011 +0000
Revision:
0:cd4c47744fa1

        

Who changed what in which revision?

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