Michiel Berckvens / Mbed 2 deprecated ProjectHTTP

Berckvens Michiel & Basteyns Jonas

Dependencies:   DS1307 TextLCD mbed

NetServices/api/DNSRequest.h@5:6878defcfeb9, 2014-12-11 (annotated)

Committer:
Michielber
Date:
Thu Dec 11 16:07:34 2014 +0000
Revision:
5:6878defcfeb9
Parent:
0:f615d151a72c 
Project updated belastingslijn

Who changed what in which revision?

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