org.apache.nifi.processor.util.put.sender

Class ChannelSender

java.lang.Object

org.apache.nifi.processor.util.put.sender.ChannelSender

Direct Known Subclasses:

DatagramChannelSender, SocketChannelSender

public abstract class ChannelSender
extends Object

Base class for sending messages over a channel.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	host
protected long	lastUsed
protected ComponentLog	logger
protected int	maxSendBufferSize
protected int	port
protected int	timeout

Constructor Summary

Constructors

Constructor and Description
ChannelSender(String host, int port, int maxSendBufferSize, ComponentLog logger)

Method Summary

Modifier and Type	Method and Description
abstract void	close() Close the underlying channel
long	getLastUsed()
int	getTimeout()
abstract boolean	isConnected()
abstract void	open() Opens the connection to the destination.
void	send(byte[] data) Sends the given data over the channel.
void	send(String message, Charset charset) Sends the given string over the channel.
void	setTimeout(int timeout)
protected abstract void	write(byte[] data) Write the given buffer to the underlying channel.

Methods inherited from class java.lang.Object

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

Field Detail

port

protected final int port

host

protected final String host

maxSendBufferSize

protected final int maxSendBufferSize

logger

protected final ComponentLog logger

timeout

protected volatile int timeout

lastUsed

protected volatile long lastUsed

Constructor Detail

ChannelSender

public ChannelSender(String host,
                     int port,
                     int maxSendBufferSize,
                     ComponentLog logger)

Method Detail

setTimeout

public void setTimeout(int timeout)

getTimeout

public int getTimeout()

getLastUsed

public long getLastUsed()

Returns:

the last time data was sent over this channel

open

public abstract void open()
                   throws IOException

Opens the connection to the destination.

Throws:

IOException - if an error occurred opening the connection.

send

public void send(String message,
                 Charset charset)
          throws IOException

Sends the given string over the channel.

Parameters:

message - the message to send over the channel

Throws:

IOException - if there was an error communicating over the channel

send

public void send(byte[] data)
          throws IOException

Sends the given data over the channel.

Parameters:

data - the data to send over the channel

Throws:

IOException - if there was an error communicating over the channel

write

protected abstract void write(byte[] data)
                       throws IOException

Write the given buffer to the underlying channel.

Throws:

IOException

isConnected

public abstract boolean isConnected()

Returns:

true if the underlying channel is connected

close

public abstract void close()

Close the underlying channel