This project has retired. For details please refer to its Attic page.
Apache REEF: Org.Apache.REEF.Network.Group.Pipelining.StreamingPipelineMessageCodec< T > Class Template Reference
Apache REEF  0.15.0
Retainable Evaluator Execution Framework
Public Member Functions | Properties | List of all members
Org.Apache.REEF.Network.Group.Pipelining.StreamingPipelineMessageCodec< T > Class Template Reference

The streaming codec for PipelineMessage More...

Inherits IStreamingCodec< PipelineMessage< T >>.

Public Member Functions

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

Properties

IStreamingCodec< T > BaseCodec [get]
 Codec for actual message T More...
 

Detailed Description

The streaming codec for PipelineMessage

Template Parameters
TThe message type

Member Function Documentation

Instantiate the class from the reader.

Parameters
readerThe reader from which to read
Returns
The Pipeline Message read from the reader
async Task<PipelineMessage<T> > Org.Apache.REEF.Network.Group.Pipelining.StreamingPipelineMessageCodec< T >.ReadAsync ( IDataReader  reader,
CancellationToken  token 
)
inline

Instantiate the class from the reader.

Parameters
readerThe reader from which to read
tokenCancellation token
Returns
The Pipeline Message read from the reader

Writes the class fields to the writer.

Parameters
objThe object to be encoded
writerThe writer to which to write
async System.Threading.Tasks.Task Org.Apache.REEF.Network.Group.Pipelining.StreamingPipelineMessageCodec< T >.WriteAsync ( PipelineMessage< T >  obj,
IDataWriter  writer,
CancellationToken  token 
)
inline

Writes the class fields to the writer.

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

Property Documentation

Codec for actual message T


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