Simon Ford / NetServices

Version of http://mbed.org/cookbook/NetServicesTribute with setting set the same for LPC2368

Dependents:   UDPSocketExample 24LCxx_I2CApp WeatherPlatform_pachube HvZServerLib ... more

api/DNSRequest.h@0:350011bf8be7, 2010-11-23 (annotated)

Committer:
simon
Date:
Tue Nov 23 14:15:36 2010 +0000
Revision:
0:350011bf8be7
Experimental version for testing UDP

Who changed what in which revision?

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