Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Classes

Summary: Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

SocketHttpClientConnection

extends AbstractHttpClientConnection
implements HttpInetConnection

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

Known Direct Subclasses

DefaultClientConnection , DefaultHttpClientConnection

Class Overview

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

Summary

Public Constructors
	SocketHttpClientConnection ()

Public Methods
void	close () Closes this connection gracefully.
InetAddress	getLocalAddress ()
int	getLocalPort ()
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.

Protected Methods
void	assertNotOpen ()
void	assertOpen ()
void	bind ( Socket socket, HttpParams params)
SessionInputBuffer	createSessionInputBuffer ( Socket socket, int buffersize, HttpParams params)
SessionOutputBuffer	createSessionOutputBuffer ( Socket socket, int buffersize, HttpParams params)
Socket	getSocket ()

[Expand]

Inherited Methods

From class org.apache.http.impl.AbstractHttpClientConnection

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface org.apache.http.HttpClientConnection

abstract void	flush () Writes out all pending buffered data over the open connection.
abstract boolean	isResponseAvailable (int timeout) Checks if response data is available from the connection.
abstract void	receiveResponseEntity ( HttpResponse response) Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.
abstract HttpResponse	receiveResponseHeader () Receives the request line and headers of the next response available from this connection.
abstract void	sendRequestEntity ( HttpEntityEnclosingRequest request) Sends the request entity over the connection.
abstract void	sendRequestHeader ( HttpRequest request) Sends the request line and all headers over the connection.

From interface org.apache.http.HttpConnection

abstract void	close () Closes this connection gracefully.
abstract HttpConnectionMetrics	getMetrics () Returns a collection of connection metrcis
abstract int	getSocketTimeout () Returns the socket timeout value.
abstract boolean	isOpen () Checks if this connection is open.
abstract boolean	isStale () Checks whether this connection has gone down.
abstract void	setSocketTimeout (int timeout) Sets the socket timeout value.
abstract void	shutdown () Force-closes this connection.

From interface org.apache.http.HttpInetConnection

Public Constructors

public SocketHttpClientConnection ()

Added in API level 1

Public Methods

public void close ()

Added in API level 1

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.

Throws

IOException

public InetAddress getLocalAddress ()

Added in API level 1

public int getLocalPort ()

Added in API level 1

public InetAddress getRemoteAddress ()

Added in API level 1

public int getRemotePort ()

Added in API level 1

public int getSocketTimeout ()

Added in API level 1

Returns the socket timeout value.

Returns

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

public boolean isOpen ()

Added in API level 1

Checks if this connection is open.

Returns

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

public void setSocketTimeout (int timeout)

Added in API level 1

Sets the socket timeout value.

Parameters

timeout	timeout value in milliseconds

public void shutdown ()

Added in API level 1

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.

Throws

IOException

Protected Methods

protected void assertNotOpen ()

Added in API level 1

protected void assertOpen ()

Added in API level 1

protected void bind ( Socket socket, HttpParams params)

Added in API level 1

Throws

IOException

protected SessionInputBuffer createSessionInputBuffer ( Socket socket, int buffersize, HttpParams params)

Added in API level 1

Throws

IOException

protected SessionOutputBuffer createSessionOutputBuffer ( Socket socket, int buffersize, HttpParams params)

Added in API level 1

Throws

IOException

protected Socket getSocket ()

Added in API level 1

Results

Classes

SocketHttpClientConnection

Class Overview

Summary

Public Constructors

public SocketHttpClientConnection ()

Public Methods

public void close ()

Throws

public InetAddress getLocalAddress ()

public int getLocalPort ()

public InetAddress getRemoteAddress ()

public int getRemotePort ()

public int getSocketTimeout ()

Returns

public boolean isOpen ()

Returns

public void setSocketTimeout (int timeout)

Parameters

public void shutdown ()

Throws

Protected Methods

protected void assertNotOpen ()

protected void assertOpen ()

protected void bind ( Socket socket, HttpParams params)

Throws

protected SessionInputBuffer createSessionInputBuffer ( Socket socket, int buffersize, HttpParams params)

Throws

protected SessionOutputBuffer createSessionOutputBuffer ( Socket socket, int buffersize, HttpParams params)

Throws

protected Socket getSocket ()