1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.hc.core5.http;
29
30 import java.net.SocketAddress;
31
32 import org.apache.hc.core5.net.InetAddressUtils;
33 import org.apache.hc.core5.util.Timeout;
34
35 /**
36 * HTTP connection endpoint details.
37 *
38 * @since 5.0
39 */
40 public abstract class EndpointDetails implements HttpConnectionMetrics {
41
42 private final SocketAddress remoteAddress;
43 private final SocketAddress localAddress;
44 private final Timeout socketTimeout;
45
46 protected EndpointDetails(final SocketAddress remoteAddress, final SocketAddress localAddress, final Timeout socketTimeout) {
47 this.remoteAddress = remoteAddress;
48 this.localAddress = localAddress;
49 this.socketTimeout = socketTimeout;
50 }
51
52 public SocketAddress getRemoteAddress() {
53 return remoteAddress;
54 }
55
56 public SocketAddress getLocalAddress() {
57 return localAddress;
58 }
59
60 /**
61 * Gets the number of requests transferred over the connection,
62 * 0 if not available.
63 */
64 @Override
65 public abstract long getRequestCount();
66
67 /**
68 * Gets the number of responses transferred over the connection,
69 * 0 if not available.
70 */
71 @Override
72 public abstract long getResponseCount();
73
74 /**
75 * Gets the number of bytes transferred over the connection,
76 * 0 if not available.
77 */
78 @Override
79 public abstract long getSentBytesCount();
80
81 /**
82 * Gets the number of bytes transferred over the connection,
83 * 0 if not available.
84 */
85 @Override
86 public abstract long getReceivedBytesCount();
87
88 /**
89 * Gets the socket timeout.
90 *
91 * @return the socket timeout.
92 */
93 public Timeout getSocketTimeout() {
94 return socketTimeout;
95 }
96
97 @Override
98 public String toString() {
99 // Make enough room for two IPv6 addresses to avoid re-allocation in the StringBuilder.
100 final StringBuilder buffer = new StringBuilder(90);
101 InetAddressUtils.formatAddress(buffer, localAddress);
102 buffer.append("<->");
103 InetAddressUtils.formatAddress(buffer, remoteAddress);
104 return buffer.toString();
105 }
106
107 }