Alvaro Cassinelli / Mbed 2 deprecated laserUI

Laser Sensing Display for UI interfaces in the real world

Dependencies:   mbed

Fork of skinGames_forktest by Alvaro Cassinelli

EthernetNetIf/LPC1768/api/DNSRequest.h@47:199042980678, 2014-04-17 (annotated)

Committer:
mbedalvaro
Date:
Thu Apr 17 08:04:14 2014 +0000
Revision:
47:199042980678
Parent:
31:5f039cbddee8 
publishing for sharing with Ken Iwasaki

Who changed what in which revision?

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