iodevice_provider.h Source File - ClanLib SDK
Description: iodevice_provider.h Source File

iodevice_provider.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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#pragma once
30
31#include "iodevice.h"
32
33namespace clan
34{
37
39 class IODeviceProvider
40 {
41 public:
42 virtual ~IODeviceProvider() { return; }
43
45
46 virtual size_t get_size() const { return size_t(SIZE_MAX); }
47
49
50 virtual size_t get_position() const { return size_t(SIZE_MAX); }
51
53 virtual size_t send(const void *data, size_t len, bool send_all = true) = 0;
54
56 virtual size_t receive(void *data, size_t len, bool receive_all = true) = 0;
57
59 virtual size_t peek(void *data, size_t len) = 0;
60
62 virtual IODeviceProvider *duplicate() = 0;
63
65 virtual bool seek(int /*position*/, IODevice::SeekMode /*mode*/) { return false; }
66 };
67
69}
clan::IODeviceProvider
I/O device provider interface.
Definition iodevice_provider.h:40
clan::IODeviceProvider::~IODeviceProvider
virtual ~IODeviceProvider()
Definition iodevice_provider.h:42
clan::IODeviceProvider::duplicate
virtual IODeviceProvider * duplicate()=0
Returns a new provider to the same resource.
clan::IODeviceProvider::get_position
virtual size_t get_position() const
Returns the position in the data stream.
Definition iodevice_provider.h:50
clan::IODeviceProvider::send
virtual size_t send(const void *data, size_t len, bool send_all=true)=0
Send data to device.
clan::IODeviceProvider::get_size
virtual size_t get_size() const
Returns the size of data stream.
Definition iodevice_provider.h:46
clan::IODeviceProvider::receive
virtual size_t receive(void *data, size_t len, bool receive_all=true)=0
Receive data from device.
clan::IODeviceProvider::seek
virtual bool seek(int, IODevice::SeekMode)
Seek in data stream.
Definition iodevice_provider.h:65
clan::IODeviceProvider::peek
virtual size_t peek(void *data, size_t len)=0
Peek data from device.
clan::IODevice::SeekMode
SeekMode
Seeking modes.
Definition iodevice.h:54
clan
Definition clanapp.h:36