Lorcan Smith / Mbed 2 deprecated Enet_SPI

SNMP agent attached to SPI slave

Dependencies:   mbed

api/DNSRequest.h@0:2a53a4c3238c, 2012-08-13 (annotated)

Committer:
lorcansmith
Date:
Mon Aug 13 15:07:40 2012 +0000
Revision:
0:2a53a4c3238c
v1.1 release includes ioAlarm traps

Who changed what in which revision?

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