1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/* Copyright 2013 The Chromium Authors
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/* From ppb_host_resolver.idl modified Sat Jun 22 11:11:38 2013. */
#ifndef PPAPI_C_PPB_HOST_RESOLVER_H_
#define PPAPI_C_PPB_HOST_RESOLVER_H_
#include "ppapi/c/pp_bool.h"
#include "ppapi/c/pp_completion_callback.h"
#include "ppapi/c/pp_instance.h"
#include "ppapi/c/pp_macros.h"
#include "ppapi/c/pp_resource.h"
#include "ppapi/c/pp_stdint.h"
#include "ppapi/c/pp_var.h"
#include "ppapi/c/ppb_net_address.h"
#define PPB_HOSTRESOLVER_INTERFACE_1_0 "PPB_HostResolver;1.0"
#define PPB_HOSTRESOLVER_INTERFACE PPB_HOSTRESOLVER_INTERFACE_1_0
/**
* @file
* This file defines the <code>PPB_HostResolver</code> interface.
*/
/**
* @addtogroup Enums
* @{
*/
/**
* <code>PP_HostResolver_Flag</code> is an enumeration of flags which can be
* OR-ed and passed to the host resolver. Currently there is only one flag
* defined.
*/
typedef enum {
/**
* Hint to request the canonical name of the host, which can be retrieved by
* <code>GetCanonicalName()</code>.
*/
PP_HOSTRESOLVER_FLAG_CANONNAME = 1 << 0
} PP_HostResolver_Flag;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_HostResolver_Flag, 4);
/**
* @}
*/
/**
* @addtogroup Structs
* @{
*/
/**
* <code>PP_HostResolver_Hint</code> represents hints for host resolution.
*/
struct PP_HostResolver_Hint {
/**
* Network address family.
*/
PP_NetAddress_Family family;
/**
* Combination of flags from <code>PP_HostResolver_Flag</code>.
*/
int32_t flags;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_HostResolver_Hint, 8);
/**
* @}
*/
/**
* @addtogroup Interfaces
* @{
*/
/**
* The <code>PPB_HostResolver</code> interface supports host name
* resolution.
*
* Permissions: In order to run <code>Resolve()</code>, apps permission
* <code>socket</code> with subrule <code>resolve-host</code> is required.
* For more details about network communication permissions, please see:
* http://developer.chrome.com/apps/app_network.html
*/
struct PPB_HostResolver_1_0 {
/**
* Creates a host resolver resource.
*
* @param[in] instance A <code>PP_Instance</code> identifying one instance of
* a module.
*
* @return A <code>PP_Resource</code> corresponding to a host reslover or 0
* on failure.
*/
PP_Resource (*Create)(PP_Instance instance);
/**
* Determines if a given resource is a host resolver.
*
* @param[in] resource A <code>PP_Resource</code> to check.
*
* @return <code>PP_TRUE</code> if the input is a
* <code>PPB_HostResolver</code> resource; <code>PP_FALSE</code> otherwise.
*/
PP_Bool (*IsHostResolver)(PP_Resource resource);
/**
* Requests resolution of a host name. If the call completes successfully, the
* results can be retrieved by <code>GetCanonicalName()</code>,
* <code>GetNetAddressCount()</code> and <code>GetNetAddress()</code>.
*
* @param[in] host_resolver A <code>PP_Resource</code> corresponding to a host
* resolver.
* @param[in] host The host name (or IP address literal) to resolve.
* @param[in] port The port number to be set in the resulting network
* addresses.
* @param[in] hint A <code>PP_HostResolver_Hint</code> structure providing
* hints for host resolution.
* @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
* completion.
*
* @return An int32_t containing an error code from <code>pp_errors.h</code>.
* <code>PP_ERROR_NOACCESS</code> will be returned if the caller doesn't have
* required permissions. <code>PP_ERROR_NAME_NOT_RESOLVED</code> will be
* returned if the host name couldn't be resolved.
*/
int32_t (*Resolve)(PP_Resource host_resolver,
const char* host,
uint16_t port,
const struct PP_HostResolver_Hint* hint,
struct PP_CompletionCallback callback);
/**
* Gets the canonical name of the host.
*
* @param[in] host_resolver A <code>PP_Resource</code> corresponding to a host
* resolver.
*
* @return A string <code>PP_Var</code> on success, which is an empty string
* if <code>PP_HOSTRESOLVER_FLAG_CANONNAME</code> is not set in the hint flags
* when calling <code>Resolve()</code>; an undefined <code>PP_Var</code> if
* there is a pending <code>Resolve()</code> call or the previous
* <code>Resolve()</code> call failed.
*/
struct PP_Var (*GetCanonicalName)(PP_Resource host_resolver);
/**
* Gets the number of network addresses.
*
* @param[in] host_resolver A <code>PP_Resource</code> corresponding to a host
* resolver.
*
* @return The number of available network addresses on success; 0 if there is
* a pending <code>Resolve()</code> call or the previous
* <code>Resolve()</code> call failed.
*/
uint32_t (*GetNetAddressCount)(PP_Resource host_resolver);
/**
* Gets a network address.
*
* @param[in] host_resolver A <code>PP_Resource</code> corresponding to a host
* resolver.
* @param[in] index An index indicating which address to return.
*
* @return A <code>PPB_NetAddress</code> resource on success; 0 if there is a
* pending <code>Resolve()</code> call or the previous <code>Resolve()</code>
* call failed, or the specified index is out of range.
*/
PP_Resource (*GetNetAddress)(PP_Resource host_resolver, uint32_t index);
};
typedef struct PPB_HostResolver_1_0 PPB_HostResolver;
/**
* @}
*/
#endif /* PPAPI_C_PPB_HOST_RESOLVER_H_ */
|
