cpp-netlib.github.com/0.8/reference_http_request.html at master · cpp-netlib/cpp-netlib.github.com

History

473 lines (442 loc) · 30.9 KB

Raw

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

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>HTTP Request — cpp-netlib v0.8 documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '',

VERSION: '0.8',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

var _gaq = _gaq || [];

_gaq.push(['_setAccount', 'UA-19815738-1']);

_gaq.push(['_trackPageview']);

(function() {

var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';

var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);

})();

</script>

</head>

<body>

<h1><a href="index.html">cpp-netlib v0.8 documentation</a></h1>

« <a href="reference_http_client.html" title="HTTP Client API">previous</a>

</div>

<h1>HTTP Request<a class="headerlink" href="#http-request" title="Permalink to this headline">¶</a></h1>

This part of the documentation talks about the publicly accessible API of the

HTTP Request objects. This section details the <a class="reference internal" href="#request-concepts">Request Concepts</a> requirements,

the implemented and required <a class="reference internal" href="#directives">Directives</a>, <a class="reference internal" href="#modifiers">Modifiers</a>, and <a class="reference internal" href="#wrappers">Wrappers</a> that work

with the HTTP Request objects.

<h2>Request Concepts<a class="headerlink" href="#request-concepts" title="Permalink to this headline">¶</a></h2>

There are two generally supported Request Concepts implemented in the library.

The first of two is the <a class="reference internal" href="#normal-client-request-concept">Normal Client Request Concept</a> and the second is the

<a class="reference internal" href="#pod-server-request-concept">Pod Server Request Concept</a>.

The <a class="reference internal" href="#normal-client-request-concept">Normal Client Request Concept</a> is what the HTTP Client interface requires.

All operations performed internally by the HTTP Client abide by the interface

required by this concept definition.

The <a class="reference internal" href="#pod-server-request-concept">Pod Server Request Concept</a> is as the name suggests what the HTTP Server

implementation requires from Request Objects.

Switching on whether the <cite>Request</cite> concept chooses either of the <a class="reference internal" href="#normal-client-request-concept">Normal Client

Request Concept</a> or the <a class="reference internal" href="#pod-server-request-concept">Pod Server Request Concept</a> is done through the

nested <tt class="docutils literal">tag</tt> type and whether that tag derives from the root tag <tt class="docutils literal">pod</tt>.

Simply, if the Request type’s nested <tt class="docutils literal">tag</tt> type derives from

<tt class="docutils literal">boost::network::tags::pod</tt> then it chooses to enforce the <a class="reference internal" href="#pod-server-request-concept">Pod Server Request

Concept</a>, otherwise it chooses the <a class="reference internal" href="#normal-client-request-concept">Normal Client Request Concept</a>.

<h3>Normal Client Request Concept<a class="headerlink" href="#normal-client-request-concept" title="Permalink to this headline">¶</a></h3>

A type models the Normal Client Request Concept if it models the <a class="reference external" href="message.html#message-concept">Message

Concept</a> and also supports the following constructs.

Legend

<tr class="field"><th class="field-name">R:</th><td class="field-body">The request type.</td>

</tr>

<tr class="field"><th class="field-name">r:</th><td class="field-body">An instance of R.</td>

</tr>

<tr class="field"><th class="field-name">S:</th><td class="field-body">The string type.</td>

</tr>

<tr class="field"><th class="field-name">s:</th><td class="field-body">An instance of S.</td>

</tr>

</tr>

<tr class="field"><th class="field-name">p:</th><td class="field-body">An instance of P.</td>

</tr>

</tbody>

</table>

</colgroup>

<tr><th class="head">Construct</th>

<th class="head">Result</th>

<th class="head">Description</th>

</tr>

</thead>

<tr><td><tt class="docutils literal">R::string_type</tt></td>

<td>The nested <tt class="docutils literal">string_type</tt> type.</td>

</tr>

<td>The nested <tt class="docutils literal">port_type</tt> type.</td>

</tr>

<td>Construct a Request with an <tt class="docutils literal">s</tt>

provided. This treats <tt class="docutils literal">s</tt> as the URI

to where the request is destined for.</td>

</tr>

<tr><td><tt class="docutils literal">host(request)</tt></td>

<td>Convertible

to <tt class="docutils literal">S</tt></td>

<td>Return the host to where the request

is destined for.</td>

</tr>

