stream.net

Class DataTapSink

java.lang.Object

stream.net.DataTapSink

All Implemented Interfaces:

Sink

public class DataTapSink
extends Object
implements Sink

This Sink receives data items and transmit them via TCP socket connections.
It can be used for inter-process- / inter-machine-communication.

Other objects can register themselves to be notified, if a new client connects to this DataTapSink - see e.g. OnEvent.
To receive the 'new client connect event' they must

• implement the CallableEventListener interface and
• register themselves to this DataTapSink's ListenerHandler:
  • #getListenerHandler() and invoke
  • ListenerHandler#addListener(CallableEventListener)-method on the returned object.

Therefore this class implements the Listenable interface.

Author:

Hendrik Blom, chris, Tobias Beckers TODO Handle / Throw general Exceptions in this class or hand them over to caller

Field Summary

Fields

Modifier and Type	Field and Description
protected int	clientBufferSize The buffer size (number of items) used for each client
protected ConnectionHandler	connectionHandler the ConnectionHandler
protected boolean	detectClientClose Defines if this sink actively listens to client disconnect events (= client's input stream read-method returns '-1').
protected boolean	disconnectSlowClients Defines if slow clients should be disconnected.
protected boolean	gzip This parameter allows for enabling GZIP compression on the TCP stream, default is no compression.
protected String	id contains the ClientConnectListener that are notified when a new client connects to this server
(package private) static org.slf4j.Logger	log
protected boolean	logBufferFull Defines if the event 'client buffer is full' should be logged.
protected Integer	port The port to listen on for incoming tap connections, defaults to 9100.

Constructor Summary

Constructors

Constructor and Description
DataTapSink()

Method Summary

Modifier and Type	Method and Description
void	close()
int	getClientBufferSize() Returns the buffer size used for each client
String	getId()
Integer	getPort()
void	init()
boolean	isActivelyDetectClientClose()
boolean	isDisconnectSlowClients()
boolean	isGzip()
void	setClientBufferSize(int clientBufferSize) Sets the buffer size used for each client
void	setDetectClientClose(boolean activelyDetectClientClose)
void	setDisconnectSlowClients(boolean disconnectSlowClients)
void	setGzip(boolean gzip)
void	setId(String id)
void	setPort(Integer port)
boolean	write(Collection<Data> data)
boolean	write(Data item)

Methods inherited from class java.lang.Object

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

Field Detail

port

protected Integer port

The port to listen on for incoming tap connections, defaults to 9100.

clientBufferSize

protected int clientBufferSize

The buffer size (number of items) used for each client

gzip

protected boolean gzip

This parameter allows for enabling GZIP compression on the TCP stream, default is no compression.

detectClientClose

protected boolean detectClientClose

Defines if this sink actively listens to client disconnect events (= client's input stream read-method returns '-1'). If true, this sink will close the connection immediately if the event occurs. Otherwise a client disconnect will be detected (and the connection will also be closed) the next time, an item should be transferred to the client (and therefore the client's output stream write-method is unsuccessful).

disconnectSlowClients

protected boolean disconnectSlowClients

Defines if slow clients should be disconnected. A client is defined to be 'slow', if its buffer is completely filled.

logBufferFull

protected boolean logBufferFull

Defines if the event 'client buffer is full' should be logged.

log

static final org.slf4j.Logger log

connectionHandler

protected ConnectionHandler connectionHandler

the ConnectionHandler

id

protected String id

contains the ClientConnectListener that are notified when a new client connects to this server

Constructor Detail

DataTapSink

public DataTapSink()

Method Detail

getId

public String getId()

Specified by:

getId in interface Sink

setId

public void setId(String id)

Specified by:

setId in interface Sink

getPort

public Integer getPort()

Returns:

the port

setPort

@Parameter(description="The port to listen on for incoming tap connections, defaults to 9100.")
public void setPort(Integer port)

Parameters:

port - the port to set

getClientBufferSize

public int getClientBufferSize()

Returns the buffer size used for each client

Returns:

the buffer size used for each client

setClientBufferSize

@Parameter(description="The buffer size (number of items) used for each client",
           defaultValue="10")
public void setClientBufferSize(int clientBufferSize)

Sets the buffer size used for each client

Parameters:

clientBufferSize -

isGzip

public boolean isGzip()

Returns:

the gzip

setGzip

@Parameter(description="This parameter allows for enabling GZIP compression on the TCP stream, default is no compression.")
public void setGzip(boolean gzip)

Parameters:

gzip - the gzip to set

isActivelyDetectClientClose

public boolean isActivelyDetectClientClose()

setDetectClientClose

@Parameter(required=false,
           defaultValue="false",
           description="Defines if this sink actively listens to client disconnect events (= client\'s input stream read-method returns \'-1\').If true, this sink will close the connection immediately if the event occurs.Otherwise a client disconnect will be detected (and the connection will also be closed)the next time, an item should be transferred to the client (and therefore the client\'s output stream write-method is unsuccessful).")
public void setDetectClientClose(boolean activelyDetectClientClose)

isDisconnectSlowClients

public boolean isDisconnectSlowClients()

setDisconnectSlowClients

@Parameter(required=false,
           defaultValue="false",
           description="Defines if slow clients should be disconnected. A client is defined to be \'slow\', if its buffer is completely filled.")
public void setDisconnectSlowClients(boolean disconnectSlowClients)

init

public void init()
          throws Exception

Specified by:

init in interface Sink

Throws:

Exception

write

public boolean write(Collection<Data> data)
              throws Exception

Specified by:

write in interface Sink

Throws:

Exception

write

public boolean write(Data item)
              throws Exception

This operation blocks if at least one client buffer is exceeded.

Specified by:

write in interface Sink

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface Sink

Throws:

Exception