An IArea that is backed by a StoreBase. More...

Inheritance diagram for Deveel.Data.Store.StoreBase.StoreArea:

Public Member Functions
	StoreArea (StoreBase store, long id, long offset, bool readOnly)

	StoreArea (StoreBase store, long id, long offset, bool readOnly, long fixedSize)

void	CopyTo (IArea destArea, int size)
	Copies the given amount of bytes from the current position of the this area to another one. More...

int	Read (byte[] buffer, int offset, int length)
	Reads an array of bytes from the underlying IArea and advances the position by length . More...

void	Write (byte[] buffer, int offset, int length)

void	Flush ()

Protected Member Functions
long	CheckAreaOffset (int diff)

Properties
long	Id `[get, private set]`

long	StartOffset `[get, set]`

long	EndOffset `[get, set]`

StoreBase	Store `[get, set]`

virtual bool	IsReadOnly `[get, private set]`

long	Position `[get, set]`

int	Length `[get]`

Properties inherited from Deveel.Data.Store.IArea
long	Id `[get]`
	Returns the unique identifier that represents this area. More...

bool	IsReadOnly `[get]`
	Gets a value indicating whether this area can be written or not. More...

long	Position `[get, set]`
	Returns or sets the current position of the pointer within the area. More...

int	Length `[get]`

Private Attributes
byte[]	buffer = new byte[BufferSize]

long	position

const int	BufferSize = 8

Detailed Description

An IArea that is backed by a StoreBase.

Definition at line 887 of file StoreBase.cs.

Constructor & Destructor Documentation

Deveel.Data.Store.StoreBase.StoreArea.StoreArea	(	StoreBase	store,
		long	id,
		long	offset,
		bool	readOnly
	)

inline

Definition at line 893 of file StoreBase.cs.

                                                                                    {
                 Store = store;
                 Id = id;
                 IsReadOnly = readOnly;
 
                 store.CheckOffset(offset);
 
                 store.Read(offset, buffer, 0, 8);
                 long v = ByteBuffer.ReadInt8(buffer, 0);
                 if ((v & DeletedFlag) != 0)
                     throw new IOException("Store being constructed on deleted area.");
 
                 long maxSize = v - 16;
                 StartOffset = offset + 8;
                 position = StartOffset;
                 EndOffset = StartOffset + maxSize;
             }

Deveel.Data.Store.StoreBase.StoreArea.StoreArea	(	StoreBase	store,
		long	id,
		long	offset,
		bool	readOnly,
		long	fixedSize
	)

inline

Definition at line 911 of file StoreBase.cs.

                                                                                                    {
                 Store = store;
                 Id = id;
                 IsReadOnly = readOnly;
 
                 // Check the offset is valid
                 if (offset != FixedAreaOffset) {
                     store.CheckOffset(offset);
                 }
 
                 StartOffset = offset;
                 position = StartOffset;
                 EndOffset = StartOffset + fixedSize;
             }

Member Function Documentation

long Deveel.Data.Store.StoreBase.StoreArea.CheckAreaOffset ( int diff )

inlineprotected

Definition at line 951 of file StoreBase.cs.

                                                      {
                 long newPos = position + diff;
                 if (newPos > EndOffset)
                     throw new IOException("Trying to access a position out of area bounds.");
                 
                 long oldPos = position;
                 position = newPos;
                 return oldPos;
             }

void Deveel.Data.Store.StoreBase.StoreArea.CopyTo	(	IArea	destArea,
		int	size
	)

inline

Copies the given amount of bytes from the current position of the this area to another one.

Parameters

destArea	The IArea where to write.
size	The number of bytes to Write.

Implements Deveel.Data.Store.IArea.

Definition at line 961 of file StoreBase.cs.

                                                          {
                 // NOTE: Assuming 'destination' is a StoreArea, the temporary buffer
                 // could be optimized away to a direct Array.Ccopy.  However, this
                 // function would need to be written as a lower level IO function.
                 const int bufferSize = 2048;
                 byte[] buf = new byte[bufferSize];
                 int toCopy = System.Math.Min(size, bufferSize);
 
                 while (toCopy > 0) {
                     var read = Read(buf, 0, toCopy);
                     if (read == 0)
                         break;
 
                     destArea.Write(buf, 0, read);
                     size -= toCopy;
                     toCopy = System.Math.Min(size, bufferSize);
                 }
             }

void Deveel.Data.Store.StoreBase.StoreArea.Flush ( )

inline

Implements Deveel.Data.Store.IArea.

Definition at line 991 of file StoreBase.cs.

991 {

992 }

int Deveel.Data.Store.StoreBase.StoreArea.Read	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Reads an array of bytes from the underlying IArea and advances the position by length .

Parameters

buffer	The destination buffer into which to Read the number of bytes given from the area.
offset	The offset within the buffer from where to start writing the byte Read into.
length	The number of bytes to Read from the area. This is also the incremental size of the position of the area.

Returns: Returns the number of bytes actually Read from the IArea.

Implements Deveel.Data.Store.IArea.

Definition at line 980 of file StoreBase.cs.

                                                                    {
                 return Store.Read(CheckAreaOffset(length), buffer, offset, length);
             }

void Deveel.Data.Store.StoreBase.StoreArea.Write	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Parameters

buffer
offset
length

Implements Deveel.Data.Store.IArea.

Definition at line 984 of file StoreBase.cs.

                                                                      {
                 if (IsReadOnly)
                     throw new IOException("The area is read-only access.");
 
                 Store.Write(CheckAreaOffset(length), buffer, offset, length);
             }

Member Data Documentation

byte [] Deveel.Data.Store.StoreBase.StoreArea.buffer = new byte[BufferSize]

private

Definition at line 888 of file StoreBase.cs.

const int Deveel.Data.Store.StoreBase.StoreArea.BufferSize = 8

private

Definition at line 891 of file StoreBase.cs.

long Deveel.Data.Store.StoreBase.StoreArea.position

private

Definition at line 889 of file StoreBase.cs.

Property Documentation

long Deveel.Data.Store.StoreBase.StoreArea.EndOffset

getsetprivate

Definition at line 930 of file StoreBase.cs.

long Deveel.Data.Store.StoreBase.StoreArea.Id

getprivate set

Definition at line 926 of file StoreBase.cs.

virtual bool Deveel.Data.Store.StoreBase.StoreArea.IsReadOnly

getprivate set

Definition at line 934 of file StoreBase.cs.

int Deveel.Data.Store.StoreBase.StoreArea.Length

get

Definition at line 947 of file StoreBase.cs.

long Deveel.Data.Store.StoreBase.StoreArea.Position

getset

Definition at line 936 of file StoreBase.cs.

long Deveel.Data.Store.StoreBase.StoreArea.StartOffset

getsetprivate

Definition at line 928 of file StoreBase.cs.

StoreBase Deveel.Data.Store.StoreBase.StoreArea.Store

getsetprivate

Definition at line 932 of file StoreBase.cs.

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

/var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Store/StoreBase.cs

Public Member Functions

Protected Member Functions

Properties

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation