Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/cmtpexampledprequestprocessor_8h_source.html
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/RemoteConn/MtpDataProviderExample/inc/cmtpexampledprequestprocessor.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/RemoteConn/MtpDataProviderExample/inc/cmtpexampledprequestprocessor.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef __CMTPEXAMPLEDPREQUESTPROCESSOR_H__</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __CMTPEXAMPLEDPREQUESTPROCESSOR_H__</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <e32base.h></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <mtp/mtpdataproviderapitypes.h></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <mtp/mtpprotocolconstants.h></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <mtp/tmtptyperesponse.h></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <mtp/tmtptypenull.h></span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="keyword">class </span>TMTPTypeRequest;
<a name="l00028"></a>00028 <span class="keyword">class </span>CMTPDataProviderPlugin;
<a name="l00029"></a>00029 <span class="keyword">class </span>MMTPDataProviderFramework;
<a name="l00030"></a>00030 <span class="keyword">class </span>TMTPTypeEvent;
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">struct </span>TMTPRequestElementInfo;
<a name="l00033"></a>00033
<a name="l00039"></a><a class="code" href="class_m_m_t_p_example_dp_request_processor.html">00039</a> <span class="keyword">class </span><a class="code" href="class_m_m_t_p_example_dp_request_processor.html">MMTPExampleDpRequestProcessor</a>
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="keyword">public</span>:
<a name="l00042"></a>00042 <span class="comment">/*</span>
<a name="l00043"></a>00043 <span class="comment"> Process a request from the initiator</span>
<a name="l00044"></a>00044 <span class="comment"> @param aRequest The request to be processed</span>
<a name="l00045"></a>00045 <span class="comment"> @param aPhase The transaction phase of the request</span>
<a name="l00046"></a>00046 <span class="comment"> @return ETrue to signal that the processor object can be deleted, EFalse to keep the processor object</span>
<a name="l00047"></a>00047 <span class="comment"> */</span>
<a name="l00048"></a>00048 <span class="keyword">virtual</span> TBool HandleRequestL(<span class="keyword">const</span> TMTPTypeRequest& aRequest, TMTPTransactionPhase aPhase) = 0;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="comment">/*</span>
<a name="l00051"></a>00051 <span class="comment"> Process an event from the initiator</span>
<a name="l00052"></a>00052 <span class="comment"> @param aEvent The event to be processed</span>
<a name="l00053"></a>00053 <span class="comment"> */</span>
<a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">void</span> HandleEventL(<span class="keyword">const</span> TMTPTypeEvent& aEvent) = 0;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="comment">/*</span>
<a name="l00057"></a>00057 <span class="comment"> Check if the processor matches the request on the connection</span>
<a name="l00058"></a>00058 <span class="comment"> @param aRequest The request to be checked</span>
<a name="l00059"></a>00059 <span class="comment"> @param aConnection The connection from which the request comes</span>
<a name="l00060"></a>00060 <span class="comment"> @return ETrue to indicate the processor can handle the request, otherwise, EFalse</span>
<a name="l00061"></a>00061 <span class="comment"> */</span>
<a name="l00062"></a>00062 <span class="keyword">virtual</span> TBool Match(<span class="keyword">const</span> TMTPTypeRequest& aRequest, MMTPConnection& aConnection) <span class="keyword">const</span> = 0;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="comment">/*</span>
<a name="l00065"></a>00065 <span class="comment"> Check if the processor matches the event on the connection</span>
<a name="l00066"></a>00066 <span class="comment"> @param aEvent The event to be checked</span>
<a name="l00067"></a>00067 <span class="comment"> @param aConnection The connection from which the event comes</span>
<a name="l00068"></a>00068 <span class="comment"> @return ETrue to indicate the processor can handle the event, otherwise, EFalse</span>
<a name="l00069"></a>00069 <span class="comment"> */</span>
<a name="l00070"></a>00070 <span class="keyword">virtual</span> TBool Match(<span class="keyword">const</span> TMTPTypeEvent& aEvent, MMTPConnection& aConnection) <span class="keyword">const</span> = 0;
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="comment">/*</span>
<a name="l00073"></a>00073 <span class="comment"> Get the request object which the processor is currently handling</span>
<a name="l00074"></a>00074 <span class="comment"> @return the request object which the processor is currently handling</span>
<a name="l00075"></a>00075 <span class="comment"> */</span>
<a name="l00076"></a>00076 <span class="keyword">virtual</span> <span class="keyword">const</span> TMTPTypeRequest& Request() <span class="keyword">const</span> = 0;
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="comment">/*</span>
<a name="l00079"></a>00079 <span class="comment"> Get the connection object associated with the current request object</span>
<a name="l00080"></a>00080 <span class="comment"> @return the connection object associated with the current request object</span>
<a name="l00081"></a>00081 <span class="comment"> */</span>
<a name="l00082"></a>00082 <span class="keyword">virtual</span> MMTPConnection& Connection() <span class="keyword">const</span> = 0;
<a name="l00083"></a>00083 <span class="comment">/*</span>
<a name="l00084"></a>00084 <span class="comment"> Get the Session ID associated with the current request object</span>
<a name="l00085"></a>00085 <span class="comment"> @return Session ID associated with the current request object</span>
<a name="l00086"></a>00086 <span class="comment"> */</span>
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">virtual</span> TUint32 SessionId() = 0;
<a name="l00089"></a>00089 <span class="comment">/*</span>
<a name="l00090"></a>00090 <span class="comment"> delete the request processor object</span>
<a name="l00091"></a>00091 <span class="comment"> */</span>
<a name="l00092"></a>00092 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Release() = 0;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 };
<a name="l00095"></a>00095
<a name="l00099"></a>00099 <span class="keyword">typedef</span> <a class="code" href="class_m_m_t_p_example_dp_request_processor.html">MMTPExampleDpRequestProcessor</a>* (*TMTPRequestProcessorCreateFunc)(
<a name="l00100"></a>00100 MMTPDataProviderFramework& aFramework,
<a name="l00101"></a>00101 MMTPConnection& aConnection);
<a name="l00102"></a>00102
<a name="l00106"></a><a class="code" href="struct_t_m_t_p_request_processor_entry.html">00106</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108 TUint16 iOperationCode;
<a name="l00109"></a>00109 TMTPRequestProcessorCreateFunc iCreateFunc;
<a name="l00110"></a>00110 }<a class="code" href="struct_t_m_t_p_request_processor_entry.html">TMTPRequestProcessorEntry</a>;
<a name="l00111"></a>00111
<a name="l00112"></a><a class="code" href="class_c_m_t_p_example_dp_request_processor.html">00112</a> <span class="keyword">class </span><a class="code" href="class_c_m_t_p_example_dp_request_processor.html">CMTPExampleDpRequestProcessor</a> : <span class="keyword">public</span> <a class="code" href="class_m_m_t_p_example_dp_request_processor.html">MMTPExampleDpRequestProcessor</a>
<a name="l00113"></a>00113 {
<a name="l00114"></a>00114 <span class="keyword">protected</span>:
<a name="l00115"></a>00115 <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#aeec08e4c2bc425fc9284645a98850d9a">CMTPExampleDpRequestProcessor</a>(
<a name="l00116"></a>00116 MMTPDataProviderFramework& aFramework,
<a name="l00117"></a>00117 MMTPConnection& aConnection,
<a name="l00118"></a>00118 TInt aElementCount,
<a name="l00119"></a>00119 <span class="keyword">const</span> TMTPRequestElementInfo* aElements);
<a name="l00120"></a>00120 <span class="keyword">virtual</span> <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#a683cf05e8b6aa42d6646b893b3680597">~CMTPExampleDpRequestProcessor</a>();
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keyword">protected</span>: <span class="comment">//utility methods </span>
<a name="l00123"></a>00123 <span class="keywordtype">void</span> <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#a23bd6f51aef2507ff9b1466c5744cd47">SendResponseL</a>(TMTPResponseCode aResponseCode, TInt aParameterCount = 0, TUint32* aParams = NULL);
<a name="l00124"></a>00124 <span class="keywordtype">void</span> <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#a99d04bc3cd40550b4c67d3164b68ee7c">CompleteRequestL</a>();
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="keyword">protected</span>: <span class="comment">// from MMTPRequestProcessor </span>
<a name="l00127"></a>00127 <span class="keyword">virtual</span> TBool <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#a4b10e786885316ab9cc41d0b139469ff">HandleRequestL</a>(<span class="keyword">const</span> TMTPTypeRequest& aRequest, TMTPTransactionPhase aPhase);
<a name="l00128"></a>00128 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#a515f5fdd80df202e02b5116dc7d10666">HandleEventL</a>(<span class="keyword">const</span> TMTPTypeEvent& aEvent);
<a name="l00129"></a>00129 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#acf6a9caa24bebc0a9936ad1e10c48c90">Release</a>();
<a name="l00130"></a>00130 <span class="keyword">virtual</span> TBool <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#a1e0ed8c9f87cd095914b518d6fa18f51">Match</a>(<span class="keyword">const</span> TMTPTypeRequest& aRequest, MMTPConnection& aConnection) <span class="keyword">const</span>;
<a name="l00131"></a>00131 <span class="keyword">virtual</span> TBool <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#a1e0ed8c9f87cd095914b518d6fa18f51">Match</a>(<span class="keyword">const</span> TMTPTypeEvent& aEvent, MMTPConnection& aConnection) <span class="keyword">const</span>;
<a name="l00132"></a>00132 <span class="keyword">virtual</span> <span class="keyword">const</span> TMTPTypeRequest& <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#a1d115a581c794e3fd51279897f5d93c6">Request</a>() <span class="keyword">const</span>;
<a name="l00133"></a>00133 <span class="keyword">virtual</span> MMTPConnection& <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#abe6425e6f991aec33e8fff1b8933e0db">Connection</a>() <span class="keyword">const</span>;
<a name="l00134"></a>00134 <span class="keyword">virtual</span> TUint32 <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#a11dd2dba67a1c2d87cf26c97c7458af9">SessionId</a>();
<a name="l00135"></a>00135
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keyword">protected</span>: <span class="comment">//new virtuals </span>
<a name="l00138"></a>00138 <span class="keyword">virtual</span> TBool <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#a8805aaa8addc025229322dbe92ddefc5">DoHandleResponsePhaseL</a>();
<a name="l00139"></a>00139 <span class="keyword">virtual</span> TBool <a class="code" href="class_c_m_t_p_example_dp_request_processor.html#a499d04d039da527a915bdbc58b3231b7">DoHandleCompletingPhaseL</a>();
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="comment">/*</span>
<a name="l00142"></a>00142 <span class="comment"> service a request at request phase</span>
<a name="l00143"></a>00143 <span class="comment"> */</span>
<a name="l00144"></a>00144 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ServiceL() = 0;
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="keyword">private</span>:
<a name="l00147"></a>00147 <span class="keywordtype">void</span> ExtractSessionTransactionId();
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="keyword">protected</span>:
<a name="l00150"></a>00150 MMTPDataProviderFramework& iFramework;
<a name="l00151"></a>00151 <span class="keyword">const</span> TMTPTypeRequest* iRequest; <span class="comment">//the pending request object.</span>
<a name="l00152"></a>00152 MMTPConnection& iConnection; <span class="comment">//the connection from which the request comes.</span>
<a name="l00153"></a>00153 TMTPTypeResponse iResponse; <span class="comment">//the response object to send to the initiator.</span>
<a name="l00154"></a>00154 TBool iCancelled; <span class="comment">//indicates whether the data phase (send/receive) has been cancelled.</span>
<a name="l00155"></a>00155 TInt iElementCount; <span class="comment">//number of verification elements used for request checker.</span>
<a name="l00156"></a>00156 <span class="keyword">const</span> TMTPRequestElementInfo* iElements; <span class="comment">//pointer to an array of verification elements.</span>
<a name="l00157"></a>00157 TUint32 iSessionId; <span class="comment">//session id for the pending request.</span>
<a name="l00158"></a>00158 TUint32 iTransactionCode; <span class="comment">//transaction code for the pending request.</span>
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <span class="keyword">private</span>:
<a name="l00161"></a>00161 TMTPResponseCode iResponseCode; <span class="comment">// contains response from CheckRequestL call.</span>
<a name="l00162"></a>00162 };
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="preprocessor">#endif // __CMTPEXAMPLEDPREQUESTPROCESSOR_H__</span>
<a name="l00165"></a>00165 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>