<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Barry: r_message_base.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_3e14c0bb4416cf979afc3165665fc916.html">src</a>
</div>
</div>
<div class="contents">
<h1>r_message_base.h</h1><a href="r__message__base_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file r_message_base.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Base class for email-oriented Blackberry database records</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2005-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"> Copyright (C) 2007, Brian Edginton (edge@edginton.net)</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00011"></a>00011 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00012"></a>00012 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00013"></a>00013 <span class="comment"> (at your option) any later version.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00016"></a>00016 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00017"></a>00017 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00020"></a>00020 <span class="comment"> root directory of this project for more details.</span>
<a name="l00021"></a>00021 <span class="comment">*/</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef __BARRY_RECORD_MESSAGE_BASE_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_RECORD_MESSAGE_BASE_H__</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="record_8h.html" title="Blackberry database record classes.">record.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <iosfwd></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <string></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <vector></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <map></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <stdint.h></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">namespace </span>Barry {
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment">// forward declarations</span>
<a name="l00038"></a>00038 <span class="keyword">class </span>IConverter;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">//</span>
<a name="l00041"></a>00041 <span class="comment">// NOTE: All classes here must be container-safe! Perhaps add sorting</span>
<a name="l00042"></a>00042 <span class="comment">// operators in the future.</span>
<a name="l00043"></a>00043 <span class="comment">//</span>
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="keyword">class </span>BXEXPORT MessageBase
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047 <span class="keyword">public</span>:
<a name="l00048"></a>00048 <span class="keyword">typedef</span> Barry::UnknownsType UnknownsType;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 uint8_t RecType;
<a name="l00051"></a>00051 uint32_t RecordId;
<a name="l00052"></a>00052
<a name="l00053"></a>00053 EmailAddressList From;
<a name="l00054"></a>00054 EmailAddressList To;
<a name="l00055"></a>00055 EmailAddressList Cc;
<a name="l00056"></a>00056 EmailAddressList Bcc;
<a name="l00057"></a>00057 EmailAddressList Sender; <span class="comment">//< not available for PINMessage?</span>
<a name="l00058"></a>00058 EmailAddressList ReplyTo; <span class="comment">//< not available for PINMessage?</span>
<a name="l00059"></a>00059 std::string Subject;
<a name="l00060"></a>00060 std::string Body;
<a name="l00061"></a>00061 std::string Attachment; <span class="comment">//< not available for PINMessage?</span>
<a name="l00062"></a>00062
<a name="l00063"></a>00063 uint32_t MessageRecordId; <span class="comment">// in PINMessage, this happens to be</span>
<a name="l00064"></a>00064 <span class="comment">// the same as RecordId in my (CDF)</span>
<a name="l00065"></a>00065 <span class="comment">// testing, but interestingly, it is</span>
<a name="l00066"></a>00066 <span class="comment">// stored as a field *inside* the</span>
<a name="l00067"></a>00067 <span class="comment">// record, and not as part of the</span>
<a name="l00068"></a>00068 <span class="comment">// header... in effect, this record ID</span>
<a name="l00069"></a>00069 <span class="comment">// occurs twice in the protocol</span>
<a name="l00070"></a>00070 uint32_t MessageReplyTo;
<a name="l00071"></a>00071 time_t MessageDateSent;
<a name="l00072"></a>00072 time_t MessageDateReceived;
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="comment">// Message Flags</span>
<a name="l00075"></a>00075 <span class="keywordtype">bool</span> MessageTruncated;
<a name="l00076"></a>00076 <span class="keywordtype">bool</span> MessageRead;
<a name="l00077"></a>00077 <span class="keywordtype">bool</span> MessageReply;
<a name="l00078"></a>00078 <span class="keywordtype">bool</span> MessageSaved;
<a name="l00079"></a>00079 <span class="keywordtype">bool</span> MessageSavedDeleted;
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keyword">enum</span> PriorityType {
<a name="l00082"></a>00082 LowPriority = 0,
<a name="l00083"></a>00083 NormalPriority,
<a name="l00084"></a>00084 HighPriority,
<a name="l00085"></a>00085 UnknownPriority
<a name="l00086"></a>00086 };
<a name="l00087"></a>00087 PriorityType Priority;
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">enum</span> SensitivityType {
<a name="l00090"></a>00090 NormalSensitivity = 0,
<a name="l00091"></a>00091 Personal,
<a name="l00092"></a>00092 Private,
<a name="l00093"></a>00093 Confidential,
<a name="l00094"></a>00094 UnknownSensitivity
<a name="l00095"></a>00095 };
<a name="l00096"></a>00096 SensitivityType Sensitivity;
<a name="l00097"></a>00097
<a name="l00098"></a>00098 UnknownsType Unknowns;
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="keyword">protected</span>:
<a name="l00101"></a>00101 std::string SimpleFromAddress() <span class="keyword">const</span>;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="keyword">public</span>:
<a name="l00104"></a>00104 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* ParseField(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *begin,
<a name="l00105"></a>00105 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end, <span class="keyword">const</span> IConverter *ic = 0);
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">protected</span>:
<a name="l00108"></a>00108 MessageBase();
<a name="l00109"></a>00109 ~MessageBase();
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="keyword">public</span>:
<a name="l00112"></a>00112 <span class="comment">// Parser / Builder API (see parser.h / builder.h)</span>
<a name="l00113"></a>00113 uint8_t GetRecType() <span class="keyword">const</span>;
<a name="l00114"></a>00114 uint32_t GetUniqueId() <span class="keyword">const</span>; <span class="comment">// empty API, not required by protocol</span>
<a name="l00115"></a>00115 <span class="keywordtype">void</span> SetIds(uint8_t Type, uint32_t Id){ RecType = Type; RecordId = Id; }
<a name="l00116"></a>00116 <span class="keywordtype">void</span> ParseHeader(<span class="keyword">const</span> Data &data, <span class="keywordtype">size_t</span> &offset);
<a name="l00117"></a>00117 <span class="keywordtype">void</span> ParseFields(<span class="keyword">const</span> Data &data, <span class="keywordtype">size_t</span> &offset, <span class="keyword">const</span> IConverter *ic = 0);
<a name="l00118"></a>00118 <span class="keywordtype">void</span> BuildHeader(Data &data, <span class="keywordtype">size_t</span> &offset) <span class="keyword">const</span>;
<a name="l00119"></a>00119 <span class="keywordtype">void</span> BuildFields(Data &data, <span class="keywordtype">size_t</span> &offset, <span class="keyword">const</span> IConverter *ic = 0) <span class="keyword">const</span>;
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="comment">// operations (common among record classes)</span>
<a name="l00122"></a>00122 <span class="keywordtype">void</span> Clear();
<a name="l00123"></a>00123 <span class="keywordtype">void</span> Dump(std::ostream &os) <span class="keyword">const</span>;
<a name="l00124"></a>00124 std::string GetDescription() <span class="keyword">const</span>;
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="comment">// sorting</span>
<a name="l00127"></a>00127 <span class="keywordtype">bool</span> operator<(<span class="keyword">const</span> MessageBase &other) <span class="keyword">const</span>;
<a name="l00128"></a>00128 };
<a name="l00129"></a>00129
<a name="l00130"></a>00130 BXEXPORT <span class="keyword">inline</span> std::ostream& operator<<(std::ostream &os, <span class="keyword">const</span> MessageBase &msg) {
<a name="l00131"></a>00131 msg.Dump(os);
<a name="l00132"></a>00132 <span class="keywordflow">return</span> os;
<a name="l00133"></a>00133 }
<a name="l00134"></a>00134
<a name="l00135"></a>00135 } <span class="comment">// namespace Barry</span>
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="preprocessor">#endif</span>
<a name="l00138"></a>00138 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:16 2011 for Barry by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
