aboutsummaryrefslogtreecommitdiff
path: root/SrcShared/EmTransport.h
blob: 376d236bb28d1b919bc59452c8db7a3c2acd8d67 (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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/* -*- mode: C++; tab-width: 4 -*- */
/* ===================================================================== *\
	Copyright (c) 1999-2001 Palm, Inc. or its subsidiaries.
	All rights reserved.

	This file is part of the Palm OS Emulator.

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.
\* ===================================================================== */

#ifndef EmTransport_h
#define EmTransport_h

#include "EmTypes.h"			// ErrCode

#include <string>				// string
#include <vector>				// vector


enum EmTransportType
{
	kTransportNull,		// "null:"
	kTransportSerial,	// "serial:"
	kTransportSocket,	// "tcp:"
	kTransportUSB,		// "usb:"

	kTransportUnknown
};

class EmTransport;


// Wraps up a "transport descriptor", something that identifies
// a tranport that a user can point to and use in the UI.

class EmTransportDescriptor
{
	public:
								EmTransportDescriptor	(void);
								EmTransportDescriptor	(EmTransportType);
								EmTransportDescriptor	(EmTransportType, const string&);
								EmTransportDescriptor	(const string&);
								EmTransportDescriptor	(const EmTransportDescriptor&);
								~EmTransportDescriptor	(void);
		EmTransportDescriptor&	operator=				(const EmTransportDescriptor&);

		EmTransport*			CreateTransport			(void) const;

		string					GetMenuName				(void) const;	// For menus (e.g., "COM1", "TCP/IP")
		string					GetDescriptor			(void) const;	// Full text (e.g., "serial:COM1")
		string					GetScheme				(void) const;	// First part of text (e.g., "serial", "socket")
		string					GetSchemeSpecific		(void) const;	// Second part of text (e.g., "127.0.0.1:5001")
		EmTransportType			GetType					(void) const;	// Scheme in numeric form

		static string			GetSchemePrefix			(EmTransportType);	// Convert numeric format to scheme prefix

		bool					operator==				(const EmTransportDescriptor&) const;

	private:
		Bool					PrvTestType				(EmTransportType type) const;

	private:
		string					fDescriptor;
};

typedef vector<EmTransportDescriptor>	EmTransportDescriptorList;


class EmTransport
{
	public:
		struct Config
		{
									Config			(void) {};
			virtual					~Config			(void) {};

			virtual EmTransport*	NewTransport	(void) = 0;
			virtual EmTransport*	GetTransport	(void) = 0;
		};

	public:
								EmTransport			(void);
		virtual					~EmTransport		(void);

		virtual ErrCode			Open				(void);
		virtual ErrCode			Close				(void);

		virtual ErrCode			Read				(long&, void*);
		virtual ErrCode			Write				(long&, const void*);

		virtual Bool			CanRead				(void);
		virtual Bool			CanWrite			(void);

		virtual long			BytesInBuffer		(long minBytes);

		virtual string			GetSpecificName		(void) = 0;

		static void				CloseAllTransports	(void);
};


class EmTransportNull : public EmTransport
{
	public:

		// Note: this used to be named "Config", but that runs
		// afoul of a bug in VC++ (see KB Q143082).
		struct ConfigNull : public EmTransport::Config
		{
									ConfigNull		(void) {};
			virtual					~ConfigNull		(void) {};

			virtual EmTransport*	NewTransport	(void) { return new EmTransportNull; };
			virtual EmTransport*	GetTransport	(void);
		};

	public:
								EmTransportNull			(void);
								EmTransportNull			(const EmTransportDescriptor&);
								EmTransportNull			(const ConfigNull&);
		virtual					~EmTransportNull		(void);

		virtual ErrCode			Open					(void);
		virtual ErrCode			Close					(void);

		virtual ErrCode			Read					(long&, void*);
		virtual ErrCode			Write					(long&, const void*);

		virtual Bool			CanRead					(void);
		virtual Bool			CanWrite				(void);

		virtual long			BytesInBuffer			(long minBytes);

		virtual string			GetSpecificName			(void);

		static void				GetDescriptorList		(EmTransportDescriptorList&);
};


#endif /* EmTransport_h */