com.rabbitmq.client.SocketChannelConfigurators Maven / Gradle / Ivy
Show all versions of amqp-client Show documentation
// Copyright (c) 2018-2020 VMware, Inc. or its affiliates. All rights reserved.
//
// This software, the RabbitMQ Java client library, is triple-licensed under the
// Mozilla Public License 1.1 ("MPL"), the GNU General Public License version 2
// ("GPL") and the Apache License version 2 ("ASL"). For the MPL, please see
// LICENSE-MPL-RabbitMQ. For the GPL, please see LICENSE-GPL2. For the ASL,
// please see LICENSE-APACHE2.
//
// This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
// either express or implied. See the LICENSE file for specific language governing
// rights and limitations of this software.
//
// If you have any questions regarding licensing, please contact us at
// [email protected].
package com.rabbitmq.client;
import java.io.IOException;
import java.nio.channels.SocketChannel;
/**
* Ready-to-use instances and builder for {@link SocketChannelConfigurator}.
*
* Note {@link SocketChannelConfigurator}s can be combined with
* {@link AbstractSocketChannelConfigurator#andThen(SocketChannelConfigurator)}.
*
* @since 4.8.0
*/
public abstract class SocketChannelConfigurators {
/**
* Disable Nagle's algorithm.
*/
public static final AbstractSocketChannelConfigurator DISABLE_NAGLE_ALGORITHM =
new AbstractSocketChannelConfigurator() {
@Override
public void configure(SocketChannel socketChannel) throws IOException {
SocketConfigurators.DISABLE_NAGLE_ALGORITHM.configure(socketChannel.socket());
}
};
/**
* Default {@link SocketChannelConfigurator} that disables Nagle's algorithm.
*/
public static final AbstractSocketChannelConfigurator DEFAULT = DISABLE_NAGLE_ALGORITHM;
/**
* The default {@link SocketChannelConfigurator} that disables Nagle's algorithm.
*
* @return
*/
public static AbstractSocketChannelConfigurator defaultConfigurator() {
return DEFAULT;
}
/**
* {@link SocketChannelConfigurator} that disables Nagle's algorithm.
*
* @return
*/
public static AbstractSocketChannelConfigurator disableNagleAlgorithm() {
return DISABLE_NAGLE_ALGORITHM;
}
/**
* Builder to configure and creates a {@link SocketChannelConfigurator} instance.
*
* @return
*/
public static SocketChannelConfigurators.Builder builder() {
return new SocketChannelConfigurators.Builder();
}
public static abstract class AbstractSocketChannelConfigurator implements SocketChannelConfigurator {
/**
* Returns a composed configurator that performs, in sequence, this
* operation followed by the {@code after} operation.
*
* @param after the operation to perform after this operation
* @return a composed configurator that performs in sequence this
* operation followed by the {@code after} operation
* @throws NullPointerException if {@code after} is null
*/
public AbstractSocketChannelConfigurator andThen(final SocketChannelConfigurator after) {
if (after == null) {
throw new NullPointerException();
}
return new AbstractSocketChannelConfigurator() {
@Override
public void configure(SocketChannel socketChannel) throws IOException {
AbstractSocketChannelConfigurator.this.configure(socketChannel);
after.configure(socketChannel);
}
};
}
}
public static class Builder {
private AbstractSocketChannelConfigurator configurator = new AbstractSocketChannelConfigurator() {
@Override
public void configure(SocketChannel channel) {
}
};
/**
* Set default configuration.
*
* @return
*/
public Builder defaultConfigurator() {
configurator = configurator.andThen(DEFAULT);
return this;
}
/**
* Disable Nagle's Algorithm.
*
* @return
*/
public Builder disableNagleAlgorithm() {
configurator = configurator.andThen(DISABLE_NAGLE_ALGORITHM);
return this;
}
/**
* Add an extra configuration step.
*
* @param extraConfiguration
* @return
*/
public Builder add(SocketChannelConfigurator extraConfiguration) {
configurator = configurator.andThen(extraConfiguration);
return this;
}
/**
* Return the configured {@link SocketConfigurator}.
*
* @return
*/
public SocketChannelConfigurator build() {
return configurator;
}
}
}