Atsushi Hattori / Mbed 2 deprecated 20210627_Logger

hattori&ide

Dependencies:   mbed

EthernetNetIf/LPC1768/api/DNSRequest.h@0:f77369cabd75, 18 months ago (annotated)

Committer:
hattori_atsushi
Date:
Sun Dec 18 08:16:01 2022 +0000
Revision:
0:f77369cabd75
hattori

Who changed what in which revision?

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