View source

__NOTOC__
__NOEDITSECTION__
{{KBTS}}
{{KnowledgeBase
|id=TSS001388
|platform=S60 3rd Edition FP1, FP2
|devices=Tested on Nokia N95, N78
|category=Symbian C++
|subcategory=Browsing
|creationdate=June 12, 2009
|keywords=RHTTPSession, RHTTPFilterCollection
}}


== Description ==
The HTTP Filter Plugins sit between the HTTP Framework and the client and are loaded whenever there is a HTTP Session on the device. The filter receives all the transaction events that take place between the client and the HTTP framework and can be used to manipulate them. Thus it's also possible to even stop a transaction and send a dummy HTTP response to the client.

== Solution ==

A HTTP Transaction encapsulates a HTTP request and a response.
The code snippet given below shows how to cancel the HTTP request received from the client.

<code>
    iTransaction = aTransaction;    //take a copy of the transaction 
    aTransaction.Cancel(iFilterHandle); //cancel the transaction
</code>

The transaction's response object can then be set with our own headers and body and the function <tt>RHTTPTransaction::SendEventL()</tt> is used to send the response events. The code snippet given below illustrates this:

<code>
 RHTTPResponse resp = iTransaction.Response();
 //Sending response headers
 RHTTPHeaders hdrs = resp.GetHeaderCollection();
 RStringF valStr = iSession.StringPool().OpenFStringL( KContenttype );
 THTTPHdrVal val( valStr );
 hdrs.SetFieldL( iSession.StringPool().StringF( HTTP::EContentType,
 RHTTPSession::GetTable()), val );
 RStringF okStr = iSession.StringPool().OpenFStringL(KOk);
 iTransaction.Response().SetStatusCode(200);
 iTransaction.Response().SetStatusText(okStr);
 iTransaction.SendEventL(THTTPEvent::EGotResponseHeaders, THTTPEvent::EIncoming, iFilterHandle);
 valStr.Close();
 okStr.Close();	
</code>

Sending response body 
<code>
 resp.SetBody(*this);			
 iTransaction.SendEventL(THTTPEvent::EGotResponseBodyData, THTTPEvent::EIncoming, iFilterHandle);
</code>

Sending response complete event
<code>
 iTransaction.SendEventL(THTTPEvent::EResponseComplete,  THTTPEvent::EIncoming, iFilterHandle);
</code>	

Sending transaction succeed event
<code>
 iTransaction.SendEventL(THTTPEvent::ESucceeded, THTTPEvent::EIncoming, iFilterHandle);
</code>

Please note that the events must be sent in the above sequence for the transaction to succeed.

'''NOTE:''' HTTP filters require an extensive set of capabilities, including <tt>NetworkControl</tt>. See the below example application for details.

== Example Application ==
http://wiki.forum.nokia.com/index.php/Image:Filter.zip

[[Category:Symbian C++]][[Category:S60 3rd Edition ]][[Category:S60 3rd Edition, Feature Pack 1 ]][[Category:S60 3rd Edition, Feature Pack 2 ]][[Category:Browsing]][[Category:Technical Solution]]