sk::io::InputStream Class Reference

#include <InputStream.h>

Inheritance diagram for sk::io::InputStream:

List of all members.

Public Member Functions
virtual char	read ()=0
	Reads the next byte of data from the input stream.
virtual int	read (char *buffer, int offset, int length)=0
	Reads up to lenght bytes of data from the input stream into an array of bytes starting from offset.
virtual std::vector< char >	read (int number)=0
	Reads up to number bytes of data from the input stream and returns them as a vector of chars.
virtual std::vector< char > &	read (std::vector< char > &buffer, int number)=0
	Reads up to number bytes of data from the input stream into the specified vector of chars. The vector size will be adjusted depending on the actual amount of date read. Returns a reference to the same vectory.
virtual void	close ()=0
	Closes this input stream and releases any system resources associated with the stream.
virtual int	skip (int number)=0
	Skips over and discards n bytes of data from this input stream.
virtual long long	available () const =0
	Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
virtual bool	markSupported () const =0
	Tests if this input stream supports the mark and reset methods.
virtual void	mark (int readlimit)=0
	Marks the current position in this input stream.
virtual void	reset ()=0
	Repositions this stream to the position at the time the mark method was last called on this input stream.
virtual Object &	self ()
	Returns a reference to itself.
virtual const Object &	self () const
Object *	clone () const
	Instantiates another object of the same class as a copy of itself.
virtual const Class	getClass () const
	Returns the object's class.
virtual uint64_t	getId () const
	Returns a unique object id.
virtual const String	toString () const
	Returns a string representation of the object. By default, it returns the object's class and the objects's id.
virtual const String	inspect () const
	Returns a string containing human-readable representation of the object.

---

Member Function Documentation

virtual long long sk::io::InputStream::available

(

)

const [pure virtual]

Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.

Implemented in sk::io::AbstractInputStream, sk::io::ByteArrayInputStream, sk::io::DelegatingInputStream, and sk::io::FileInputStream.

Object* sk::util::Object::clone

(

)

const [inherited]

Instantiates another object of the same class as a copy of itself.

Reimplemented in sk::rt::logger::Destination, and sk::util::String.

virtual void sk::io::InputStream::close

(

)

[pure virtual]

Closes this input stream and releases any system resources associated with the stream.

Implemented in sk::io::ByteArrayInputStream, sk::io::DelegatingInputStream, and sk::io::FileDescriptorInputStream.

virtual const Class sk::util::Object::getClass

(

)

const [virtual, inherited]

Returns the object's class.

Reimplemented in sk::cppunit::SourcePath, sk::io::AbstractInputStream, sk::io::AbstractOutputStream, sk::io::AbstractPipe, sk::io::AnonymousPipe, sk::io::BufferedInputStream, sk::io::BufferedOutputStream, sk::io::ByteArrayInputStream, sk::io::ByteArrayOutputStream, sk::io::ClosedChannelException, sk::io::DataInputStream, sk::io::DataOutputStream, sk::io::DelegatingInputStream, sk::io::DelegatingOutputStream, sk::io::DelegatingTty, sk::io::EOFException, sk::io::File, sk::io::FileDescriptor, sk::io::FileDescriptorInputStream, sk::io::FileDescriptorOutputStream, sk::io::FileInputStream, sk::io::FileOutputStream, sk::io::IOException, sk::io::Pty, sk::io::TtyDevice, sk::io::TtyFileDescriptor, sk::net::ip4::Address, sk::rt::config::CwdUprootLocator, sk::rt::config::HomeLocator, sk::rt::config::InlineLocator, sk::rt::config::SpotLocator, sk::rt::config::UprootLocator, sk::rt::logger::Level, sk::rt::logger::Spot, sk::rt::logger::Stream, sk::rt::Mutex, sk::rt::ReentrantLock, sk::rt::scope::Aggregator, sk::rt::scope::Controller, sk::rt::Scope, sk::rt::thread::abstract::Factory, sk::rt::thread::AbstractLock, sk::rt::thread::Exit, sk::rt::thread::State, sk::rt::Thread, sk::sys::AbstractProcessListener, sk::sys::DelegatingExecutable, sk::sys::Group, sk::sys::Pipeline, sk::sys::PipeProcess, sk::sys::Process, sk::sys::PtyProcess, sk::sys::User, sk::util::AbstractCollection< T >, sk::util::AbstractList< T >, sk::util::ArrayList< T >, sk::util::Boolean, sk::util::Class, sk::util::Container, sk::util::Exception, sk::util::IllegalStateException, sk::util::IndexOutOfBoundsException, sk::util::InsufficientMemoryException, sk::util::Integer, sk::util::InterruptedException, sk::util::Method, sk::util::MissingResourceException, sk::util::NoSuchElementException, sk::util::NullPointerException, sk::util::NumberFormatException, sk::util::Pathname, sk::util::String, sk::util::StringArray, sk::util::StringHash, sk::util::SystemException, sk::util::UnsupportedOperationException, sk::util::AbstractCollection< T >, and sk::util::AbstractList< T >.

