org.apache.http.impl
Class SocketHttpClientConnection

java.lang.Object
  org.apache.http.impl.AbstractHttpClientConnection
      org.apache.http.impl.SocketHttpClientConnection

All Implemented Interfaces:

HttpClientConnection, HttpConnection, HttpInetConnection

Direct Known Subclasses:

DefaultHttpClientConnection

public class SocketHttpClientConnection

extends AbstractHttpClientConnection

implements HttpInetConnection

Implementation of a client-side HTTP connection that can be bound to a network Socket in order to receive and transmit data.

Since:

4.0

Version:

$Revision: 510119 $

Author:

Oleg Kalnichevski

Field Summary

protected boolean	open
protected java.net.Socket	socket

Constructor Summary

SocketHttpClientConnection()

Method Summary

protected void	assertNotOpen()
protected void	assertOpen()
protected void	bind(java.net.Socket socket, HttpParams params)
void	close() Closes this connection gracefully.
java.net.InetAddress	getLocalAddress()
int	getLocalPort()
java.net.InetAddress	getRemoteAddress()
int	getRemotePort()
int	getSocketTimeout() Returns the socket timeout value.
boolean	isOpen() Checks if this connection is open.
void	setSocketTimeout(int timeout) Sets the socket timeout value.
void	shutdown() Force-closes this connection.

Methods inherited from class org.apache.http.impl.AbstractHttpClientConnection

doFlush, flush, isResponseAvailable, isStale, readResponseHeaders, readResponseStatusLine, receiveResponseEntity, receiveResponseHeader, sendRequestEntity, sendRequestHeader, sendRequestHeaders, sendRequestLine, setHttpDataReceiver, setHttpDataTransmitter, setMaxHeaderCount, setResponseFactory, startsWithHTTP

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.http.HttpConnection

isStale

Field Detail

open

protected volatile boolean open

socket

protected java.net.Socket socket

Constructor Detail

SocketHttpClientConnection

public SocketHttpClientConnection()

Method Detail

assertNotOpen

protected void assertNotOpen()

assertOpen

protected void assertOpen()

Specified by:

assertOpen in class AbstractHttpClientConnection

bind

protected void bind(java.net.Socket socket,
                    HttpParams params)
             throws java.io.IOException

Throws:

java.io.IOException

isOpen

public boolean isOpen()

Description copied from interface: HttpConnection

Checks if this connection is open.

Specified by:

isOpen in interface HttpConnection

Returns:

true if it is open, false if it is closed.

getLocalAddress

public java.net.InetAddress getLocalAddress()

Specified by:

getLocalAddress in interface HttpInetConnection

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface HttpInetConnection

getRemoteAddress

public java.net.InetAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface HttpInetConnection

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface HttpInetConnection

setSocketTimeout

public void setSocketTimeout(int timeout)

Description copied from interface: HttpConnection

Sets the socket timeout value.

Specified by:

setSocketTimeout in interface HttpConnection

Parameters:

timeout - timeout value in milliseconds

getSocketTimeout

public int getSocketTimeout()

Description copied from interface: HttpConnection

Returns the socket timeout value.

Specified by:

getSocketTimeout in interface HttpConnection

Returns:

positive value in milliseconds if a timeout is set, 0 if timeout is disabled or -1 if timeout is undefined.

shutdown

public void shutdown()
              throws java.io.IOException

Description copied from interface: HttpConnection

Force-closes this connection. This is the only method of a connection which may be called from a different thread to terminate the connection. This method will not attempt to flush the transmitter's internal buffer prior to closing the underlying socket.

Specified by:

shutdown in interface HttpConnection

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from interface: HttpConnection

Closes this connection gracefully. This method will attempt to flush the transmitter's internal buffer prior to closing the underlying socket. This method MUST NOT be called from a different thread to force shutdown of the connection. Use shutdown instead.

Specified by:

close in interface HttpConnection

Throws:

java.io.IOException