|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE concept |
|
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
|
12 <concept id="GUID-4ACEA6B0-CA7C-5751-A1B6-283287552A31" xml:lang="en"><title>HTTP |
|
13 Whole Message Filter Overview</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <section id="GUID-F92DE930-90BF-4292-8832-02BA1309E09D"><title>Purpose</title> <p>The HTTP Whole Message Filter APIs makes |
|
15 it easier for mobile browser developers to meet the needs of the mobile network |
|
16 operators who support specific Web Accelerators. This results in a faster |
|
17 and much improved Web browsing experience. </p> </section> |
|
18 <section id="GUID-63F035E3-36B3-494C-95A3-33956B54E1E9"><title>Required background</title> <p>Users of this API must be familiar |
|
19 with the HTTP Transport Framework and the Web Acceleration protocol to be |
|
20 implemented. </p> </section> |
|
21 <section id="GUID-DC4C88D2-34BF-4704-ACED-DEAFACA6859C"><title>Key concepts</title> <p>The following are the key concepts |
|
22 that are associated with HTTP Whole Message Filter APIs: </p> <dl> |
|
23 <dlentry> |
|
24 <dt>HTTP Whole Message Filter APIs</dt> |
|
25 <dd><p>Enables you to insert a filter into an HTTP session or an individual |
|
26 transaction when the complete message is formed and before the message is |
|
27 being dispatched. The APIs also operate on incoming HTTP responses before |
|
28 the actual parsing of the HTTP response happens. The use of the HTTP Whole |
|
29 Message Filter APIs enable you to achieve Web Acceleration on Symbian platform |
|
30 based mobile browser applications. </p> </dd> |
|
31 </dlentry> |
|
32 <dlentry> |
|
33 <dt>Web Acceleration</dt> |
|
34 <dd><p>The process of optimising the HTTP data to enhance the speed at which |
|
35 data is transferred over the mobile network. Web Acceleration is achieved |
|
36 by the use of encoding and decoding mechanisms supported by the HTTP Whole |
|
37 Message Filter APIs. The HTTP Whole Message Filter APIs are included as part |
|
38 of the HTTP Protocol Handler in the HTTP Transport Framework. </p> </dd> |
|
39 </dlentry> |
|
40 <dlentry> |
|
41 <dt> Encoding mechanism</dt> |
|
42 <dd><p>This mechanism converts the HTTP request data to a network optimisation |
|
43 protocol format before it is sent across the TCP connection. </p> </dd> |
|
44 </dlentry> |
|
45 <dlentry> |
|
46 <dt> Decoding mechanism</dt> |
|
47 <dd><p>This mechanism converts the HTTP response data in the network optimisation |
|
48 protocol format back to the standard HTTP response data format. </p> </dd> |
|
49 </dlentry> |
|
50 </dl> </section> |
|
51 <section id="GUID-46189E5D-A350-40E0-AC0D-37BA69D211A6"><title>API Summary</title> <p>The following table lists the HTTP |
|
52 Whole Message Filter APIs that are included in the HTTP Transport Framework |
|
53 to enable Web Acceleration support on a Symbian platform based mobile browser |
|
54 application: </p> <table id="GUID-41857A21-0437-5FC8-9844-83861501B6D1"> |
|
55 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
56 <tbody> |
|
57 <row> |
|
58 <entry><p> <b>API</b> </p> </entry> |
|
59 <entry><p> <b>Description</b> </p> </entry> |
|
60 </row> |
|
61 <row> |
|
62 <entry><p> <codeph>MHTTPDataOptimiser</codeph> </p> </entry> |
|
63 <entry><p>An interface that can be derived to implement custom encoding and |
|
64 decoding mechanisms. </p> </entry> |
|
65 </row> |
|
66 <row> |
|
67 <entry><p> <b>Functions included in the MHTTPDataOptimiser interface </b> </p> </entry> |
|
68 </row> |
|
69 <row> |
|
70 <entry><p> <codeph>EncodeL(…) </codeph> </p> </entry> |
|
71 <entry><p>Converts the HTTP request data to a network optimisation protocol |
|
72 format. </p> </entry> |
|
73 </row> |
|
74 <row> |
|
75 <entry><p> <codeph> DecodeL(…) </codeph> </p> </entry> |
|
76 <entry><p>Converts the HTTP response data in the network optimisation protocol |
|
77 format back to the standard HTTP response data format. </p> </entry> |
|
78 </row> |
|
79 <row> |
|
80 <entry><p> <b>Functions included in the RHTTPSession class </b> </p> </entry> |
|
81 </row> |
|
82 <row> |
|
83 <entry><p> <codeph>RHTTPSession::SetupHTTPDataOptimiser |
|
84 (MHTTPDataOptimiser& aHTTPOmtimiser);</codeph> </p> </entry> |
|
85 <entry><p>Sets the <codeph>MHTTPDataOptimiser</codeph> reference for the session |
|
86 object. </p> </entry> |
|
87 </row> |
|
88 <row> |
|
89 <entry><p> <codeph>MHTTPDataOptimiser* RHTTPSession::HTTPDataOptimiser |
|
90 ();</codeph> </p> </entry> |
|
91 <entry><p>Returns a pointer to the <codeph>MHTTPDataOptimiser</codeph> implementation |
|
92 object. </p> </entry> |
|
93 </row> |
|
94 <row> |
|
95 <entry><p> <b>Functions included in the RHTTPTransaction class </b> </p> </entry> |
|
96 </row> |
|
97 <row> |
|
98 <entry><p> <codeph>RHTTPTransaction::SetupHTTPDataOptimiser |
|
99 (MHTTPDataOptimiser& aHTTPOmtimiser);</codeph> </p> </entry> |
|
100 <entry><p>Sets the <codeph>MHTTPDataOptimiser</codeph> reference for the transaction |
|
101 object. </p> </entry> |
|
102 </row> |
|
103 <row> |
|
104 <entry><p> <codeph>MHTTPDataOptimiser* RHTTPTransaction::HTTPDataOptimiser |
|
105 ();</codeph> </p> </entry> |
|
106 <entry><p>Returns a pointer to the <codeph>MHTTPDataOptimiser</codeph> implementation |
|
107 object. </p> </entry> |
|
108 </row> |
|
109 </tbody> |
|
110 </tgroup> |
|
111 </table> </section> |
|
112 </conbody><related-links> |
|
113 <link href="GUID-F0ABCDE5-F818-526A-81EB-E2D4D87E3231.dita"><linktext>How to Use |
|
114 the HTTP Whole Message Filter APIs</linktext></link> |
|
115 <link href="GUID-B4A54501-4AA4-5ACB-96D7-4427C7752639.dita"><linktext>Using HTTP |
|
116 Client</linktext></link> |
|
117 </related-links></concept> |