reactor.netty.ChannelPipelineConfigurer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of reactor-netty-core Show documentation

Core functionality for the Reactor Netty library

There is a newer version: 1.2.0

/*
 * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved.
 *
 * Licensed 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
 *
 *   https://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.
 */
package reactor.netty;

import io.netty.channel.Channel;
import reactor.util.annotation.Nullable;

import java.net.SocketAddress;

import static reactor.netty.ReactorNetty.CompositeChannelPipelineConfigurer.compositeChannelPipelineConfigurer;

/**
 * Configure the channel pipeline while initializing the channel.
 *
 * @author Violeta Georgieva
 * @since 1.0.0
 */
@FunctionalInterface
public interface ChannelPipelineConfigurer {

	/**
	 * Return a noop configurer
	 *
	 * @return a noop configurer
	 */
	static ChannelPipelineConfigurer emptyConfigurer() {
		return ReactorNetty.NOOP_CONFIGURER;
	}

	/**
	 * Configure the channel pipeline while initializing the channel.
	 *
	 * @param connectionObserver the configured {@link ConnectionObserver}
	 * @param channel the channel
	 * @param remoteAddress the remote address
	 */
	void onChannelInit(ConnectionObserver connectionObserver, Channel channel, @Nullable SocketAddress remoteAddress);

	/**
	 * Chain together another {@link ChannelPipelineConfigurer}
	 *
	 * @param other the next {@link ChannelPipelineConfigurer}
	 *
	 * @return a new composite {@link ChannelPipelineConfigurer}
	 */
	default ChannelPipelineConfigurer then(ChannelPipelineConfigurer other) {
		return compositeChannelPipelineConfigurer(this, other);
	}
}