All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
InputStream.h
/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
InputStream.h
Qore Programming Language
Copyright (C) 2016 Qore Technologies, s.r.o.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
Note that the Qore library is released under a choice of three open-source
licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
information.
*/
#ifndef _QORE_INPUTSTREAM_H
#define _QORE_INPUTSTREAM_H
#include "qore/AbstractPrivateData.h"
DLLEXPORT extern QoreClass* QC_INPUTSTREAM;
class InputStream : public AbstractPrivateData {
public:
virtual int64 read(void *ptr, int64 limit, ExceptionSink *xsink) = 0;
virtual int64 peek(ExceptionSink *xsink) = 0;
protected:
InputStream() = default;
};
#endif // _QORE_INPUTSTREAM_H
AbstractPrivateData
the base class for all data to be used as private data of Qore objects
Definition: AbstractPrivateData.h:44
InputStream::InputStream
InputStream()=default
Constructor.
InputStream::read
virtual int64 read(void *ptr, int64 limit, ExceptionSink *xsink)=0
Reads up to `limit` bytes from the input stream.
QoreClass
defines a Qore-language class
Definition: QoreClass.h:214
ExceptionSink
container for holding Qore-language exception information and also for registering a &quot;thread_exit&quot; ca...
Definition: ExceptionSink.h:47
InputStream
Interface for private data of input streams.
Definition: InputStream.h:44
int64
long long int64
64bit integer type, cannot use int64_t here since it breaks the API on some 64-bit systems due to equ...
Definition: common.h:241
InputStream::peek
virtual int64 peek(ExceptionSink *xsink)=0
Peeks the next byte from the input stream.