com.devexperts.qd.qtp.socket

Class SocketInfo

java.lang.Object

com.devexperts.qd.qtp.socket.SocketInfo

@Experimental
public class SocketInfo
extends Object

This class stores a socket and its address provided by a SocketSource.

NOTE: The stored address may differ from the one in socket.getRemoteSocketAddress(), see getSocketAddress() docs.

SocketInfo instance provides direct access to input/output streams of the associated socket. Code using the provided SocketInfo as a standard socket replacement should use these IO streams directly, because the future implementations can substitute some alternative streams if needed.

Field Summary

Fields

Modifier and Type	Field and Description
protected Socket	socket
protected SocketAddress	socketAddress

Constructor Summary

Constructors

Constructor and Description
SocketInfo(Socket socket, SocketAddress socketAddress) Constructs a new instance of SocketInfo with the provided socket and socket address.

Method Summary

Modifier and Type	Method and Description
InputStream	getInputStream() Returns an input stream that reads from the socket.
OutputStream	getOutputStream() Returns an output stream that writes to the socket.
Socket	getSocket() Gets the Socket .
SocketAddress	getSocketAddress() Gets the socket address.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

socket

protected final Socket socket

socketAddress

protected final SocketAddress socketAddress

Constructor Detail

SocketInfo

public SocketInfo(Socket socket,
                  SocketAddress socketAddress)

Constructs a new instance of SocketInfo with the provided socket and socket address.

Parameters:

socket - the Socket instance representing the network socket.

socketAddress - the SocketAddress instance representing the address of the socket.

Method Detail

getSocket

public Socket getSocket()

Gets the Socket .

Returns:

the Socket instance representing the underlying network connection.

getSocketAddress

public SocketAddress getSocketAddress()

Gets the socket address.

This address represents the target address of the connection evaluated by the SocketInfo provider and may differ from the remote address of the socket. For example, in case the socket is connected via HTTPS proxy, it would be the real destination address rather than a proxy address.

Returns:

the SocketAddress

getInputStream

public InputStream getInputStream()
                           throws IOException

Returns an input stream that reads from the socket.

Returns:

an input stream that reads from the socket.

Throws:

IOException - if an I/O error occurs when creating the input stream.

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Returns an output stream that writes to the socket.

Returns:

an output stream that writes to the socket.

Throws:

IOException - if an I/O error occurs when creating the output stream.

toString

public String toString()

Overrides:

toString in class Object