Package org.omegazero.http.netutil

Class SocketConnectionWritable

java.lang.Object

org.omegazero.http.netutil.SocketConnectionWritable

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, WritableSocket

public class SocketConnectionWritable
extends Object
implements WritableSocket

A WritableSocket that wraps a SocketConnection.

Constructor Summary

Constructors

Constructor	Description
SocketConnectionWritable(org.omegazero.net.socket.SocketConnection connection)	Creates a new SocketConnectionWritable.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this WritableSocket.
void	flush()	Flushes any remaining data in this WritableSocket's write buffer.
org.omegazero.net.socket.SocketConnection	getConnection()	Returns the SocketConnection passed in the constructor.
String	getRemoteName()	Returns a readable string identifier of the remote peer.
boolean	isConnected()	Returns true if this WritableSocket is connected, meaning data can still be written.
boolean	isWritable()	Returns true if this WritableSocket is writable.
void	write(byte[] data, int offset, int length)	Writes the given data to this WritableSocket.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.omegazero.http.util.WritableSocket

write

Constructor Details

SocketConnectionWritable

public SocketConnectionWritable(org.omegazero.net.socket.SocketConnection connection)

Creates a new SocketConnectionWritable.

Parameters:

connection - The connection to write to

Method Details

write

public void write(byte[] data,
 int offset,
 int length)

Description copied from interface: WritableSocket

Writes the given data to this WritableSocket.

Specified by:

write in interface WritableSocket

Parameters:

data - The data

offset - The index to start writing from

length - The number of bytes to write, starting at offset

See Also:

• WritableSocket.write(byte[])

flush

public void flush()

Description copied from interface: WritableSocket

Flushes any remaining data in this WritableSocket's write buffer.

Specified by:

flush in interface Flushable

Specified by:

flush in interface WritableSocket

isConnected

public boolean isConnected()

Description copied from interface: WritableSocket

Returns true if this WritableSocket is connected, meaning data can still be written. This is distinct from WritableSocket.isWritable() because a socket may still be connected, while not being writable, because data is backed up locally.

Specified by:

isConnected in interface WritableSocket

Returns:

true if this WritableSocket is connected

See Also:

• WritableSocket.isWritable()

isWritable

public boolean isWritable()

Description copied from interface: WritableSocket

Returns true if this WritableSocket is writable. A socket is writable if data can be written without requiring this data to be buffered locally, potentially causing excessive memory consumption.

Specified by:

isWritable in interface WritableSocket

Returns:

true if this WritableSocket is writable

See Also:

• WritableSocket.isConnected()

getRemoteName

public String getRemoteName()

Description copied from interface: WritableSocket

Returns a readable string identifier of the remote peer.

Specified by:

getRemoteName in interface WritableSocket

Returns:

A readable remote string identifier

close

public void close()

Description copied from interface: WritableSocket

Closes this WritableSocket.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface WritableSocket

getConnection

public org.omegazero.net.socket.SocketConnection getConnection()

Returns the SocketConnection passed in the constructor.

Returns:

The SocketConnection