1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef _VOS_ISTREAM_HXX_ 25*b1cdbd2cSJim Jagielski #define _VOS_ISTREAM_HXX_ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "sal/types.h" 28*b1cdbd2cSJim Jagielski # include <vos/types.hxx> 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski namespace vos 31*b1cdbd2cSJim Jagielski { 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski /** Interface for a stream of data, on that you can read and write blocks of bytes. 34*b1cdbd2cSJim Jagielski */ 35*b1cdbd2cSJim Jagielski class IStream 36*b1cdbd2cSJim Jagielski { 37*b1cdbd2cSJim Jagielski public: 38*b1cdbd2cSJim Jagielski IStream()39*b1cdbd2cSJim Jagielski IStream() { } ~IStream()40*b1cdbd2cSJim Jagielski virtual ~IStream() { } 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski /** Retrieve n bytes from the stream and copy them into pBuffer. 44*b1cdbd2cSJim Jagielski @param pBuffer receives the read data. 45*b1cdbd2cSJim Jagielski @param n the number of bytes to read. pBuffer must be large enough 46*b1cdbd2cSJim Jagielski to hold the n bytes! 47*b1cdbd2cSJim Jagielski @return the number of read bytes 48*b1cdbd2cSJim Jagielski */ 49*b1cdbd2cSJim Jagielski virtual sal_Int32 SAL_CALL read(void* pBuffer, 50*b1cdbd2cSJim Jagielski sal_uInt32 n) const= 0; 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski /** Write n bytes from pBuffer to the stream. 53*b1cdbd2cSJim Jagielski @param pBuffer contains the data to be written. 54*b1cdbd2cSJim Jagielski @param n the number of bytes to write. 55*b1cdbd2cSJim Jagielski @return the number of written bytes 56*b1cdbd2cSJim Jagielski */ 57*b1cdbd2cSJim Jagielski virtual sal_Int32 SAL_CALL write(const void* pBuffer, 58*b1cdbd2cSJim Jagielski sal_uInt32 n)= 0; 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski /** Checks if stream is closed for further reading. 61*b1cdbd2cSJim Jagielski @return True is stream has ended (e.g. was closed). 62*b1cdbd2cSJim Jagielski */ 63*b1cdbd2cSJim Jagielski virtual sal_Bool SAL_CALL isEof() const = 0; 64*b1cdbd2cSJim Jagielski }; 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski } 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski #endif // _VOS_ISTREAM_HXX_ 69*b1cdbd2cSJim Jagielski 70