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