virtual uint64_t sk::util::Object::getId

(

)

const [virtual, inherited]

Returns a unique object id.

Reimplemented in sk::rt::Thread.

virtual const String sk::util::Object::inspect

(

)

const [virtual, inherited]

Returns a string containing human-readable representation of the object.

Reimplemented in sk::rt::thread::AbstractLock, sk::rt::Thread, sk::util::Class, sk::util::Container, sk::util::slot::Pointer< T, Mixin >, sk::util::slot::Reference< T, Mixin >, sk::util::String, and sk::util::StringArray.

virtual void sk::io::InputStream::mark

(

int

readlimit

)

[pure virtual]

Marks the current position in this input stream.

Implemented in sk::io::AbstractInputStream, sk::io::ByteArrayInputStream, and sk::io::DelegatingInputStream.

virtual bool sk::io::InputStream::markSupported

(

)

const [pure virtual]

Tests if this input stream supports the mark and reset methods.

Implemented in sk::io::AbstractInputStream, sk::io::ByteArrayInputStream, and sk::io::DelegatingInputStream.

virtual std::vector<char>& sk::io::InputStream::read	(	std::vector< char > &	buffer,
		int	number
	)			[pure virtual]

Reads up to number bytes of data from the input stream into the specified vector of chars. The vector size will be adjusted depending on the actual amount of date read. Returns a reference to the same vectory.

Implemented in sk::io::AbstractInputStream.

virtual std::vector<char> sk::io::InputStream::read

(

int

number

)

[pure virtual]

Reads up to number bytes of data from the input stream and returns them as a vector of chars.

Implemented in sk::io::AbstractInputStream.

virtual int sk::io::InputStream::read	(	char *	buffer,
		int	offset,
		int	length
	)			[pure virtual]

Reads up to lenght bytes of data from the input stream into an array of bytes starting from offset.

Implemented in sk::io::AbstractInputStream, sk::io::BufferedInputStream, sk::io::ByteArrayInputStream, sk::io::DelegatingInputStream, and sk::io::FileDescriptorInputStream.

virtual char sk::io::InputStream::read

(

)

[pure virtual]

Reads the next byte of data from the input stream.

Implemented in sk::io::AbstractInputStream.

virtual void sk::io::InputStream::reset

(

)

[pure virtual]

Repositions this stream to the position at the time the mark method was last called on this input stream.

Implemented in sk::io::AbstractInputStream, sk::io::ByteArrayInputStream, and sk::io::DelegatingInputStream.

virtual const Object& sk::util::Object::self

(

)

const [virtual, inherited]

Reimplemented in sk::util::String.

virtual Object& sk::util::Object::self

(

)

[virtual, inherited]

Returns a reference to itself.

Reimplemented in sk::util::String.

virtual int sk::io::InputStream::skip

(

int

number

)

[pure virtual]

Skips over and discards n bytes of data from this input stream.

Implemented in sk::io::AbstractInputStream, sk::io::ByteArrayInputStream, and sk::io::DelegatingInputStream.

virtual const String sk::util::Object::toString

(

)

const [virtual, inherited]

Returns a string representation of the object. By default, it returns the object's class and the objects's id.

Reimplemented in sk::rt::logger::Level, sk::rt::thread::State, sk::util::Boolean, sk::util::Class, sk::util::Container, sk::util::Pathname, and sk::util::String.

---

The documentation for this class was generated from the following file:

• include/sk/io/InputStream.h