Daniel Peter / Mbed 2 deprecated cig_httpclient2

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

NetServices/api/DNSRequest.h@0:55680e5cc478, 2011-05-30 (annotated)

Committer:
mbed714
Date:
Mon May 30 12:11:59 2011 +0000
Revision:
0:55680e5cc478

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


mbed714

0:55680e5cc478


     1







mbed714

0:55680e5cc478


     2

/*





mbed714

0:55680e5cc478


     3

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





mbed714

0:55680e5cc478


     4

 





mbed714

0:55680e5cc478


     5

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





mbed714

0:55680e5cc478


     6

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





mbed714

0:55680e5cc478


     7

in the Software without restriction, including without limitation the rights





mbed714

0:55680e5cc478


     8

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





mbed714

0:55680e5cc478


     9

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





mbed714

0:55680e5cc478


    10

furnished to do so, subject to the following conditions:





mbed714

0:55680e5cc478


    11

 





mbed714

0:55680e5cc478


    12

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





mbed714

0:55680e5cc478


    13

all copies or substantial portions of the Software.





mbed714

0:55680e5cc478


    14

 





mbed714

0:55680e5cc478


    15

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





mbed714

0:55680e5cc478


    16

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





mbed714

0:55680e5cc478


    17

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





mbed714

0:55680e5cc478


    18

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





mbed714

0:55680e5cc478


    19

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





mbed714

0:55680e5cc478


    20

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





mbed714

0:55680e5cc478


    21

THE SOFTWARE.





mbed714

0:55680e5cc478


    22

*/





mbed714

0:55680e5cc478


    23







mbed714

0:55680e5cc478


    24

/** \file





mbed714

0:55680e5cc478


    25

DNS Request header file





mbed714

0:55680e5cc478


    26

*/





mbed714

0:55680e5cc478


    27







mbed714

0:55680e5cc478


    28

#ifndef DNSREQUEST_H





mbed714

0:55680e5cc478


    29

#define DNSREQUEST_H





mbed714

0:55680e5cc478


    30







mbed714

0:55680e5cc478


    31

#include "core/net.h"





mbed714

0:55680e5cc478


    32

#include "core/ipaddr.h"





mbed714

0:55680e5cc478


    33

#include "core/host.h"





mbed714

0:55680e5cc478


    34

//Essentially it is a safe interface to NetDnsRequest





mbed714

0:55680e5cc478


    35







mbed714

0:55680e5cc478


    36

///DNS Request error codes





mbed714

0:55680e5cc478


    37

enum DNSRequestErr





mbed714

0:55680e5cc478


    38

{





mbed714

0:55680e5cc478


    39

  __DNS_MIN = -0xFFFF,





mbed714

0:55680e5cc478


    40

  DNS_SETUP, ///<DNSRequest not properly configured





mbed714

0:55680e5cc478


    41

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





mbed714

0:55680e5cc478


    42

  DNS_MEM, ///<Not enough mem





mbed714

0:55680e5cc478


    43

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





mbed714

0:55680e5cc478


    44

  DNS_PROCESSING, ///<Request has not completed





mbed714

0:55680e5cc478


    45

//...





mbed714

0:55680e5cc478


    46

  DNS_OK = 0 ///<Success





mbed714

0:55680e5cc478


    47

};





mbed714

0:55680e5cc478


    48







mbed714

0:55680e5cc478


    49

///DNS Request Result Events





mbed714

0:55680e5cc478


    50

enum DNSReply





mbed714

0:55680e5cc478


    51

{





mbed714

0:55680e5cc478


    52

  DNS_PRTCL,





mbed714

0:55680e5cc478


    53

  DNS_NOTFOUND, ///Hostname is unknown





mbed714

0:55680e5cc478


    54

  DNS_ERROR, ///Problem with DNS Service





mbed714

0:55680e5cc478


    55

  //...





mbed714

0:55680e5cc478


    56

  DNS_FOUND,





mbed714

0:55680e5cc478


    57

};





mbed714

0:55680e5cc478


    58







mbed714

0:55680e5cc478


    59

class NetDnsRequest;





mbed714

0:55680e5cc478


    60

enum NetDnsReply;





mbed714

0:55680e5cc478


    61







mbed714

0:55680e5cc478


    62

///This is a simple DNS Request class





mbed714

0:55680e5cc478


    63

