Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/example_inet_prot_util_8h_source.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: examples/AppProts/InetProtUtil/exampleInetProtUtil.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<h1>examples/AppProts/InetProtUtil/exampleInetProtUtil.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00002"></a>00002 <span class="comment">// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00003"></a>00003 <span class="comment">// All rights reserved.</span>
<a name="l00004"></a>00004 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00005"></a>00005 <span class="comment">// under the terms of &quot;Eclipse Public License v1.0&quot;</span>
<a name="l00006"></a>00006 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00007"></a>00007 <span class="comment">// at the URL &quot;http://www.eclipse.org/legal/epl-v10.html&quot;.</span>
<a name="l00008"></a>00008 <span class="comment">//</span>
<a name="l00009"></a>00009 <span class="comment">// Initial Contributors:</span>
<a name="l00010"></a>00010 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00011"></a>00011 <span class="comment">//</span>
<a name="l00012"></a>00012 <span class="comment">// Contributors:</span>
<a name="l00013"></a>00013 <span class="comment">//</span>
<a name="l00014"></a>00014 <span class="comment">// Description:</span>
<a name="l00015"></a>00015 <span class="comment">// ExampleInetProtUtil is a sample code for understanding the applicability of InetProtUtil. </span>
<a name="l00016"></a>00016 <span class="comment">// It is intended as an example and introduction to the INETPROTUTIL API&#39;s.</span>
<a name="l00017"></a>00017 <span class="comment">// Users should have a brief understanding of URIs and the different concepts</span>
<a name="l00018"></a>00018 <span class="comment">// associated with it, like, URLs and URI components. </span>
<a name="l00019"></a>00019 <span class="comment">//</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="comment">// System includes</span>
<a name="l00024"></a>00024 <span class="comment">//</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;uri8.h&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;delimitedparser8.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;inetprottextutils.h&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;escapeutils.h&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;e32cons.h&gt;</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 
<a name="l00033"></a>00033 <span class="comment">//                              CExampleInetProtUtil                          //</span>
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a><a class="code" href="class_c_example_inet_prot_util.html">00036</a> <span class="keyword">class </span><a class="code" href="class_c_example_inet_prot_util.html">CExampleInetProtUtil</a> : <span class="keyword">public</span> CBase
<a name="l00037"></a>00037 {       
<a name="l00038"></a>00038 <span class="keyword">public</span> :
<a name="l00039"></a>00039 
<a name="l00040"></a>00040         <a class="code" href="class_c_example_inet_prot_util.html">CExampleInetProtUtil</a>();
<a name="l00041"></a>00041         
<a name="l00042"></a>00042         <span class="keyword">virtual</span> ~<a class="code" href="class_c_example_inet_prot_util.html">CExampleInetProtUtil</a>();
<a name="l00043"></a>00043         
<a name="l00044"></a>00044         <span class="keywordtype">void</span> ConstructL();
<a name="l00045"></a>00045         
<a name="l00046"></a>00046         <span class="keyword">static</span> <span class="keywordtype">void</span> NewL();
<a name="l00047"></a>00047         
<a name="l00048"></a>00048         <span class="comment">//Create an URI</span>
<a name="l00049"></a>00049         <span class="keywordtype">void</span> CreateUriL();
<a name="l00050"></a>00050         
<a name="l00051"></a>00051         <span class="comment">//Modify URI components</span>
<a name="l00052"></a>00052         <span class="keywordtype">void</span> ModifyUriComponentsL();
<a name="l00053"></a>00053         
<a name="l00054"></a>00054         <span class="comment">//Resolve</span>
<a name="l00055"></a>00055         <span class="keywordtype">void</span> ResolveUriL();
<a name="l00056"></a>00056         
<a name="l00057"></a>00057         <span class="comment">//Parse the URI</span>
<a name="l00058"></a>00058         <span class="keywordtype">void</span> ParseUriL();
<a name="l00059"></a>00059         
<a name="l00060"></a>00060         <span class="comment">//Validate URI components</span>
<a name="l00061"></a>00061         <span class="keywordtype">void</span> ValidateUriComponentsL();
<a name="l00062"></a>00062         
<a name="l00063"></a>00063         <span class="comment">//Extract URI components</span>
<a name="l00064"></a>00064         <span class="keywordtype">void</span> ExtractUriComponentsL();
<a name="l00065"></a>00065         
<a name="l00066"></a>00066         <span class="comment">//Retrieve Filename from a given Uri</span>
<a name="l00067"></a>00067         <span class="keywordtype">void</span> RetrieveFileNameL();
<a name="l00068"></a>00068         
<a name="l00069"></a>00069         <span class="comment">//Add and Trim delimiters</span>
<a name="l00070"></a>00070         <span class="keywordtype">void</span> ModifyDelimiterL();
<a name="l00071"></a>00071         
<a name="l00072"></a>00072         <span class="comment">//Text Utilities</span>
<a name="l00073"></a>00073         <span class="keywordtype">void</span> WhiteSpaceRemover();
<a name="l00074"></a>00074         
<a name="l00075"></a>00075         <span class="comment">//Escape encode and decode</span>
<a name="l00076"></a>00076         <span class="keywordtype">void</span> EscapeEncodeDecodeL();
<a name="l00077"></a>00077         
<a name="l00078"></a>00078 <span class="keyword">private</span>:
<a name="l00079"></a>00079         CConsoleBase* iConsole;
<a name="l00080"></a>00080         
<a name="l00081"></a>00081 };
<a name="l00082"></a>00082         
<a name="l00083"></a>00083         
<a name="l00084"></a>00084         
<a name="l00086"></a>00086 <span class="comment">//                       CExampleDelimiterModifier                    //</span>
<a name="l00088"></a>00088 <span class="comment"></span>        
<a name="l00089"></a>00089         
<a name="l00090"></a><a class="code" href="class_c_example_delimiter_modifier.html">00090</a> <span class="keyword">class </span><a class="code" href="class_c_example_delimiter_modifier.html">CExampleDelimiterModifier</a> : <span class="keyword">public</span> TDelimitedParserBase8 <span class="comment">//, public CDelimitedDataBase8</span>
<a name="l00091"></a>00091 {
<a name="l00092"></a>00092 <span class="keyword">public</span>: <span class="comment">// Methods</span>
<a name="l00093"></a>00093 
<a name="l00094"></a>00094         <span class="keyword">inline</span> TBool CheckFrontDelimiter() <span class="keyword">const</span>;
<a name="l00095"></a>00095 
<a name="l00096"></a>00096         <span class="keyword">inline</span> TBool CheckBackDelimiter() <span class="keyword">const</span>;
<a name="l00097"></a>00097 
<a name="l00098"></a>00098     <a class="code" href="class_c_example_delimiter_modifier.html">CExampleDelimiterModifier</a>();
<a name="l00099"></a>00099 
<a name="l00100"></a>00100         <span class="keyword">inline</span> <span class="keywordtype">void</span> Parse(<span class="keyword">const</span> TDesC8&amp; aData);
<a name="l00101"></a>00101 
<a name="l00102"></a>00102         <span class="keyword">inline</span> <span class="keywordtype">void</span> SetDelimiter(TChar );
<a name="l00103"></a>00103         
<a name="l00104"></a>00104 };
<a name="l00105"></a>00105 
<a name="l00106"></a>00106 <span class="keywordtype">void</span> CExampleDelimiterModifier::SetDelimiter(TChar aChar)
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108         TDelimitedParserBase8::SetDelimiter(aChar);
<a name="l00109"></a>00109 }
<a name="l00110"></a>00110         
<a name="l00111"></a>00111 <span class="keywordtype">void</span> CExampleDelimiterModifier::Parse(<span class="keyword">const</span> TDesC8&amp; aData)
<a name="l00112"></a>00112 {
<a name="l00113"></a>00113         TDelimitedParserBase8::Parse(aData);
<a name="l00114"></a>00114 }
<a name="l00115"></a>00115         
<a name="l00116"></a>00116 CExampleDelimiterModifier::CExampleDelimiterModifier()
<a name="l00117"></a>00117 {
<a name="l00118"></a>00118         
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120         
<a name="l00121"></a>00121 TBool CExampleDelimiterModifier::CheckFrontDelimiter()<span class="keyword"> const</span>
<a name="l00122"></a>00122 <span class="keyword"></span>{
<a name="l00123"></a>00123                 TBool frontDelimiter = FrontDelimiter();
<a name="l00124"></a>00124                 <span class="keywordflow">return</span> frontDelimiter;
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126 
<a name="l00127"></a>00127 TBool CExampleDelimiterModifier::CheckBackDelimiter()<span class="keyword"> const</span>
<a name="l00128"></a>00128 <span class="keyword"></span>{
<a name="l00129"></a>00129                 TBool backDelimiter = BackDelimiter();
<a name="l00130"></a>00130                 <span class="keywordflow">return</span> backDelimiter;
<a name="l00131"></a>00131 }
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>