NetServices - NetTribute library with debug turned on in FShand…

Users » hexley » Code » NetServices

NetTribute library with debug turned on in FShandler Donatien Garner -> Segundo Equipo -> this version

api/DNSRequest.h@0:281d6ff68967, 2010-11-19 (annotated)

Committer:: hexley
Date:: Fri Nov 19 01:54:45 2010 +0000
Revision:: 0:281d6ff68967

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	19 Nov 2010
Imports:	44
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	0
Followers:	1

api/DNSRequest.h@0:281d6ff68967, 2010-11-19 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning