FBI FRATER / Mbed 2 deprecated InetTest

Library for Bert van Dam's book "ARM MICROCONTROLLERS" For all chapters with internet.

Dependencies:   mbed

NetServices/api/DNSRequest.h@0:4edb816d21e1, 2015-10-16 (annotated)

Committer:
ICTFBI
Date:
Fri Oct 16 14:28:26 2015 +0000
Revision:
0:4edb816d21e1
Pre-update 16-10-15

Who changed what in which revision?

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