/**





mbed714

0:55680e5cc478


    64

  This class exposes an API to deal with DNS Requests





mbed714

0:55680e5cc478


    65

*/





mbed714

0:55680e5cc478


    66

class DNSRequest





mbed714

0:55680e5cc478


    67

{





mbed714

0:55680e5cc478


    68

public:





mbed714

0:55680e5cc478


    69

  ///Creates a new request





mbed714

0:55680e5cc478


    70

  DNSRequest();





mbed714

0:55680e5cc478


    71

  





mbed714

0:55680e5cc478


    72

  ///Terminates and closes request





mbed714

0:55680e5cc478


    73

  ~DNSRequest();





mbed714

0:55680e5cc478


    74

  





mbed714

0:55680e5cc478


    75

  ///Resolves an hostname





mbed714

0:55680e5cc478


    76

  /**





mbed714

0:55680e5cc478


    77

  @param hostname : hostname to resolve





mbed714

0:55680e5cc478


    78

  */





mbed714

0:55680e5cc478


    79

  DNSRequestErr resolve(const char* hostname);





mbed714

0:55680e5cc478


    80

  





mbed714

0:55680e5cc478


    81

  ///Resolves an hostname





mbed714

0:55680e5cc478


    82

  /**





mbed714

0:55680e5cc478


    83

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





mbed714

0:55680e5cc478


    84

  */





mbed714

0:55680e5cc478


    85

  DNSRequestErr resolve(Host* pHost);





mbed714

0:55680e5cc478


    86

  





mbed714

0:55680e5cc478


    87

  ///Setups callback





mbed714

0:55680e5cc478


    88

  /**





mbed714

0:55680e5cc478


    89

  The callback function will be called on result.





mbed714

0:55680e5cc478


    90

  @param pMethod : callback function





mbed714

0:55680e5cc478


    91

  */  





mbed714

0:55680e5cc478


    92

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





mbed714

0:55680e5cc478


    93

  





mbed714

0:55680e5cc478


    94

  class CDummy;





mbed714

0:55680e5cc478


    95

  ///Setups callback





mbed714

0:55680e5cc478


    96

  /**





mbed714

0:55680e5cc478


    97

  The callback function will be called on result.





mbed714

0:55680e5cc478


    98

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





mbed714

0:55680e5cc478


    99

  @param pMethod : callback method





mbed714

0:55680e5cc478


   100

  */





mbed714

0:55680e5cc478


   101

  template<class T> 





mbed714

0:55680e5cc478


   102

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





mbed714

0:55680e5cc478


   103

  {





mbed714

0:55680e5cc478


   104

    m_pCbItem = (CDummy*) pItem;





mbed714

0:55680e5cc478


   105

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





mbed714

0:55680e5cc478


   106

  }





mbed714

0:55680e5cc478


   107

  





mbed714

0:55680e5cc478


   108

  ///Gets IP address once it has been resolved





mbed714

0:55680e5cc478


   109

  /**





mbed714

0:55680e5cc478


   110

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





mbed714

0:55680e5cc478


   111

  */





mbed714

0:55680e5cc478


   112

  DNSRequestErr getResult(IpAddr* pIp);





mbed714

0:55680e5cc478


   113

  





mbed714

0:55680e5cc478


   114

  ///Closes DNS Request before completion





mbed714

0:55680e5cc478


   115

  DNSRequestErr close();





mbed714

0:55680e5cc478


   116

  





mbed714

0:55680e5cc478


   117

protected:





mbed714

0:55680e5cc478


   118

  void onNetDnsReply(NetDnsReply r);





mbed714

0:55680e5cc478


   119

  DNSRequestErr checkInst();





mbed714

0:55680e5cc478


   120







mbed714

0:55680e5cc478


   121

private:





mbed714

0:55680e5cc478


   122

  NetDnsRequest* m_pNetDnsRequest;





mbed714

0:55680e5cc478


   123

  





mbed714

0:55680e5cc478


   124

  CDummy* m_pCbItem;





mbed714

0:55680e5cc478


   125

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





mbed714

0:55680e5cc478


   126

  





mbed714

0:55680e5cc478


   127

  void (*m_pCb)(DNSReply);





mbed714

0:55680e5cc478


   128







mbed714

0:55680e5cc478


   129

};





mbed714

0:55680e5cc478


   130







mbed714

0:55680e5cc478


   131

#endif