org.apache.flink.python.api.streaming.data

Class PythonSender<IN>

java.lang.Object

org.apache.flink.python.api.streaming.data.PythonSender<IN>

All Implemented Interfaces:

Serializable

public class PythonSender<IN>
extends Object
implements Serializable

General-purpose class to write data to memory-mapped files.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static byte	TYPE_ARRAY
static byte	TYPE_KEY_VALUE
static byte	TYPE_VALUE_VALUE

Constructor Summary

Constructors

Constructor and Description
PythonSender()

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	hasRemaining(int group)
void	open(String path)
void	reset() Resets this object to the post-configuration state.
int	sendBuffer(Iterator i, int group) Extracts records from an iterator and writes them to the memory-mapped file.
int	sendRecord(Object value) Writes a single record to the memory-mapped file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_ARRAY

public static final byte TYPE_ARRAY

See Also:

Constant Field Values

TYPE_KEY_VALUE

public static final byte TYPE_KEY_VALUE

See Also:

Constant Field Values

TYPE_VALUE_VALUE

public static final byte TYPE_VALUE_VALUE

See Also:

Constant Field Values

Constructor Detail

PythonSender

public PythonSender()

Method Detail

open

public void open(String path)
          throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException

reset

public void reset()

Resets this object to the post-configuration state.

sendRecord

public int sendRecord(Object value)
               throws IOException

Writes a single record to the memory-mapped file. This method does NOT take care of synchronization. The user must guarantee that the file may be written to before calling this method. This method essentially reserves the whole buffer for one record. As such it imposes some performance restrictions and should only be used when absolutely necessary.

Parameters:

value - record to send

Returns:

size of the written buffer

Throws:

IOException

hasRemaining

public boolean hasRemaining(int group)

sendBuffer

public int sendBuffer(Iterator i,
                      int group)
               throws IOException

Extracts records from an iterator and writes them to the memory-mapped file. This method assumes that all values in the iterator are of the same type. This method does NOT take care of synchronization. The caller must guarantee that the file may be written to before calling this method.

Parameters:

i - iterator containing records

group - group to which the iterator belongs, most notably used by CoGroup-functions.

Returns:

size of the written buffer

Throws:

IOException