Rahol Rajan / NetServices-Traffic

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of NetServices by Segundo Equipo

api/DNSRequest.h@8:92b57208ab99, 2013-03-06 (annotated)

Committer:
rrajan8
Date:
Wed Mar 06 19:07:23 2013 +0000
Revision:
8:92b57208ab99
Parent:
0:ac1725ba162c 
This project utilizes mbed's networking features to display live traffic updates on the Nokia LCD using the MapQuest API's Traffic Web Service.

Who changed what in which revision?

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