Deveel.Data.Protocol.StreamableObject Class Reference

An object that is streamable (such as a long binary object, or a long string object). More...

Public Member Functions
	StreamableObject (ReferenceType type, long size, long id)
	Constructs the StreamableObject. More...

Properties
ReferenceType	Type [get]
long	Size [get]
long	Identifier [get]

Private Attributes
readonly ReferenceType	type
	The type of the object. More...
readonly long	size
	The size of the object in bytes. More...
readonly long	id
	The identifier that identifies this object. More...

Detailed Description

An object that is streamable (such as a long binary object, or a long string object).

This is passed between client and server and contains basic primitive information about the object it represents. The actual contents of the object itself must be obtained through other means (see IDatabaseInterface).

Definition at line 29 of file StreamableObject.cs.

Constructor & Destructor Documentation

Deveel.Data.Protocol.StreamableObject.StreamableObject ( ReferenceType  type, long  size, long  id  )

inline

Constructs the StreamableObject.

Parameters

type
size
id

summary> Returns the type of object this stub represents. /summary>

Returns 1 if it represents 2-byte unicde character object, 2 if it represents binary data.

Definition at line 52 of file StreamableObject.cs.

Member Data Documentation

readonly long Deveel.Data.Protocol.StreamableObject.id

private

The identifier that identifies this object.

Definition at line 44 of file StreamableObject.cs.

readonly long Deveel.Data.Protocol.StreamableObject.size

private

The size of the object in bytes.

Definition at line 39 of file StreamableObject.cs.

readonly ReferenceType Deveel.Data.Protocol.StreamableObject.type

private

The type of the object.

Definition at line 34 of file StreamableObject.cs.

Property Documentation

long Deveel.Data.Protocol.StreamableObject.Identifier

get

Definition at line 89 of file StreamableObject.cs.

long Deveel.Data.Protocol.StreamableObject.Size

get

summary> Returns an identifier that can identify this object within some context. /summary>

For example, if this is a streamable object on the client side, then the identifier might be the value that is able to retreive a section of the streamable object from the IDatabaseInterface.

Definition at line 77 of file StreamableObject.cs.

ReferenceType Deveel.Data.Protocol.StreamableObject.Type

get

summary> Returns the size of the object stream, or -1 if the size is unknown. /summary>

If this represents a unicode character string, you would calculate the total characters as size / 2.

Definition at line 66 of file StreamableObject.cs.

---

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

• /var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Protocol/StreamableObject.cs