2 /// \file r_pin_message.h
3 /// Blackberry database record parser class for pin message records.
7 Copyright (C) 2005-2008, Net Direct Inc. (http://www.netdirect.ca/)
8 Copyright (C) 2007, Brian Edginton (edge@edginton.net)
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 See the GNU General Public License in the COPYING file at the
20 root directory of this project for more details.
23 #ifndef __BARRY_RECORD_PIN_MESSAGE_H__
24 #define __BARRY_RECORD_PIN_MESSAGE_H__
37 // NOTE: All classes here must be container-safe! Perhaps add sorting
38 // operators in the future.
41 /// \addtogroup RecordParserClasses
44 class BXEXPORT PINMessage
56 uint32_t MessageRecordId
; // this happens to be the same as
57 // RecordId in my (CDF) testing,
58 // but interestingly, it is stored
59 // as a field *inside* the record,
60 // and not as part of the header...
61 // in effect, this record ID occurs
62 // twice in the protocol
63 uint32_t MessageReplyTo
;
64 time_t MessageDateSent
;
65 time_t MessageDateReceived
;
68 bool MessageTruncated
;
72 bool MessageSavedDeleted
;
74 enum MessagePriorityType
{
80 MessagePriorityType MessagePriority
;
82 enum MessageSensitivityType
{
83 NormalSensitivity
= 0,
89 MessageSensitivityType MessageSensitivity
;
91 std::vector
<UnknownField
> Unknowns
;
94 const unsigned char* ParseField(const unsigned char *begin
,
95 const unsigned char *end
);
101 // Parser / Builder API (see parser.h / builder.h)
102 uint8_t GetRecType() const { return RecType
; }
103 uint32_t GetUniqueId() const { return RecordId
; }
104 void SetIds(uint8_t Type
, uint32_t Id
) { RecType
= Type
; RecordId
= Id
; }
105 void ParseHeader(const Data
&data
, size_t &offset
);
106 void ParseFields(const Data
&data
, size_t &offset
);
107 void BuildHeader(Data
&data
, size_t &offset
) const;
108 void BuildFields(Data
&data
, size_t &offset
) const;
112 void Dump(std::ostream
&os
) const;
115 bool operator<(const PINMessage
&other
) const { return Subject
< other
.Subject
; }
118 static const char * GetDBName() { return "PIN Messages"; }
119 static uint8_t GetDefaultRecType() { return 0; }
122 BXEXPORT
inline std::ostream
& operator<<(std::ostream
&os
, const PINMessage
&msg
) {
131 #endif // __BARRY_RECORD_PIN_MESSAGE_H__