Yasushi TAUCHI / Mbed 2 deprecated temp_WebServer

Dependencies:   MSCUsbHost NetServices RPCInterface TextLCD mbed

NetServices/api/DNSRequest.h@1:f2088fbce73f, 2012-08-22 (annotated)

Committer:
yueee_yt
Date:
Wed Aug 22 05:10:09 2012 +0000
Revision:
1:f2088fbce73f
Parent:
0:fd83f3540b1a 
???????LM35??????WebServer

Who changed what in which revision?

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