okhttp3.HttpClientConnectionManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of buession-httpclient Show documentation
Buession Framework Http Client
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
 * See the NOTICE file distributed with this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and limitations under the License.
 *
 * =========================================================================================================
 *
 * This software consists of voluntary contributions made by many individuals on behalf of the
 * Apache Software Foundation. For more information on the Apache Software Foundation, please see
 * .
 *
 * +-------------------------------------------------------------------------------------------------------+
 * | License: http://www.apache.org/licenses/LICENSE-2.0.txt 										       |
 * | Author: Yong.Teng  													       |
 * | Copyright @ 2013-2024 Buession.com Inc.														       |
 * +-------------------------------------------------------------------------------------------------------+
 */
package okhttp3;

import java.io.Closeable;
import java.io.IOException;
import java.util.Optional;
import java.util.concurrent.TimeUnit;

/**
 * okhttp(3) 连接管理器
 *
 * @author Yong.Teng
 * @since 1.3.1
 */
public class HttpClientConnectionManager implements Closeable {

	private ConnectionPool connectionPool;

	/**
	 * 最大连接数
	 *
	 * @since 2.0.1
	 */
	private int maxConnections = 5;

	/**
	 * 闲连接存活时长，单位：毫秒
	 *
	 * @since 2.0.1
	 */
	private int idleConnectionTime = 5 * 60 * 1000;

	/**
	 * 默认的最大并发请求数量
	 *
	 * @since 2.3.0
	 */
	private int maxRequests;

	/**
	 * 同时请求相同主机的请求数量最大值
	 *
	 * @since 2.3.0
	 */
	private int maxRequestsPerHost;

	public HttpClientConnectionManager() {
	}

	public HttpClientConnectionManager(ConnectionPool connectionPool) {
		this.connectionPool = connectionPool;
	}

	public ConnectionPool getConnectionPool() {
		if(connectionPool == null){
			connectionPool = new ConnectionPool(maxConnections, idleConnectionTime, TimeUnit.MILLISECONDS);
		}

		return connectionPool;
	}

	public void setConnectionPool(ConnectionPool connectionPool) {
		this.connectionPool = connectionPool;
	}

	/**
	 * 返回最大链接数
	 *
	 * @return 最大链接数
	 *
	 * @since 2.3.0
	 */
	public int getMaxConnections() {
		return maxConnections;
	}

	/**
	 * 设置最大链接数
	 *
	 * @param maxConnections
	 * 		最大链接数
	 *
	 * @since 2.0.1
	 */
	public void setMaxConnections(int maxConnections) {
		this.maxConnections = maxConnections;
	}

	/**
	 * 返回空闲连接存活时长，单位：毫秒
	 *
	 * @return 空闲连接存活时长
	 *
	 * @since 2.3.0
	 */
	public int getIdleConnectionTime() {
		return idleConnectionTime;
	}

	/**
	 * 设置闲连接存活时长，单位：毫秒
	 *
	 * @param idleConnectionTime
	 * 		闲连接存活时长
	 */
	public void setIdleConnectionTime(int idleConnectionTime) {
		this.idleConnectionTime = idleConnectionTime;
	}

	/**
	 * 返回默认的最大并发请求数量
	 *
	 * @return 默认的最大并发请求数量
	 *
	 * @since 2.3.0
	 */
	public int getMaxRequests() {
		return maxRequests;
	}

	/**
	 * 设置默认的最大并发请求数量
	 *
	 * @param maxRequests
	 * 		默认的最大并发请求数量
	 *
	 * @since 2.3.0
	 */
	public void setMaxRequests(int maxRequests) {
		this.maxRequests = maxRequests;
	}

	/**
	 * 返回同时请求相同主机的请求数量最大值
	 *
	 * @return 同时请求相同主机的请求数量最大值
	 *
	 * @since 2.3.0
	 */
	public int getMaxRequestsPerHost() {
		return maxRequestsPerHost;
	}

	/**
	 * 设置同时请求相同主机的请求数量最大值
	 *
	 * @param maxRequestsPerHost
	 * 		同时请求相同主机的请求数量最大值
	 *
	 * @since 2.3.0
	 */
	public void setMaxRequestsPerHost(int maxRequestsPerHost) {
		this.maxRequestsPerHost = maxRequestsPerHost;
	}

	@Override
	public void close() throws IOException {
		Optional.ofNullable(connectionPool).ifPresent(ConnectionPool::evictAll);
	}

}