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

T	The message type

Member Function Documentation

Read()

PipelineMessage<T> Org.Apache.REEF.Network.Group.Pipelining.StreamingPipelineMessageCodec< T >.Read ( IDataReader  reader )

inline

Instantiate the class from the reader.

Parameters

reader

The reader from which to read

Returns

The Pipeline Message read from the reader

ReadAsync()

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

reader	The reader from which to read
token	Cancellation token

Returns

The Pipeline Message read from the reader

Write()

void Org.Apache.REEF.Network.Group.Pipelining.StreamingPipelineMessageCodec< T >.Write ( PipelineMessage< T >  obj, IDataWriter  writer  )

inline

Writes the class fields to the writer.

Parameters

obj	The object to be encoded
writer	The writer to which to write

WriteAsync()

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

obj	The object to be encoded
writer	The writer to which to write
token	Cancellation token

Property Documentation

BaseCodec

IStreamingCodec<T> Org.Apache.REEF.Network.Group.Pipelining.StreamingPipelineMessageCodec< T >.BaseCodec

get

Codec for actual message T

---

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

• lang/cs/Org.Apache.REEF.Network/Group/Pipelining/StreamingPipelineMessageCodec.cs