Org.Apache.REEF.Wake.Remote.IDataReader Interface Reference

Interface for reading standard primitives More...

Inherited by Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

Public Member Functions
double	ReadDouble ()
	Reads double More...
float	ReadFloat ()
	Reads float More...
long	ReadLong ()
	Reads long More...
bool	ReadBoolean ()
	Reads bool More...
int	ReadInt32 ()
	Reads integer More...
short	ReadInt16 ()
	Reads short More...
string	ReadString ()
	Reads string More...
int	Read (ref byte[] buffer, int index, int bytesToRead)
	Reads data in to the buffer More...
Task< double >	ReadDoubleAsync (CancellationToken token)
	Reads double asynchronously More...
Task< float >	ReadFloatAsync (CancellationToken token)
	Reads float asynchronously More...
Task< long >	ReadLongAsync (CancellationToken token)
	Reads long asynchronously More...
Task< bool >	ReadBooleanAsync (CancellationToken token)
	Reads bool asynchronously More...
Task< int >	ReadInt32Async (CancellationToken token)
	Reads integer asynchronously More...
Task< short >	ReadInt16Async (CancellationToken token)
	Reads short asynchronously More...
Task< string >	ReadStringAsync (CancellationToken token)
	Reads string asynchronously More...
Task< int >	ReadAsync (byte[] buffer, int index, int bytesToRead, CancellationToken token)
	Reads data in to the buffer asynchronously More...

Detailed Description

Interface for reading standard primitives

Member Function Documentation

int Org.Apache.REEF.Wake.Remote.IDataReader.Read	(	ref byte[]	buffer,
		int	index,
		int	bytesToRead
	)

Reads data in to the buffer

Parameters

buffer	byte array to which to write
index	starting index in the array
bytesToRead	number of bytes to write

Returns

Task handler that reads bytes and returns that number of bytes read if success, otherwise -1

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

Task<int> Org.Apache.REEF.Wake.Remote.IDataReader.ReadAsync	(	byte[]	buffer,
		int	index,
		int	bytesToRead,
		CancellationToken	token
	)

Reads data in to the buffer asynchronously

Parameters

buffer	byte array to which to write
index	starting index in the array
bytesToRead	number of bytes to write
token	Cancellation token

Returns

Task handler that reads bytes and returns that number of bytes read if success, otherwise -1

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

bool Org.Apache.REEF.Wake.Remote.IDataReader.ReadBoolean

(

)

Reads bool

Returns

read bool

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

Task<bool> Org.Apache.REEF.Wake.Remote.IDataReader.ReadBooleanAsync

(

CancellationToken

token

)

Reads bool asynchronously

Parameters

token

Cancellation token

Returns

Task handler that reads bool

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

double Org.Apache.REEF.Wake.Remote.IDataReader.ReadDouble

(

)

Reads double

Returns

read double

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

Task<double> Org.Apache.REEF.Wake.Remote.IDataReader.ReadDoubleAsync

(

CancellationToken

token

)

Reads double asynchronously

Parameters

token

Cancellation token

Returns

Task handler that reads double

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

float Org.Apache.REEF.Wake.Remote.IDataReader.ReadFloat

(

)

Reads float

Returns

read float

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

Task<float> Org.Apache.REEF.Wake.Remote.IDataReader.ReadFloatAsync

(

CancellationToken

token

)

Reads float asynchronously

Parameters

token

Cancellation token

Returns

Task handler that reads float

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

short Org.Apache.REEF.Wake.Remote.IDataReader.ReadInt16

(

)

Reads short

Returns

read short

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

Task<short> Org.Apache.REEF.Wake.Remote.IDataReader.ReadInt16Async

(

CancellationToken

token

)

Reads short asynchronously

Parameters

token

Cancellation token

Returns

Task handler that reads short

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

int Org.Apache.REEF.Wake.Remote.IDataReader.ReadInt32

(

)

Reads integer

Returns

read integer

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

Task<int> Org.Apache.REEF.Wake.Remote.IDataReader.ReadInt32Async

(

CancellationToken

token

)

Reads integer asynchronously

Parameters

token

Cancellation token

Returns

Task handler that reads integer

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

long Org.Apache.REEF.Wake.Remote.IDataReader.ReadLong

(

)

Reads long

Returns

read long

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

Task<long> Org.Apache.REEF.Wake.Remote.IDataReader.ReadLongAsync

(

CancellationToken

token

)

Reads long asynchronously

Parameters

token

Cancellation token

Returns

Task handler that reads long

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

string Org.Apache.REEF.Wake.Remote.IDataReader.ReadString

(

)

Reads string

Returns

read string

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

Task<string> Org.Apache.REEF.Wake.Remote.IDataReader.ReadStringAsync

(

CancellationToken

token

)

Reads string asynchronously

Parameters

token

Cancellation token

Returns

Task handler that reads string

Implemented in Org.Apache.REEF.Wake.Remote.Impl.StreamDataReader.

---

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

• lang/cs/Org.Apache.REEF.Wake/Remote/IDataReader.cs