source: box/trunk/lib/server/Message.cpp @ 2983

Revision 2983, 3.3 KB checked in by chris, 9 months ago (diff)

Combine client and server protocols to make way for an offline/local protocol.

Rename ProtocolObject? to Message.

  • Property svn:eol-style set to native
Line 
1// --------------------------------------------------------------------------
2//
3// File
4//              Name:    Message.h
5//              Purpose: Protocol object base class
6//              Created: 2003/08/19
7//
8// --------------------------------------------------------------------------
9
10#include "Box.h"
11#include "Message.h"
12#include "CommonException.h"
13
14#include "MemLeakFindOn.h"
15
16// --------------------------------------------------------------------------
17//
18// Function
19//              Name:    Message::Message()
20//              Purpose: Default constructor
21//              Created: 2003/08/19
22//
23// --------------------------------------------------------------------------
24Message::Message()
25{
26}
27
28// --------------------------------------------------------------------------
29//
30// Function
31//              Name:    Message::Message()
32//              Purpose: Destructor
33//              Created: 2003/08/19
34//
35// --------------------------------------------------------------------------
36Message::~Message()
37{
38}
39
40// --------------------------------------------------------------------------
41//
42// Function
43//              Name:    Message::Message()
44//              Purpose: Copy constructor
45//              Created: 2003/08/19
46//
47// --------------------------------------------------------------------------
48Message::Message(const Message &rToCopy)
49{
50}
51
52// --------------------------------------------------------------------------
53//
54// Function
55//              Name:    Message::IsError(int &, int &)
56//              Purpose: Does this represent an error, and if so, what is the type and subtype?
57//              Created: 2003/08/19
58//
59// --------------------------------------------------------------------------
60bool Message::IsError(int &rTypeOut, int &rSubTypeOut) const
61{
62        return false;
63}
64
65// --------------------------------------------------------------------------
66//
67// Function
68//              Name:    Message::IsConversationEnd()
69//              Purpose: Does this command end the conversation?
70//              Created: 2003/08/19
71//
72// --------------------------------------------------------------------------
73bool Message::IsConversationEnd() const
74{
75        return false;
76}
77
78
79// --------------------------------------------------------------------------
80//
81// Function
82//              Name:    Message::GetType()
83//              Purpose: Return type of the object
84//              Created: 2003/08/19
85//
86// --------------------------------------------------------------------------
87int Message::GetType() const
88{
89        // This isn't implemented in the base class!
90        THROW_EXCEPTION(CommonException, Internal)
91}
92
93
94// --------------------------------------------------------------------------
95//
96// Function
97//              Name:    Message::SetPropertiesFromStreamData(Protocol &)
98//              Purpose: Set the properties of the object from the stream data ready in the Protocol object
99//              Created: 2003/08/19
100//
101// --------------------------------------------------------------------------
102void Message::SetPropertiesFromStreamData(Protocol &rProtocol)
103{
104        // This isn't implemented in the base class!
105        THROW_EXCEPTION(CommonException, Internal)
106}
107
108
109
110// --------------------------------------------------------------------------
111//
112// Function
113//              Name:    Message::WritePropertiesToStreamData(Protocol &)
114//              Purpose: Write the properties of the object into the stream data in the Protocol object
115//              Created: 2003/08/19
116//
117// --------------------------------------------------------------------------
118void Message::WritePropertiesToStreamData(Protocol &rProtocol) const
119{
120        // This isn't implemented in the base class!
121        THROW_EXCEPTION(CommonException, Internal)
122}
123
124
125
Note: See TracBrowser for help on using the repository browser.