This project has retired. For details please refer to its Attic page.
Apache REEF: Org.Apache.REEF.Wake.StreamingCodec.IStreamingCodec< T > Interface Template Reference
Apache REEF  0.15.0
Retainable Evaluator Execution Framework
Public Member Functions | List of all members
Org.Apache.REEF.Wake.StreamingCodec.IStreamingCodec< T > Interface Template Reference

Codec Interface that external users should implement to directly write to the stream More...

Inherited by Org.Apache.REEF.Wake.StreamingCodec.CodecToStreamingCodec< T >.

Public Member Functions

Read (IDataReader reader)
 Instantiate the class from the reader. More...
 
void Write (T obj, IDataWriter writer)
 Writes the class fields to the writer. More...
 
Task< T > ReadAsync (IDataReader reader, CancellationToken token)
 Instantiate the class from the reader. More...
 
Task WriteAsync (T obj, IDataWriter writer, CancellationToken token)
 Writes the class fields to the writer. More...
 

Detailed Description

Codec Interface that external users should implement to directly write to the stream

Member Function Documentation

Instantiate the class from the reader.

Parameters
readerThe reader from which to read
Returns
The instance of type T read from the reader

Implemented in Org.Apache.REEF.Wake.StreamingCodec.CodecToStreamingCodec< T >.

Task<T> Org.Apache.REEF.Wake.StreamingCodec.IStreamingCodec< T >.ReadAsync ( IDataReader  reader,
CancellationToken  token 
)

Instantiate the class from the reader.

Parameters
readerThe reader from which to read
tokenCancellation token
Returns
The instance of type T read from the reader

Implemented in Org.Apache.REEF.Wake.StreamingCodec.CodecToStreamingCodec< T >.

void Org.Apache.REEF.Wake.StreamingCodec.IStreamingCodec< T >.Write ( obj,
IDataWriter  writer 
)

Writes the class fields to the writer.

Parameters
objThe object of type T to be encoded
writerThe writer to which to write

Implemented in Org.Apache.REEF.Wake.StreamingCodec.CodecToStreamingCodec< T >.

Task Org.Apache.REEF.Wake.StreamingCodec.IStreamingCodec< T >.WriteAsync ( obj,
IDataWriter  writer,
CancellationToken  token 
)

Writes the class fields to the writer.

Parameters
objThe object of type T to be encoded
writerThe writer to which to write
tokenCancellation token

Implemented in Org.Apache.REEF.Wake.StreamingCodec.CodecToStreamingCodec< T >.


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