Richard Blimmel / Mbed 2 deprecated CIG_HTTPClient

HTTPClient using static IP

Dependencies:   mbed

NetServices/api/DNSRequest.h@0:d8f2f7d5f31b, 2011-05-30 (annotated)

Committer:
mr_q
Date:
Mon May 30 11:53:37 2011 +0000
Revision:
0:d8f2f7d5f31b
v0.01 Draft

Who changed what in which revision?

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