<tr><td><tt class="docutils literal">port(request)</tt></td>

<td>Convertible

to <tt class="docutils literal">P</tt></td>

<td>Return the port to where the request

is destined for.</td>

</tr>

<tr><td><tt class="docutils literal">path(request)</tt></td>

<td>Convertible

to <tt class="docutils literal">S</tt></td>

<td>Return the path included in the URI.</td>

</tr>

<tr><td><tt class="docutils literal">query(request)</tt></td>

<td>Convertible

to <tt class="docutils literal">S</tt></td>

<td>Return the query part of the URI.</td>

</tr>

<tr><td><tt class="docutils literal">anchor(request)</tt></td>

<td>Convertible

to <tt class="docutils literal">S</tt></td>

<td>Return the anchor part of the URI.</td>

</tr>

<tr><td><tt class="docutils literal">protocol(request)</tt></td>

<td>Convertible

to <tt class="docutils literal">S</tt></td>

<td>Return the protocol/scheme part of the

URI.</td>

</tr>

<td>Set the URI of the request.</td>

</tr>

<td>Set the URI of the request.</td>

</tr>

</tbody>

</table>

</div>

<h3>Pod Server Request Concept<a class="headerlink" href="#pod-server-request-concept" title="Permalink to this headline">¶</a></h3>

A type models the Pod Server Request Concept if it models the <a class="reference external" href="message.html#message-concept">Message Concept</a>

and also supports the following constructs.

Legend

<tr class="field"><th class="field-name">R:</th><td class="field-body">The request type.</td>

</tr>

<tr class="field"><th class="field-name">r:</th><td class="field-body">An instance of R.</td>

</tr>

<tr class="field"><th class="field-name">S:</th><td class="field-body">The string type.</td>

</tr>

<tr class="field"><th class="field-name">I:</th><td class="field-body">An unsigned 8 bit integer.</td>

</tr>

<tr class="field"><th class="field-name">V:</th><td class="field-body">The vector type for headers.</td>

</tr>

</tbody>

</table>

</colgroup>

<tr><th class="head">Construct</th>

<th class="head">Result</th>

<th class="head">Description</th>

</tr>

</thead>

<tr><td><tt class="docutils literal">R::string_type</tt></td>

<td>The nested <tt class="docutils literal">string_type</tt> type.</td>

</tr>

<tr><td><tt class="docutils literal">R::headers_container_type</tt></td>

<td>The nested

<tt class="docutils literal">headers_container_type</tt> type.</td>

</tr>

<tr><td><tt class="docutils literal">r.source</tt></td>

<td>The nested source of the request.</td>

</tr>

<tr><td><tt class="docutils literal">r.method</tt></td>

<td>The method of the request.</td>

</tr>

<tr><td><tt class="docutils literal">r.destination</tt></td>

<td>The destination of the request.

This is normally the URI of the

request.</td>

</tr>

<tr><td><tt class="docutils literal">r.version_major</tt></td>

<td>The major version number part of

the request.</td>

</tr>

<tr><td><tt class="docutils literal">r.version_minor</tt></td>

<td>The minor version number part of

the request.</td>

</tr>

<tr><td><tt class="docutils literal">r.headers</tt></td>

<td>The vector of headers.</td>

</tr>

<td>The body of the request.</td>

</tr>

</tbody>

</table>

</div>

<h2>Directives<a class="headerlink" href="#directives" title="Permalink to this headline">¶</a></h2>

This section details the provided directives that are provided by

<tt class="xref py py-mod docutils literal">cpp-netlib</tt>. The section was written to assume that an appropriately

constructed request instance is either of the following:

<div class="highlight-c++"><div class="highlight"><pre>boost::network::http::basic_request<

boost::network::http::tags::http_default_8bit_udp_resolve

> request;

// or

> request;

</pre></div>

</div>

The section also assumes that there following using namespace declaration is in

effect:

<div class="highlight-c++"><div class="highlight"><pre>using namespace boost::network;

</pre></div>

</div>

Directives are meant to be used in the following manner:

<div class="highlight-c++"><div class="highlight"><pre>request << directive(...);

</pre></div>

</div>

Warning

There are two versions of directives, those that are applicable to

messages that support narrow strings (<tt class="docutils literal">std::string</tt>) and those that are

applicable to messages that support wide strings (<tt class="docutils literal">std::wstring</tt>). The

<tt class="xref py py-mod docutils literal">cpp-netlib</tt> implementation still does not convert wide strings into

