org.apache.flink.streaming.api.functions.source

Class SocketTextStreamFunction

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.source.RichSourceFunction<String>

org.apache.flink.streaming.api.functions.source.SocketTextStreamFunction

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, SourceFunction<String>

public class SocketTextStreamFunction
extends RichSourceFunction<String>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.source.SourceFunction

SourceFunction.SourceContext<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
SocketTextStreamFunction(String hostname, int port, char delimiter, long maxRetry)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the source.
void	open(org.apache.flink.configuration.Configuration parameters)
void	run(SourceFunction.SourceContext<String> ctx) Starts the source.
void	streamFromSocket(SourceFunction.SourceContext<String> ctx, Socket socket)

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

SocketTextStreamFunction

public SocketTextStreamFunction(String hostname,
                                int port,
                                char delimiter,
                                long maxRetry)

Method Detail

open

public void open(org.apache.flink.configuration.Configuration parameters)
          throws Exception

Specified by:

open in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

open in class org.apache.flink.api.common.functions.AbstractRichFunction

Throws:

Exception

run

public void run(SourceFunction.SourceContext<String> ctx)
         throws Exception

Description copied from interface: SourceFunction

Starts the source. You can use the Collector parameter to emit elements. Sources that implement Checkpointed must lock on the checkpoint lock (using a synchronized block) before updating internal state and/or emitting elements. Also, the update of state and emission of elements must happen in the same synchronized block.

Parameters:

ctx - The context for interaction with the outside world.

Throws:

Exception

streamFromSocket

public void streamFromSocket(SourceFunction.SourceContext<String> ctx,
                             Socket socket)
                      throws Exception

Throws:

Exception

cancel

public void cancel()

Description copied from interface: SourceFunction

Cancels the source. Most sources will have a while loop inside the SourceFunction.run(org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<T>) method. You need to ensure that the source will break out of this loop. This can be achieved by having a volatile field "isRunning" that is checked in the loop and that is set to false in this method.