This project has retired. For details please refer to its Attic page.
Apache REEF: Org.Apache.REEF.Wake.StreamingCodec.CommonStreamingCodecs.StringStreamingCodec Class Reference
Apache REEF  0.15.0
Retainable Evaluator Execution Framework
Public Member Functions | List of all members
Org.Apache.REEF.Wake.StreamingCodec.CommonStreamingCodecs.StringStreamingCodec Class Reference

Streaming codec for string More...

Inherits Org.Apache.REEF.Wake.StreamingCodec.IStreamingCodec< string >.

Public Member Functions

string Read (IDataReader reader)
 Instantiate the class from the reader. More...
 
void Write (string obj, IDataWriter writer)
 Writes the string to the writer. More...
 
async Task< string > ReadAsync (IDataReader reader, CancellationToken token)
 Instantiate the class from the reader. More...
 
async Task WriteAsync (string obj, IDataWriter writer, CancellationToken token)
 Writes the string to the writer. More...
 
- Public Member Functions inherited from Org.Apache.REEF.Wake.StreamingCodec.IStreamingCodec< string >
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

Streaming codec for string

Member Function Documentation

string Org.Apache.REEF.Wake.StreamingCodec.CommonStreamingCodecs.StringStreamingCodec.Read ( IDataReader  reader)
inline

Instantiate the class from the reader.

Parameters
readerThe reader from which to read
Returns
The string read from the reader
async Task<string> Org.Apache.REEF.Wake.StreamingCodec.CommonStreamingCodecs.StringStreamingCodec.ReadAsync ( IDataReader  reader,
CancellationToken  token 
)
inline

Instantiate the class from the reader.

Parameters
readerThe reader from which to read
tokenCancellation token
Returns
The string read from the reader
void Org.Apache.REEF.Wake.StreamingCodec.CommonStreamingCodecs.StringStreamingCodec.Write ( string  obj,
IDataWriter  writer 
)
inline

Writes the string to the writer.

Parameters
objThe string to be encoded
writerThe writer to which to write
async Task Org.Apache.REEF.Wake.StreamingCodec.CommonStreamingCodecs.StringStreamingCodec.WriteAsync ( string  obj,
IDataWriter  writer,
CancellationToken  token 
)
inline

Writes the string to the writer.

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

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