JBoss Log Manager 3.1.2.Final · org.jboss.logmanager.handlers.TcpOutputStream

Modifier and Type	Class and Description
private class	TcpOutputStream.RetryConnector

Modifier and Type	Field and Description
private boolean	blockOnReconnect
private boolean	connected
private final Deque<Exception>	errors
private static final int	maxErrors
private static final long	maxRetryTimeout
protected final ReentrantLock	outputLock
private Thread	reconnectThread
private static final long	retryTimeout
private Socket	socket
private final ClientSocketFactory	socketFactory

Constructor Summary

Access	Constructor and Description
public	TcpOutputStream(final InetAddress the address to connect to address, final int the port to connect to port) Creates a TCP output stream.
public	TcpOutputStream(final InetAddress the address to connect to address, final int the port to connect to port, final boolean `true` to block when attempting to reconnect the socket or `false` to reconnect asynchronously blockOnReconnect) Creates a TCP output stream.
protected	TcpOutputStream(final Socket the socket used to write the output to socket) Deprecated Use `TcpOutputStream(ClientSocketFactory, boolean)` Creates a new TCP output stream.
protected	TcpOutputStream(final SocketFactory the factory used to create the socket socketFactory, final InetAddress the address to connect to address, final int the port to connect to port) Creates a new TCP output stream.
protected	TcpOutputStream(final SocketFactory the factory used to create the socket socketFactory, final InetAddress the address to connect to address, final int the port to connect to port, final boolean `true` to block when attempting to reconnect the socket or `false` to reconnect asynchronously blockOnReconnect) Creates a new TCP output stream.
public	TcpOutputStream(final ClientSocketFactory the socket factory used to create TCP sockets socketFactory, final boolean `true` to block when attempting to reconnect the socket or `false` to reconnect asynchronously blockOnReconnect) Creates a new TCP stream which uses the `ClientSocketFactory#createSocket()` to create the socket.

Method Summary

