org.apache.flink.streaming.api.functions.sink

Class SocketClientSink<IN>

java.lang.Object

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

org.apache.flink.streaming.api.functions.sink.RichSinkFunction<IN>

org.apache.flink.streaming.api.functions.sink.SocketClientSink<IN>

Type Parameters:

IN - data to be written into the Socket.

All Implemented Interfaces:

Serializable, Function, RichFunction, SinkFunction<IN>

@PublicEvolving
public class SocketClientSink<IN>
extends RichSinkFunction<IN>

Socket client that acts as a streaming sink. The data is sent to a Socket as a byte array.

The sink can be set to retry message sends after the sending failed.

The sink can be set to 'autoflush', in which case the socket stream is flushed after every message. This significantly reduced throughput, but also decreases message latency.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.sink.SinkFunction

SinkFunction.Context<T>

Constructor Summary

Constructors

Constructor and Description
SocketClientSink(String hostName, int port, SerializationSchema<IN> schema) Creates a new SocketClientSink.
SocketClientSink(String hostName, int port, SerializationSchema<IN> schema, int maxNumRetries) Creates a new SocketClientSink that retries connections upon failure up to a given number of times.
SocketClientSink(String hostName, int port, SerializationSchema<IN> schema, int maxNumRetries, boolean autoflush) Creates a new SocketClientSink that retries connections upon failure up to a given number of times.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection with the Socket server.
void	invoke(IN value) Called when new data arrives to the sink, and forwards it to Socket.
void	open(Configuration parameters) Initialize the connection with the Socket in the server.

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

Methods inherited from interface org.apache.flink.streaming.api.functions.sink.SinkFunction

invoke

Constructor Detail

SocketClientSink

public SocketClientSink(String hostName,
                        int port,
                        SerializationSchema<IN> schema)

Creates a new SocketClientSink. The sink will not attempt to retry connections upon failure and will not auto-flush the stream.

Parameters:

hostName - Hostname of the server to connect to.

port - Port of the server.

schema - Schema used to serialize the data into bytes.

SocketClientSink

public SocketClientSink(String hostName,
                        int port,
                        SerializationSchema<IN> schema,
                        int maxNumRetries)

Creates a new SocketClientSink that retries connections upon failure up to a given number of times. A value of -1 for the number of retries will cause the system to retry an infinite number of times. The sink will not auto-flush the stream.

Parameters:

hostName - Hostname of the server to connect to.

port - Port of the server.

schema - Schema used to serialize the data into bytes.

maxNumRetries - The maximum number of retries after a message send failed.

SocketClientSink

public SocketClientSink(String hostName,
                        int port,
                        SerializationSchema<IN> schema,
                        int maxNumRetries,
                        boolean autoflush)

Creates a new SocketClientSink that retries connections upon failure up to a given number of times. A value of -1 for the number of retries will cause the system to retry an infinite number of times.

Parameters:

hostName - Hostname of the server to connect to.

port - Port of the server.

schema - Schema used to serialize the data into bytes.

maxNumRetries - The maximum number of retries after a message send failed.

autoflush - Flag to indicate whether the socket stream should be flushed after each message.

Method Detail

open

public void open(Configuration parameters)
          throws Exception

Initialize the connection with the Socket in the server.

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractRichFunction

Parameters:

parameters - Configuration.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

See Also:

Configuration

invoke

public void invoke(IN value)
            throws Exception

Called when new data arrives to the sink, and forwards it to Socket.

Parameters:

value - The value to write to the socket.

Throws:

Exception

close

public void close()
           throws Exception

Closes the connection with the Socket server.

Specified by:

close in interface RichFunction

Overrides:

close in class AbstractRichFunction

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.