SHOHEI FUJIMOTO / Mbed 2 deprecated SimpleOscTester

simple tester example >>> osc destination & receive

Dependencies:   mbed

Fork of myOSC_test by Alvaro Cassinelli

EthernetNetIf/LPC1768/api/DNSRequest.h@0:f76708a93fb3, 2011-10-15 (annotated)

Committer:
mbedalvaro
Date:
Sat Oct 15 14:15:55 2011 +0000
Revision:
0:f76708a93fb3
First working test of this simple OSC library.

Who changed what in which revision?

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