UTF-8 encoded narrow strings. This will be implemented in subsequent

library releases.

For now all the implemented directives are listed, even if some of them still

do not implement things correctly.

</div>

<dt>unspecified <tt class="docutils literal">source(std::string const & source_)</tt></dt>

<dd>Create a source directive with a <tt class="docutils literal">std::string</tt> as a parameter, to be set

as the source of the request.</dd>

<dt>unspecified <tt class="docutils literal">source(std::wstring const & source_)</tt></dt>

<dd>Create a source directive with a <tt class="docutils literal">std::wstring</tt> as a parameter, to be set

as the source of the request.</dd>

<dt>unspecified <tt class="docutils literal">destination(std::string const & source_)</tt></dt>

<dd>Create a destination directive with a <tt class="docutils literal">std::string</tt> as a parameter, to be

set as the destination of the request.</dd>

<dt>unspecified <tt class="docutils literal">destination(std::wstring const & source_)</tt></dt>

<dd>Create a destination directive with a <tt class="docutils literal">std::wstring</tt> as a parameter, to be

set as the destination of the request.</dd>

<dt>unspecified <tt class="docutils literal">header(std::string const & name, std::string const & value)</tt></dt>

<dd>Create a header directive that will add the given name and value pair to the

headers already associated with the request. In this case the name and

values are both <tt class="docutils literal">std::string</tt>.</dd>

<dt>unspecified <tt class="docutils literal">header(std::wstring const & name, std::wstring const & value)</tt></dt>

<dd>Create a header directive that will add the given name and value pair to the

headers already associated with the request. In this case the name and

values are both <tt class="docutils literal">std::wstring</tt>.</dd>

<dt>unspecified <tt class="docutils literal">remove_header(std::string const & name)</tt></dt>

<dd>Create a remove_header directive that will remove all the occurences of the

given name from the headers already associated with the request. In this

case the name of the header is of type <tt class="docutils literal">std::string</tt>.</dd>

<dt>unspecified <tt class="docutils literal">remove_header(std::wstring const & name)</tt></dt>

<dd>Create a remove_header directive that will remove all the occurences of the

given name from the headers already associated with the request. In this

case the name of the header is of type <tt class="docutils literal">std::wstring</tt>.</dd>

<dt>unspecified <tt class="docutils literal">body(std::string const & body_)</tt></dt>

<dd>Create a body directive that will set the request’s body to the given

parameter. In this case the type of the body is an <tt class="docutils literal">std::string</tt>.</dd>

<dt>unspecified <tt class="docutils literal">body(std::wstring const & body_)</tt></dt>

<dd>Create a body directive that will set the request’s body to the given

parameter. In this case the type of the body is an <tt class="docutils literal">std::wstring</tt>.</dd>

</dl>

</div>

<h2>Modifiers<a class="headerlink" href="#modifiers" title="Permalink to this headline">¶</a></h2>

This section details the provided modifiers that are provided by

<tt class="xref py py-mod docutils literal">cpp-netlib</tt>.

<dt><tt class="docutils literal">template <class Tag> inline void source(basic_request<Tag> & request, typename string<Tag>::type const & source_)</tt></dt>

<dd>Modifies the source of the given <tt class="docutils literal">request</tt>. The type of <tt class="docutils literal">source_</tt> is

dependent on the <tt class="docutils literal">Tag</tt> specialization of <tt class="docutils literal">basic_request</tt>.</dd>

<dt><tt class="docutils literal">template <class Tag> inline void destination(basic_request<Tag> & request, typename string<Tag>::type const & destination_)</tt></dt>

<dd>Modifies the destination of the given <tt class="docutils literal">request</tt>. The type of <tt class="docutils literal">destination_</tt> is

dependent on the <tt class="docutils literal">Tag</tt> specialization of <tt class="docutils literal">basic_request</tt>.</dd>

<dt><tt class="docutils literal">template <class Tag> inline void add_header(basic_request<Tag> & request, typename string<Tag>::type const & name, typename string<Tag>::type const & value)</tt></dt>

<dd>Adds a header to the given <tt class="docutils literal">request</tt>. The type of the <tt class="docutils literal">name</tt> and

<tt class="docutils literal">value</tt> parameters are dependent on the <tt class="docutils literal">Tag</tt> specialization of

<tt class="docutils literal">basic_request</tt>.</dd>