Modifier and Type	Method and Description
private void	addError(final Exception e)
private void	checkReconnect() Attempts to reconnect the socket if required and allowed.
public void	close() Overrides java.io.OutputStream.close. Implements java.lang.AutoCloseable.close, java.io.Closeable.close. Closes this resource, relinquishing any underlying resources.
private Thread	createThread()
public void	flush() Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flushes this stream by writing any buffered output to the underlying stream.
public Collection<Exception>	Returns: a collection of errors or an empty list getErrors() Retrieves the errors occurred, if any, during a write or reconnect.
public boolean	Returns: `true` if blocking is enabled, otherwise `false` isBlockOnReconnect() Indicates whether or not the output stream is set to block when attempting to reconnect a TCP connection.
public boolean	Returns: `true` if the stream is connected, otherwise `false` isConnected() Returns the connected state of the TCP stream.
private boolean	isReconnectAllowed() Invocations of this method must be locked by the `outputLock`.
private static void	safeClose(final Closeable closeable)
public void	setBlockOnReconnect(final boolean `true` to block when reconnecting or `false` to reconnect asynchronously discarding any new messages coming in blockOnReconnect) Enables or disables blocking when attempting to reconnect the socket.
public void	write(final int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public void	write(final byte[] the data. b) Overrides java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream.
public void	write(final byte[] the data. b, final int the start offset in the data. off, final int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.

Inherited from java.io.OutputStream:: nullOutputStream

Field Detail

blockOnReconnect	back to summary
private boolean blockOnReconnect

connected	back to summary
private boolean connected

errors	back to summary
private final Deque<Exception> errors

maxErrors	back to summary
private static final int maxErrors

maxRetryTimeout	back to summary
private static final long maxRetryTimeout

outputLock	back to summary
protected final ReentrantLock outputLock

reconnectThread	back to summary
private Thread reconnectThread

retryTimeout	back to summary
private static final long retryTimeout

socket	back to summary
private Socket socket

socketFactory	back to summary
private final ClientSocketFactory socketFactory

Constructor Detail

TcpOutputStream back to summary

TcpOutputStream	back to summary
public TcpOutputStream(final InetAddress address, final int port) throws IOException Creates a TCP output stream. Uses the `default socket factory` to create the socket. Parameters address:InetAddress the address to connect to port:int the port to connect to Exceptions IOException: no longer throws an exception. If an exception occurs while attempting to connect the socket a reconnect will be attempted on the next write.

public TcpOutputStream(final InetAddress address, final int port) throws IOException

Creates a TCP output stream.

Uses the default socket factory to create the socket.

Parameters

address:InetAddress: the address to connect to
port:int: the port to connect to

Exceptions

IOException:: no longer throws an exception. If an exception occurs while attempting to connect the socket a reconnect will be attempted on the next write.

TcpOutputStream back to summary

TcpOutputStream	back to summary
public TcpOutputStream(final InetAddress address, final int port, final boolean blockOnReconnect) throws IOException Creates a TCP output stream. Uses the `default socket factory` to create the socket. Parameters address:InetAddress the address to connect to port:int the port to connect to blockOnReconnect:boolean `true` to block when attempting to reconnect the socket or `false` to reconnect asynchronously Exceptions IOException: no longer throws an exception. If an exception occurs while attempting to connect the socket a reconnect will be attempted on the next write.

public TcpOutputStream(final InetAddress address, final int port, final boolean blockOnReconnect) throws IOException

Creates a TCP output stream.

Uses the default socket factory to create the socket.

Parameters

address:InetAddress: the address to connect to
port:int: the port to connect to
blockOnReconnect:boolean: true to block when attempting to reconnect the socket or false to reconnect asynchronously

Exceptions

IOException:: no longer throws an exception. If an exception occurs while attempting to connect the socket a reconnect will be attempted on the next write.

TcpOutputStream back to summary

TcpOutputStream	back to summary
protected TcpOutputStream(final Socket socket) Deprecated Use `TcpOutputStream(ClientSocketFactory, boolean)` Creates a new TCP output stream. Using this constructor does not allow for any kind of reconnect if the connection is dropped. Parameters socket:Socket the socket used to write the output to Annotations @Deprecated

protected TcpOutputStream(final Socket socket)

Deprecated

Use TcpOutputStream(ClientSocketFactory, boolean)

Creates a new TCP output stream.

Using this constructor does not allow for any kind of reconnect if the connection is dropped.

Parameters

socket:Socket: the socket used to write the output to

Annotations

@Deprecated

TcpOutputStream back to summary

TcpOutputStream	back to summary
protected TcpOutputStream(final SocketFactory socketFactory, final InetAddress address, final int port) throws IOException Creates a new TCP output stream. Creates a `socket` from the `socketFactory` argument. Parameters socketFactory:SocketFactory the factory used to create the socket address:InetAddress the address to connect to port:int the port to connect to Exceptions IOException: no longer throws an exception. If an exception occurs while attempting to connect the socket a reconnect will be attempted on the next write.

protected TcpOutputStream(final SocketFactory socketFactory, final InetAddress address, final int port) throws IOException

Creates a new TCP output stream.

Creates a socket from the socketFactory argument.

Parameters

socketFactory:SocketFactory: the factory used to create the socket
address:InetAddress: the address to connect to
port:int: the port to connect to

Exceptions

IOException:: no longer throws an exception. If an exception occurs while attempting to connect the socket a reconnect will be attempted on the next write.

TcpOutputStream back to summary

TcpOutputStream	back to summary
protected TcpOutputStream(final SocketFactory socketFactory, final InetAddress address, final int port, final boolean blockOnReconnect) throws IOException Creates a new TCP output stream. Creates a `socket` from the `socketFactory` argument. Parameters socketFactory:SocketFactory the factory used to create the socket address:InetAddress the address to connect to port:int the port to connect to blockOnReconnect:boolean `true` to block when attempting to reconnect the socket or `false` to reconnect asynchronously Exceptions IOException: no longer throws an exception. If an exception occurs while attempting to connect the socket a reconnect will be attempted on the next write.

protected TcpOutputStream(final SocketFactory socketFactory, final InetAddress address, final int port, final boolean blockOnReconnect) throws IOException

Creates a new TCP output stream.

Creates a socket from the socketFactory argument.

Parameters

socketFactory:SocketFactory: the factory used to create the socket
address:InetAddress: the address to connect to
port:int: the port to connect to
blockOnReconnect:boolean: true to block when attempting to reconnect the socket or false to reconnect asynchronously

Exceptions

IOException:: no longer throws an exception. If an exception occurs while attempting to connect the socket a reconnect will be attempted on the next write.

TcpOutputStream back to summary

TcpOutputStream	back to summary
public TcpOutputStream(final ClientSocketFactory socketFactory, final boolean blockOnReconnect) Creates a new TCP stream which uses the `ClientSocketFactory#createSocket()` to create the socket. Parameters socketFactory:ClientSocketFactory the socket factory used to create TCP sockets blockOnReconnect:boolean `true` to block when attempting to reconnect the socket or `false` to reconnect asynchronously

public TcpOutputStream(final ClientSocketFactory socketFactory, final boolean blockOnReconnect)

Creates a new TCP stream which uses the ClientSocketFactory#createSocket() to create the socket.

Parameters

socketFactory:ClientSocketFactory: the socket factory used to create TCP sockets
blockOnReconnect:boolean: true to block when attempting to reconnect the socket or false to reconnect asynchronously

Method Detail

addError	back to summary
private void addError(final Exception e)

checkReconnect	back to summary
private void checkReconnect() Attempts to reconnect the socket if required and allowed. Invocations of this method must be locked by the `outputLock`.

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.lang.AutoCloseable.close, java.io.Closeable.close. Doc from java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the `try`-with-resources statement. Annotations @Override Exceptions IOException: Doc from java.io.OutputStream.close. if an I/O error occurs.

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.lang.AutoCloseable.close, java.io.Closeable.close.

Doc from java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.OutputStream.close.

if an I/O error occurs.

createThread	back to summary
private Thread createThread()

flush	back to summary
public void flush() throws IOException Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Doc from java.io.Flushable.flush. Flushes this stream by writing any buffered output to the underlying stream. Annotations @Override Exceptions IOException: If an I/O error occurs

flush

back to summary

public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.Flushable.flush.

Flushes this stream by writing any buffered output to the underlying stream.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

getErrors	back to summary
public Collection<Exception> getErrors() Retrieves the errors occurred, if any, during a write or reconnect. Returns:Collection<Exception> a collection of errors or an empty list

getErrors

back to summary

public Collection<Exception> getErrors()

Retrieves the errors occurred, if any, during a write or reconnect.

Returns:Collection<Exception>: a collection of errors or an empty list

isBlockOnReconnect back to summary

isBlockOnReconnect	back to summary
public boolean isBlockOnReconnect() Indicates whether or not the output stream is set to block when attempting to reconnect a TCP connection. Returns:boolean `true` if blocking is enabled, otherwise `false`

public boolean isBlockOnReconnect()

Indicates whether or not the output stream is set to block when attempting to reconnect a TCP connection.

Returns:boolean: true if blocking is enabled, otherwise false

isConnected back to summary

isConnected	back to summary
public boolean isConnected() Returns the connected state of the TCP stream. The stream is said to be disconnected when an `IOException` occurs during a write. Otherwise a stream is considered connected. Returns:boolean `true` if the stream is connected, otherwise `false`

public boolean isConnected()

Returns the connected state of the TCP stream.

The stream is said to be disconnected when an IOException occurs during a write. Otherwise a stream is considered connected.

Returns:boolean: true if the stream is connected, otherwise false

isReconnectAllowed	back to summary
private boolean isReconnectAllowed() Invocations of this method must be locked by the `outputLock`.

safeClose	back to summary
private static void safeClose(final Closeable closeable)

setBlockOnReconnect back to summary

setBlockOnReconnect	back to summary
public void setBlockOnReconnect(final boolean blockOnReconnect) Enables or disables blocking when attempting to reconnect the socket. If set to `true` the `write` methods will block when attempting to reconnect. This is only advisable to be set to `true` if using an asynchronous handler. Parameters blockOnReconnect:boolean `true` to block when reconnecting or `false` to reconnect asynchronously discarding any new messages coming in

public void setBlockOnReconnect(final boolean blockOnReconnect)

Enables or disables blocking when attempting to reconnect the socket.

If set to true the write methods will block when attempting to reconnect. This is only advisable to be set to true if using an asynchronous handler.

Parameters

blockOnReconnect:boolean: true to block when reconnecting or false to reconnect asynchronously discarding any new messages coming in

write back to summary

write	back to summary
public void write(final int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(final int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write back to summary

write	back to summary
public void write(final byte[] b) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream. The general contract for `write(b)` is that it should have exactly the same effect as the call `write(b, 0, b.length)`. Parameters b:byte[] the data. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void write(final byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters

b:byte[]: the data.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(final byte[] b, final int off, final int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

public void write(final byte[] b, final int off, final int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

public Class TcpOutputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TcpOutputStream.RetryConnector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail