pp::HostResolver Class Reference

#include <host_resolver.h>

Inheritance diagram for pp::HostResolver:

Collaboration diagram for pp::HostResolver:

Public Member Functions
	HostResolver ()
	HostResolver (const InstanceHandle &instance)
	HostResolver (PassRef, PP_Resource resource)
	HostResolver (const HostResolver &other)
virtual	~HostResolver ()
	The destructor. More...
HostResolver &	operator= (const HostResolver &other)
int32_t	Resolve (const char *host, uint16_t port, const PP_HostResolver_Hint &hint, const CompletionCallback &callback)
Var	GetCanonicalName () const
uint32_t	GetNetAddressCount () const
NetAddress	GetNetAddress (uint32_t index) const
Public Member Functions inherited from pp::Resource
	Resource ()
	The default constructor. More...
	Resource (const Resource &other)
virtual	~Resource ()
	Destructor. More...
Resource &	operator= (const Resource &other)
bool	is_null () const
PP_Resource	pp_resource () const
PP_Resource	detach ()

Static Public Member Functions
static bool	IsAvailable ()

Additional Inherited Members
Protected Member Functions inherited from pp::Resource
	Resource (PP_Resource resource)
	Resource (PassRef, PP_Resource resource)
void	PassRefFromConstructor (PP_Resource resource)

Detailed Description

The HostResolver class supports host name resolution.

Permissions: In order to run Resolve(), apps permission socket with subrule resolve-host is required. For more details about network communication permissions, please see: http://developer.chrome.com/apps/app_network.html

Definition at line 26 of file host_resolver.h.

Constructor & Destructor Documentation

pp::HostResolver::HostResolver

(

)

Default constructor for creating an is_null() HostResolver object.

pp::HostResolver::HostResolver ( const InstanceHandle &  instance )

explicit

A constructor used to create a HostResolver object.

Parameters

[in]

instance

The instance with which this resource will be associated.

pp::HostResolver::HostResolver	(	PassRef	,
		PP_Resource	resource
	)

A constructor used when you have received a PP_Resource as a return value that has had 1 ref added for you.

Parameters

[in]

resource

A PPB_HostResolver resource.

pp::HostResolver::HostResolver

(

const HostResolver &

other

)

The copy constructor for HostResolver.

Parameters

[in]

other

A reference to another HostResolver.

virtual pp::HostResolver::~HostResolver ( )

virtual

The destructor.

Member Function Documentation

Var pp::HostResolver::GetCanonicalName

(

)

const

Gets the canonical name of the host.

Returns

A string Var on success, which is an empty string if PP_HOSTRESOLVER_FLAG_CANONNAME is not set in the hint flags when calling Resolve(); an undefined Var if there is a pending Resolve() call or the previous Resolve() call failed.

NetAddress pp::HostResolver::GetNetAddress

(

uint32_t

index

)

const

Gets a network address.

Parameters

[in]

index

An index indicating which address to return.

Returns

A NetAddress object. The object will be null (i.e., is_null() returns true) if there is a pending Resolve() call or the previous Resolve() call failed, or the specified index is out of range.

uint32_t pp::HostResolver::GetNetAddressCount

(

)

const

Gets the number of network addresses.

Returns

The number of available network addresses on success; 0 if there is a pending Resolve() call or the previous Resolve() call failed.

static bool pp::HostResolver::IsAvailable ( )

static

Static function for determining whether the browser supports the PPB_HostResolver interface.

Returns

true if the interface is available, false otherwise.

HostResolver& pp::HostResolver::operator=

(

const HostResolver &

other

)

The assignment operator for HostResolver.

Parameters

[in]

other

A reference to another HostResolver.

Returns

A reference to this HostResolver object.

int32_t pp::HostResolver::Resolve	(	const char *	host,
		uint16_t	port,
		const PP_HostResolver_Hint &	hint,
		const CompletionCallback &	callback
	)

Requests resolution of a host name. If the call completes successully, the results can be retrieved by GetCanonicalName(), GetNetAddressCount() and GetNetAddress().

Parameters

[in]	host	The host name (or IP address literal) to resolve.
[in]	port	The port number to be set in the resulting network addresses.
[in]	hint	A PP_HostResolver_Hint structure providing hints for host resolution.
[in]	callback	A CompletionCallback to be called upon completion.

Returns

An int32_t containing an error code from pp_errors.h. PP_ERROR_NOACCESS will be returned if the caller doesn't have required permissions. PP_ERROR_NAME_NOT_RESOLVED will be returned if the host name couldn't be resolved.

---

The documentation for this class was generated from the following file:

• host_resolver.h