Brandon Fictorie / Mbed 2 deprecated BF_Websocket

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

EthernetNetIf/LPC1768/api/DNSRequest.h@0:8cdad1c73e8e, 2012-03-25 (annotated)

Committer:
bfictorie
Date:
Sun Mar 25 17:26:30 2012 +0000
Revision:
0:8cdad1c73e8e

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


bfictorie

0:8cdad1c73e8e


     1







bfictorie

0:8cdad1c73e8e


     2

/*





bfictorie

0:8cdad1c73e8e


     3

Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)





bfictorie

0:8cdad1c73e8e


     4

 





bfictorie

0:8cdad1c73e8e


     5

Permission is hereby granted, free of charge, to any person obtaining a copy





bfictorie

0:8cdad1c73e8e


     6

of this software and associated documentation files (the "Software"), to deal





bfictorie

0:8cdad1c73e8e


     7

in the Software without restriction, including without limitation the rights





bfictorie

0:8cdad1c73e8e


     8

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell





bfictorie

0:8cdad1c73e8e


     9

copies of the Software, and to permit persons to whom the Software is





bfictorie

0:8cdad1c73e8e


    10

furnished to do so, subject to the following conditions:





bfictorie

0:8cdad1c73e8e


    11

 





bfictorie

0:8cdad1c73e8e


    12

The above copyright notice and this permission notice shall be included in





bfictorie

0:8cdad1c73e8e


    13

all copies or substantial portions of the Software.





bfictorie

0:8cdad1c73e8e


    14

 





bfictorie

0:8cdad1c73e8e


    15

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR





bfictorie

0:8cdad1c73e8e


    16

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,





bfictorie

0:8cdad1c73e8e


    17

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE





bfictorie

0:8cdad1c73e8e


    18

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER





bfictorie

0:8cdad1c73e8e


    19

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,





bfictorie

0:8cdad1c73e8e


    20

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN





bfictorie

0:8cdad1c73e8e


    21

THE SOFTWARE.





bfictorie

0:8cdad1c73e8e


    22

*/





bfictorie

0:8cdad1c73e8e


    23







bfictorie

0:8cdad1c73e8e


    24

/** \file





bfictorie

0:8cdad1c73e8e


    25

DNS Request header file





bfictorie

0:8cdad1c73e8e


    26

*/





bfictorie

0:8cdad1c73e8e


    27







bfictorie

0:8cdad1c73e8e


    28

#ifndef DNSREQUEST_H





bfictorie

0:8cdad1c73e8e


    29

#define DNSREQUEST_H





bfictorie

0:8cdad1c73e8e


    30







bfictorie

0:8cdad1c73e8e


    31

#include "core/net.h"





bfictorie

0:8cdad1c73e8e


    32

#include "core/ipaddr.h"





bfictorie

0:8cdad1c73e8e


    33

#include "core/host.h"





bfictorie

0:8cdad1c73e8e


    34

//Essentially it is a safe interface to NetDnsRequest





bfictorie

0:8cdad1c73e8e


    35







bfictorie

0:8cdad1c73e8e


    36

///DNS Request error codes





bfictorie

0:8cdad1c73e8e


    37

enum DNSRequestErr





bfictorie

0:8cdad1c73e8e


    38

{





bfictorie

0:8cdad1c73e8e


    39

  __DNS_MIN = -0xFFFF,





bfictorie

0:8cdad1c73e8e


    40

  DNS_SETUP, ///<DNSRequest not properly configured





bfictorie

0:8cdad1c73e8e


    41

  DNS_IF, ///<Interface has problems, does not exist or is not initialized





bfictorie

0:8cdad1c73e8e


    42

  DNS_MEM, ///<Not enough mem





bfictorie

0:8cdad1c73e8e


    43

  DNS_INUSE, ///<Interface / Port is in use





bfictorie

0:8cdad1c73e8e


    44

  DNS_PROCESSING, ///<Request has not completed





bfictorie

0:8cdad1c73e8e


    45

//...





bfictorie

0:8cdad1c73e8e


    46

  DNS_OK = 0 ///<Success





bfictorie

0:8cdad1c73e8e


    47

};





bfictorie

0:8cdad1c73e8e


    48







bfictorie

0:8cdad1c73e8e


    49

///DNS Request Result Events





bfictorie

0:8cdad1c73e8e


    50

enum DNSReply





bfictorie

0:8cdad1c73e8e


    51

{





bfictorie

0:8cdad1c73e8e


    52

  DNS_PRTCL,





bfictorie

0:8cdad1c73e8e


    53

  DNS_NOTFOUND, ///Hostname is unknown





bfictorie

0:8cdad1c73e8e


    54

  DNS_ERROR, ///Problem with DNS Service





bfictorie

0:8cdad1c73e8e


    55

  //...





bfictorie

0:8cdad1c73e8e


    56

  DNS_FOUND,





bfictorie

0:8cdad1c73e8e


    57

};





bfictorie

0:8cdad1c73e8e


    58







bfictorie

0:8cdad1c73e8e


    59

class NetDnsRequest;





bfictorie

0:8cdad1c73e8e


    60

enum NetDnsReply;





bfictorie

0:8cdad1c73e8e


    61







bfictorie

0:8cdad1c73e8e


    62

///This is a simple DNS Request class





bfictorie

0:8cdad1c73e8e


    63

