You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by gg...@apache.org on 2018/09/20 22:52:47 UTC
httpcomponents-core git commit: Javadoc and sort methods.
Repository: httpcomponents-core
Updated Branches:
refs/heads/master 45c06ea3b -> 309e79ece
Javadoc and sort methods.
Project: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/commit/309e79ec
Tree: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/tree/309e79ec
Diff: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/diff/309e79ec
Branch: refs/heads/master
Commit: 309e79ece9faf88f2285edffd520c80f20a84167
Parents: 45c06ea
Author: Gary Gregory <gg...@rocketsoftware.com>
Authored: Thu Sep 20 16:52:43 2018 -0600
Committer: Gary Gregory <gg...@rocketsoftware.com>
Committed: Thu Sep 20 16:52:43 2018 -0600
----------------------------------------------------------------------
.../apache/hc/core5/http/HttpConnection.java | 66 ++++++++++++--------
1 file changed, 39 insertions(+), 27 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/httpcomponents-core/blob/309e79ec/httpcore5/src/main/java/org/apache/hc/core5/http/HttpConnection.java
----------------------------------------------------------------------
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/HttpConnection.java b/httpcore5/src/main/java/org/apache/hc/core5/http/HttpConnection.java
index b65856f..5d6085a 100644
--- a/httpcore5/src/main/java/org/apache/hc/core5/http/HttpConnection.java
+++ b/httpcore5/src/main/java/org/apache/hc/core5/http/HttpConnection.java
@@ -42,62 +42,74 @@ import org.apache.hc.core5.io.ModalCloseable;
public interface HttpConnection extends ModalCloseable {
/**
- * Returns connection endpoint details.
+ * Closes this connection gracefully. This method will attempt to flush the internal output
+ * buffer prior to closing the underlying socket. This method MUST NOT be called from a
+ * different thread to force shutdown of the connection. Use {@link #close shutdown} instead.
*/
- EndpointDetails getEndpointDetails();
+ @Override
+ void close() throws IOException;
/**
- * Returns SSL session or {@code null} if TLS has not been activated.
+ * Returns this connection's endpoint details.
+ *
+ * @return this connection's endpoint details.
*/
- SSLSession getSSLSession();
+ EndpointDetails getEndpointDetails();
/**
- * Closes this connection gracefully.
- * This method will attempt to flush the internal output
- * buffer prior to closing the underlying socket.
- * This method MUST NOT be called from a different thread to force
- * shutdown of the connection. Use {@link #close shutdown} instead.
+ * Returns this connection's local address or {@code null} if it is not bound yet.
+ *
+ * @return this connection's local address or {@code null} if it is not bound yet.
+ * @since 5.0
*/
- @Override
- void close() throws IOException;
+ SocketAddress getLocalAddress();
/**
- * Checks if this connection is open.
- * @return true if it is open, false if it is closed.
+ * Returns this connection's protocol version or {@code null} if unknown.
+ *
+ * @return this connection's protocol version or {@code null} if unknown.
+ * @since 5.0
*/
- boolean isOpen();
+ ProtocolVersion getProtocolVersion();
/**
- * Sets the socket timeout value.
+ * Returns this connection's remote address or {@code null} if it is not connected yet or
+ * unconnected.
*
- * @param timeout timeout value in milliseconds
+ * @return this connection's remote address or {@code null} if it is not connected yet or
+ * unconnected.
+ * @since 5.0
*/
- void setSocketTimeoutMillis(int timeout);
+ SocketAddress getRemoteAddress();
/**
* Returns the socket timeout value.
*
- * @return positive value in milliseconds if a timeout is set,
- * {@code 0} if timeout is disabled or {@code -1} if
- * timeout is undefined.
+ * @return positive value in milliseconds if a timeout is set, {@code 0} if timeout is disabled
+ * or {@code -1} if timeout is undefined.
*/
int getSocketTimeoutMillis();
/**
- * Returns protocol version used by this connection or {@code null} if unknown.
+ * Returns this connection's SSL session or {@code null} if TLS has not been activated.
*
- * @since 5.0
+ * @return this connection's SSL session or {@code null} if TLS has not been activated.
*/
- ProtocolVersion getProtocolVersion();
+ SSLSession getSSLSession();
/**
- * @since 5.0
+ * Checks if this connection is open.
+ *
+ * @return true if it is open, false if it is closed.
*/
- SocketAddress getRemoteAddress();
+ boolean isOpen();
/**
- * @since 5.0
+ * Sets the socket timeout value.
+ *
+ * @param timeout
+ * timeout value in milliseconds
*/
- SocketAddress getLocalAddress();
+ void setSocketTimeoutMillis(int timeout);
}