org.apache.flink.streaming.connectors.wikiedits

Class WikipediaEditsSource

java.lang.Object

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

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

org.apache.flink.streaming.connectors.wikiedits.WikipediaEditsSource

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, org.apache.flink.streaming.api.functions.source.SourceFunction<WikipediaEditEvent>

public class WikipediaEditsSource
extends org.apache.flink.streaming.api.functions.source.RichSourceFunction<WikipediaEditEvent>

See Also:

Serialized Form

Nested Class Summary

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

org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHANNEL IRC channel to join
static String	DEFAULT_HOST Hostname of the server to connect to.
static int	DEFAULT_PORT Port of the server to connect to.

Constructor Summary

Constructors

Constructor and Description
WikipediaEditsSource() Creates a source reading WikipediaEditEvent instances from the IRC channel #en.wikipedia.
WikipediaEditsSource(String host, int port, String channel) Creates a source reading WikipediaEditEvent instances from the specified IRC channel.

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	close()
void	open(org.apache.flink.configuration.Configuration parameters)
void	run(org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext ctx)

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

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

Hostname of the server to connect to.

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

Port of the server to connect to.

See Also:

Constant Field Values

DEFAULT_CHANNEL

public static final String DEFAULT_CHANNEL

IRC channel to join

See Also:

Constant Field Values

Constructor Detail

WikipediaEditsSource

public WikipediaEditsSource()

Creates a source reading WikipediaEditEvent instances from the IRC channel #en.wikipedia.

This creates a separate Thread for the IRC connection.

WikipediaEditsSource

public WikipediaEditsSource(String host,
                            int port,
                            String channel)

Creates a source reading WikipediaEditEvent instances from the specified IRC channel.

In most cases, you want to use the default WikipediaEditsSource(java.lang.String, int, java.lang.String) constructor. This constructor is meant to be used only if there is a problem with the default constructor.

Parameters:

host - The IRC server to connect to.

port - The port of the IRC server to connect to.

channel - The channel to join. Messages not matching the expected format will be ignored.

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

close

public void close()
           throws Exception

Specified by:

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

Overrides:

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

Throws:

Exception

run

public void run(org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext ctx)
         throws Exception

Throws:

Exception

cancel

public void cancel()