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