hirifumi mikage / EthernetNetIf

EthernetNetIf

Dependents:   XBee_WiFi_EA_LPC4088

api/DNSRequest.h@0:62580107d20c, 2014-11-19 (annotated)

Committer:
hmike
Date:
Wed Nov 19 12:00:42 2014 +0000
Revision:
0:62580107d20c
EthernetNetIf

Who changed what in which revision?

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