/*
* ====================================================================
* 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
* <http://www.apache.org/>.
*
*/
package org.apache.http.nio.params;
import org.apache.http.params.HttpParams;
import org.apache.http.util.Args;
Utility class for accessing I/O reactor parameters in HttpParams
. See Also: Since: 4.0 Deprecated: (4.2) use IOReactorConfig
/**
* Utility class for accessing I/O reactor parameters in {@link HttpParams}.
*
* @since 4.0
*
* @see NIOReactorPNames
*
* @deprecated (4.2) use {@link org.apache.http.impl.nio.reactor.IOReactorConfig}
*/
@Deprecated
public final class NIOReactorParams implements NIOReactorPNames {
private NIOReactorParams() {
super();
}
Obtains the value of NIOReactorPNames.CONTENT_BUFFER_SIZE
parameter. If not set, defaults to 4096
. Params: - params – HTTP parameters.
Returns: content buffer size.
/**
* Obtains the value of {@link NIOReactorPNames#CONTENT_BUFFER_SIZE} parameter.
* If not set, defaults to {@code 4096}.
*
* @param params HTTP parameters.
* @return content buffer size.
*/
public static int getContentBufferSize(final HttpParams params) {
Args.notNull(params, "HTTP parameters");
return params.getIntParameter(CONTENT_BUFFER_SIZE, 4096);
}
Sets value of the NIOReactorPNames.CONTENT_BUFFER_SIZE
parameter. Params: - params – HTTP parameters.
- size – content buffer size.
/**
* Sets value of the {@link NIOReactorPNames#CONTENT_BUFFER_SIZE} parameter.
*
* @param params HTTP parameters.
* @param size content buffer size.
*/
public static void setContentBufferSize(final HttpParams params, final int size) {
Args.notNull(params, "HTTP parameters");
params.setIntParameter(CONTENT_BUFFER_SIZE, size);
}
Obtains the value of NIOReactorPNames.SELECT_INTERVAL
parameter. If not set, defaults to 1000
. Params: - params – HTTP parameters.
Returns: I/O select interval in milliseconds.
/**
* Obtains the value of {@link NIOReactorPNames#SELECT_INTERVAL} parameter.
* If not set, defaults to {@code 1000}.
*
* @param params HTTP parameters.
* @return I/O select interval in milliseconds.
*/
public static long getSelectInterval(final HttpParams params) {
Args.notNull(params, "HTTP parameters");
return params.getLongParameter(SELECT_INTERVAL, 1000);
}
Sets value of the NIOReactorPNames.SELECT_INTERVAL
parameter. Params: - params – HTTP parameters.
- ms – I/O select interval in milliseconds.
/**
* Sets value of the {@link NIOReactorPNames#SELECT_INTERVAL} parameter.
*
* @param params HTTP parameters.
* @param ms I/O select interval in milliseconds.
*/
public static void setSelectInterval(final HttpParams params, final long ms) {
Args.notNull(params, "HTTP parameters");
params.setLongParameter(SELECT_INTERVAL, ms);
}
Obtains the value of NIOReactorPNames.GRACE_PERIOD
parameter. If not set, defaults to 500
. Params: - params – HTTP parameters.
Returns: shutdown grace period in milliseconds.
/**
* Obtains the value of {@link NIOReactorPNames#GRACE_PERIOD} parameter.
* If not set, defaults to {@code 500}.
*
* @param params HTTP parameters.
* @return shutdown grace period in milliseconds.
*/
public static long getGracePeriod(final HttpParams params) {
Args.notNull(params, "HTTP parameters");
return params.getLongParameter(GRACE_PERIOD, 500);
}
Sets value of the NIOReactorPNames.GRACE_PERIOD
parameter. Params: - params – HTTP parameters.
- ms – shutdown grace period in milliseconds.
/**
* Sets value of the {@link NIOReactorPNames#GRACE_PERIOD} parameter.
*
* @param params HTTP parameters.
* @param ms shutdown grace period in milliseconds.
*/
public static void setGracePeriod(final HttpParams params, final long ms) {
Args.notNull(params, "HTTP parameters");
params.setLongParameter(GRACE_PERIOD, ms);
}
Obtains the value of NIOReactorPNames.INTEREST_OPS_QUEUEING
parameter. If not set, defaults to false
. Params: - params – HTTP parameters.
Returns: interest ops queuing flag. Since: 4.1
/**
* Obtains the value of {@link NIOReactorPNames#INTEREST_OPS_QUEUEING} parameter.
* If not set, defaults to {@code false}.
*
* @param params HTTP parameters.
* @return interest ops queuing flag.
*
* @since 4.1
*/
public static boolean getInterestOpsQueueing(final HttpParams params) {
Args.notNull(params, "HTTP parameters");
return params.getBooleanParameter(INTEREST_OPS_QUEUEING, false);
}
Sets value of the NIOReactorPNames.INTEREST_OPS_QUEUEING
parameter. Params: - params – HTTP parameters.
- interestOpsQueueing – interest ops queuing.
Since: 4.1
/**
* Sets value of the {@link NIOReactorPNames#INTEREST_OPS_QUEUEING} parameter.
*
* @param params HTTP parameters.
* @param interestOpsQueueing interest ops queuing.
*
* @since 4.1
*/
public static void setInterestOpsQueueing(
final HttpParams params, final boolean interestOpsQueueing) {
Args.notNull(params, "HTTP parameters");
params.setBooleanParameter(INTEREST_OPS_QUEUEING, interestOpsQueueing);
}
}