Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
stream.h
Go to the documentation of this file.
1/*
2 *
3 * Copyright (c) Microsoft Corporation.
4 * All rights reserved.
5 *
6 * This code is licensed under the MIT License.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files(the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions :
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 *
26 */
33#ifndef API_MIP_STREAM_H_
34#define API_MIP_STREAM_H_
35
36#include <future>
37#include <vector>
38
39#include "mip/mip_namespace.h"
40
41MIP_NAMESPACE_BEGIN
42
46class Stream {
47public:
55 virtual int64_t Read(uint8_t* buffer, int64_t bufferLength) = 0;
56
64 virtual int64_t Write(const uint8_t* buffer, int64_t bufferLength) = 0;
65
71 virtual bool Flush() = 0;
72
78 virtual void Seek(int64_t position) = 0;
79
85 virtual bool CanRead() const = 0;
86
92 virtual bool CanWrite() const = 0;
93
99 virtual int64_t Position() = 0;
100
106 virtual int64_t Size() = 0;
107
113 virtual void Size(int64_t value) = 0;
114
116 virtual ~Stream() { }
117
118protected:
119 Stream() { }
121}; // class Stream
122
123MIP_NAMESPACE_END
124
125#endif // API_MIP_STREAM_H_
A class that defines the interface between the MIP SDK and stream-based content.
Definition stream.h:46
virtual bool CanWrite() const =0
A check if stream can be written to.
virtual int64_t Size()=0
Get the size of the content within the stream.
virtual bool CanRead() const =0
A check if stream can be read from.
virtual int64_t Position()=0
Get the current position within the stream.
virtual int64_t Read(uint8_t *buffer, int64_t bufferLength)=0
Read into a buffer from the stream.
virtual int64_t Write(const uint8_t *buffer, int64_t bufferLength)=0
Write into the stream from a buffer.
virtual void Seek(int64_t position)=0
Seek specific position within the stream.
virtual void Size(int64_t value)=0
Set the stream size.
virtual bool Flush()=0
flush the stream.
MIP namespace macros.