/**





bfictorie

0:8cdad1c73e8e


    64

  This class exposes an API to deal with DNS Requests





bfictorie

0:8cdad1c73e8e


    65

*/





bfictorie

0:8cdad1c73e8e


    66

class DNSRequest





bfictorie

0:8cdad1c73e8e


    67

{





bfictorie

0:8cdad1c73e8e


    68

public:





bfictorie

0:8cdad1c73e8e


    69

  ///Creates a new request





bfictorie

0:8cdad1c73e8e


    70

  DNSRequest();





bfictorie

0:8cdad1c73e8e


    71

  





bfictorie

0:8cdad1c73e8e


    72

  ///Terminates and closes request





bfictorie

0:8cdad1c73e8e


    73

  ~DNSRequest();





bfictorie

0:8cdad1c73e8e


    74

  





bfictorie

0:8cdad1c73e8e


    75

  ///Resolves an hostname





bfictorie

0:8cdad1c73e8e


    76

  /**





bfictorie

0:8cdad1c73e8e


    77

  @param hostname : hostname to resolve





bfictorie

0:8cdad1c73e8e


    78

  */





bfictorie

0:8cdad1c73e8e


    79

  DNSRequestErr resolve(const char* hostname);





bfictorie

0:8cdad1c73e8e


    80

  





bfictorie

0:8cdad1c73e8e


    81

  ///Resolves an hostname





bfictorie

0:8cdad1c73e8e


    82

  /**





bfictorie

0:8cdad1c73e8e


    83

  @param host : hostname to resolve, the result will be stored in the IpAddr field of this object





bfictorie

0:8cdad1c73e8e


    84

  */





bfictorie

0:8cdad1c73e8e


    85

  DNSRequestErr resolve(Host* pHost);





bfictorie

0:8cdad1c73e8e


    86

  





bfictorie

0:8cdad1c73e8e


    87

  ///Setups callback





bfictorie

0:8cdad1c73e8e


    88

  /**





bfictorie

0:8cdad1c73e8e


    89

  The callback function will be called on result.





bfictorie

0:8cdad1c73e8e


    90

  @param pMethod : callback function





bfictorie

0:8cdad1c73e8e


    91

  */  





bfictorie

0:8cdad1c73e8e


    92

  void setOnReply( void (*pMethod)(DNSReply) );





bfictorie

0:8cdad1c73e8e


    93

  





bfictorie

0:8cdad1c73e8e


    94

  class CDummy;





bfictorie

0:8cdad1c73e8e


    95

  ///Setups callback





bfictorie

0:8cdad1c73e8e


    96

  /**





bfictorie

0:8cdad1c73e8e


    97

  The callback function will be called on result.





bfictorie

0:8cdad1c73e8e


    98

  @param pItem : instance of class on which to execute the callback method





bfictorie

0:8cdad1c73e8e


    99

  @param pMethod : callback method





bfictorie

0:8cdad1c73e8e


   100

  */





bfictorie

0:8cdad1c73e8e


   101

  template<class T> 





bfictorie

0:8cdad1c73e8e


   102

  void setOnReply( T* pItem, void (T::*pMethod)(DNSReply) )





bfictorie

0:8cdad1c73e8e


   103

  {





bfictorie

0:8cdad1c73e8e


   104

    m_pCbItem = (CDummy*) pItem;





bfictorie

0:8cdad1c73e8e


   105

    m_pCbMeth = (void (CDummy::*)(DNSReply)) pMethod;





bfictorie

0:8cdad1c73e8e


   106

  }





bfictorie

0:8cdad1c73e8e


   107

  





bfictorie

0:8cdad1c73e8e


   108

  ///Gets IP address once it has been resolved





bfictorie

0:8cdad1c73e8e


   109

  /**





bfictorie

0:8cdad1c73e8e


   110

  @param pIp : pointer to an IpAddr instance in which to store the resolved IP address





bfictorie

0:8cdad1c73e8e


   111

  */





bfictorie

0:8cdad1c73e8e


   112

  DNSRequestErr getResult(IpAddr* pIp);





bfictorie

0:8cdad1c73e8e


   113

  





bfictorie

0:8cdad1c73e8e


   114

  ///Closes DNS Request before completion





bfictorie

0:8cdad1c73e8e


   115

  DNSRequestErr close();





bfictorie

0:8cdad1c73e8e


   116

  





bfictorie

0:8cdad1c73e8e


   117

protected:





bfictorie

0:8cdad1c73e8e


   118

  void onNetDnsReply(NetDnsReply r);





bfictorie

0:8cdad1c73e8e


   119

  DNSRequestErr checkInst();





bfictorie

0:8cdad1c73e8e


   120







bfictorie

0:8cdad1c73e8e


   121

private:





bfictorie

0:8cdad1c73e8e


   122

  NetDnsRequest* m_pNetDnsRequest;





bfictorie

0:8cdad1c73e8e


   123

  





bfictorie

0:8cdad1c73e8e


   124

  CDummy* m_pCbItem;





bfictorie

0:8cdad1c73e8e


   125

  void (CDummy::*m_pCbMeth)(DNSReply);





bfictorie

0:8cdad1c73e8e


   126

  





bfictorie

0:8cdad1c73e8e


   127

  void (*m_pCb)(DNSReply);





bfictorie

0:8cdad1c73e8e


   128







bfictorie

0:8cdad1c73e8e


   129

};





bfictorie

0:8cdad1c73e8e


   130







bfictorie

0:8cdad1c73e8e


   131

#endif