sasa ivkovic / Mbed 2 deprecated LAN

testing of combination of LCS and LAN

Dependencies:   mbed

EthernetNetIf/LPC1768/api/DNSRequest.h@0:a7a6a692162f, 2015-01-14 (annotated)

Committer:
damir
Date:
Wed Jan 14 13:29:55 2015 +0000
Revision:
0:a7a6a692162f
Test of LAN

Who changed what in which revision?

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