org.johnnei.javatorrent.internal.network.socket

Interface ISocket

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

TcpSocket

public interface ISocket
extends AutoCloseable

A socket facade to get multiple socket protocols work on the some functions

Author:

Johnnei

Method Summary

Modifier and Type	Method and Description
void	close() Formally closes the connection
void	connect(InetSocketAddress endpoint) Connects the underlaying Socket to the endpoint
void	flush() Forces the socket to send all data
InputStream	getInputStream() Gets the inputstream from the underlaying socket
OutputStream	getOutputStream() Gets the outputstream from the underlaying socket
boolean	isClosed() Checks if the connection has been closed
boolean	isInputShutdown() Checks if there will be no more data incoming
boolean	isOutputShutdown() Checks if no more data can be send on this socket

Method Detail

connect

void connect(InetSocketAddress endpoint)
      throws IOException

Connects the underlaying Socket to the endpoint

Parameters:

endpoint - The Address to connect to

Throws:

IOException - When connection fails

getInputStream

InputStream getInputStream()
                    throws IOException

Gets the inputstream from the underlaying socket

Returns:

An InputStream which allows to read data from it

Throws:

IOException - when the stream could not be created

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Gets the outputstream from the underlaying socket

Returns:

An outputstream which allows to write data to the socket

Throws:

IOException - when the stream could not be created

close

void close()
    throws IOException

Formally closes the connection

Specified by:

close in interface AutoCloseable

Throws:

IOException - When the connection could not be closed

isClosed

boolean isClosed()

Checks if the connection has been closed

Returns:

true if the connection is closing/closed

isInputShutdown

boolean isInputShutdown()

Checks if there will be no more data incoming

Returns:

true if EOF has been found

isOutputShutdown

boolean isOutputShutdown()

Checks if no more data can be send on this socket

Returns:

true if EOF has been send

flush

void flush()
    throws IOException

Forces the socket to send all data

Throws:

IOException