Jeff Mourich / EthernetNetIf_ChangeHostName

ID the MBED processor on the network if you have more than one. View MBED name on DHCP of your Router - Example \"MBED PE\" Change your ID in Core / host.h

LPC1768/api/DNSRequest.h@0:fd3b85615428, 2010-11-06 (annotated)

Committer:
JeffM
Date:
Sat Nov 06 14:11:02 2010 +0000
Revision:
0:fd3b85615428
MBED ID 1A

Who changed what in which revision?

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