hiroshi matsumoto / EthernetNetIf

lpc1768

api/DNSRequest.h@0:f35dada1dac1, 2015-01-27 (annotated)

Committer:
jh1cdv00
Date:
Tue Jan 27 01:38:19 2015 +0000
Revision:
0:f35dada1dac1
lpc1768

Who changed what in which revision?

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