<dt><tt class="docutils literal">template <class Tag> inline void remove_header(basic_request<Tag> & request, typename string<Tag>::type const & name)</tt></dt>

<dd>Removes a header from the given <tt class="docutils literal">request</tt>. The type of the <tt class="docutils literal">name</tt>

parameter is dependent on the <tt class="docutils literal">Tag</tt> specialization of <tt class="docutils literal">basic_request</tt>.</dd>

<dd>Removes all headers from the given <tt class="docutils literal">request</tt>.</dd>

<dt><tt class="docutils literal">template <class Tag> inline void body(basic_request<Tag> & request, typename string<Tag>::type const & body_)</tt></dt>

<dd>Modifies the body of the given <tt class="docutils literal">request</tt>. The type of <tt class="docutils literal">body_</tt> is

dependent on the <tt class="docutils literal">Tag</tt> specialization of <tt class="docutils literal">basic_request</tt>.</dd>

</dl>

</div>

<h2>Wrappers<a class="headerlink" href="#wrappers" title="Permalink to this headline">¶</a></h2>

This section details the provided request wrappers that come with

<tt class="xref py py-mod docutils literal">cpp-netlib</tt>. Wrappers are used to convert a message into a different type,

usually providing accessor operations to retrieve just part of the message. This

section assumes that the following using namespace directives are in

effect:

using namespace boost::network::http;

</pre></div>

</div>

<dt><tt class="docutils literal">template <class Tag></tt> unspecified <tt class="docutils literal">source(basic_request<Tag> const & request)</tt></dt>

<dd>Returns a wrapper convertible to <tt class="docutils literal">typename string<Tag>::type</tt> that

provides the source of a given request.</dd>

<dt><tt class="docutils literal">template <class Tag></tt> unspecified <tt class="docutils literal">destination(basic_request<Tag> const & request)</tt></dt>

<dd>Returns a wrapper convertible to <tt class="docutils literal">typename string<Tag>::type</tt> that

provides the destination of a given request.</dd>

<dt><tt class="docutils literal">template <class Tag></tt> unspecified <tt class="docutils literal">headers(basic_request<Tag> const & request)</tt></dt>

<dd>Returns a wrapper convertible to <tt class="docutils literal">typename headers_range<basic_request<Tag>

>::type</tt> or <tt class="docutils literal">typename basic_request<Tag>::headers_container_type</tt> that

provides the headers of a given request.</dd>

<dt><tt class="docutils literal">template <class Tag></tt> unspecified <tt class="docutils literal">body(basic_request<Tag> const & request)</tt></dt>

<dd>Returns a wrapper convertible to <tt class="docutils literal">typename string<Tag>::type</tt> that

provides the body of a given request.</dd>

</dl>

</div>

<h3><a href="index.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">HTTP Request</a><ul>

<li><a class="reference internal" href="#request-concepts">Request Concepts</a><ul>

<li><a class="reference internal" href="#normal-client-request-concept">Normal Client Request Concept</a></li>

<li><a class="reference internal" href="#pod-server-request-concept">Pod Server Request Concept</a></li>

</ul>

</li>

<li><a class="reference internal" href="#directives">Directives</a></li>

<li><a class="reference internal" href="#modifiers">Modifiers</a></li>

<li><a class="reference internal" href="#wrappers">Wrappers</a></li>

</ul>

</li>

</ul>

<h3>Browse</h3>

<ul>

<li>Prev: <a href="reference_http_client.html">HTTP Client API</a></li>

<li>Next: <a href="reference_http_response.html">HTTP Response</a></li>

</ul>

<ul>

<li>

<a href="index.html">cpp-netlib v0.8 documentation</a>

<ul><li><a href="reference.html">Reference Manual</a>

<ul><li>HTTP Request</li></ul>

</li></ul>

</li>

</ul>

<li><a href="_sources/reference_http_request.txt"

rel="nofollow">Show Source</a></li>

</ul>

<h3>Quick search</h3>

</form>

Enter search terms or a module, class or function name.

</div>

</div>

« <a href="reference_http_client.html" title="HTTP Client API">previous</a>

</div>

</div>

documentation automatically generated by <a href="http://sphinx.pocoo.org">Sphinx</a> | style mostly stolen from <a href="http://lettuce.it">lettuce.it</a>

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

reference_http_request.html

Latest commit

History

reference_http_request.html

File metadata and controls