Michael Spencer / Mbed 2 deprecated LaOS

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.

Dependencies:   mbed

NetServices/api/DNSRequest.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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