iodevice_provider.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28
29
30 #pragma once
31
32 #include "iodevice.h"
33
34 namespace clan
35 {
38
40 class IODeviceProvider
41 {
44
45 public:
46 virtual ~IODeviceProvider() { return; }
47
51
52 public:
54
55 virtual int get_size() const { return -1; }
56
58
59 virtual int get_position() const { return -1; }
60
64
65 public:
67 virtual int send(const void *data, int len, bool send_all = true) = 0;
68
70 virtual int receive(void *data, int len, bool receive_all = true) = 0;
71
73 virtual int peek(void *data, int len) = 0;
74
76 virtual IODeviceProvider *duplicate() = 0;
77
79 virtual bool seek(int /*position*/, IODevice::SeekMode /*mode*/) { return false; }
80
84
85 private:
87 };
88
89 }
90
clan::IODeviceProvider::peek
virtual int peek(void *data, int len)=0
Peek data from device.
clan::IODeviceProvider::get_position
virtual int get_position() const
Returns the position in the data stream.
Definition: iodevice_provider.h:59
clan
Definition: clanapp.h:35
clan::IODeviceProvider::seek
virtual bool seek(int, IODevice::SeekMode)
Seek in data stream.
Definition: iodevice_provider.h:79
clan::IODeviceProvider::get_size
virtual int get_size() const
Returns the size of data stream.
Definition: iodevice_provider.h:55
clan::IODeviceProvider::send
virtual int send(const void *data, int len, bool send_all=true)=0
Send data to device.
clan::IODeviceProvider
I/O device provider interface.
Definition: iodevice_provider.h:40
clan::IODeviceProvider::~IODeviceProvider
virtual ~IODeviceProvider()
Definition: iodevice_provider.h:46
clan::IODevice::SeekMode
SeekMode
Seeking modes.
Definition: iodevice.h:57
clan::IODeviceProvider::duplicate
virtual IODeviceProvider * duplicate()=0
Returns a new provider to the same resource.
clan::IODeviceProvider::receive
virtual int receive(void *data, int len, bool receive_all=true)=0
Receive data from device.