summaryrefslogtreecommitdiff
path: root/lib/server/ProtocolObject.h
blob: 0a127ab55efc019efb2fdd20ccf8b41862e5bfa6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// --------------------------------------------------------------------------
//
// File
//		Name:    ProtocolObject.h
//		Purpose: Protocol object base class
//		Created: 2003/08/19
//
// --------------------------------------------------------------------------

#ifndef PROTOCOLOBJECT__H
#define PROTOCOLOBJECT__H

class Protocol;

// --------------------------------------------------------------------------
//
// Class
//		Name:    ProtocolObject
//		Purpose: Basic object representation of objects to pass through a Protocol session
//		Created: 2003/08/19
//
// --------------------------------------------------------------------------
class ProtocolObject
{
public:
	ProtocolObject();
	virtual ~ProtocolObject();
	ProtocolObject(const ProtocolObject &rToCopy);

	// Info about this object
	virtual int GetType() const;
	virtual bool IsError(int &rTypeOut, int &rSubTypeOut) const;
	virtual bool IsConversationEnd() const;

	// reading and writing with Protocol objects
	virtual void SetPropertiesFromStreamData(Protocol &rProtocol);
	virtual void WritePropertiesToStreamData(Protocol &rProtocol) const;	
};

#endif // PROTOCOLOBJECT__H