com.digitalpetri.netty.fsm.ChannelActions Maven / Gradle / Ivy
Show all versions of netty-channel-fsm Show documentation
/*
* Copyright 2018 Kevin Herron
*
* 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
*
* 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.
*/
package com.digitalpetri.netty.fsm;
import java.util.concurrent.CompletableFuture;
import com.digitalpetri.strictmachine.FsmContext;
import io.netty.channel.Channel;
public interface ChannelActions {
/**
* Bootstrap a new {@link Channel} and return a {@link CompletableFuture} that completes successfully when the
* Channel is ready to use or completes exceptionally if the Channel could not be created or made ready to use for
* any reason.
*
* @param ctx the {@link FsmContext}.
* @return a {@link CompletableFuture} that completes successfully when the
* Channel is ready to use or completes exceptionally if the Channel could not be created or made ready to use for
* any reason.
*/
CompletableFuture connect(FsmContext ctx);
/**
* Perform any disconnect actions and then close {@code channel}, returning a {@link CompletableFuture} that
* completes successfully when the Channel has disconnected or completes exceptionally if the channel could not be
* disconnected for any reason.
*
* The state machine advances the same way regardless of how the future is completed.
*
* @param ctx the {@link FsmContext}.
* @param channel the {@link Channel} to disconnect.
* @return a {@link CompletableFuture} that completes successfully when the Channel
* * has disconnected or completes exceptionally if the channel could not be disconnected for any reason.
*/
CompletableFuture disconnect(FsmContext ctx, Channel channel);
/**
* Perform a keep-alive action because the Channel has been idle for longer than {@code maxIdleSeconds}.
*
* Although the keep-alive action is implementation dependent the intended usage would be to do something send a
* request that tests the Channel to make sure it's still valid.
*
* @param ctx the {@link FsmContext}
* @param channel the {@link Channel} to send the keep-alive on.
* @return a {@link CompletableFuture} that completes successfully if the channel is still valid and completes
* exceptionally otherwise.
*/
default CompletableFuture keepAlive(FsmContext ctx, Channel channel) {
return CompletableFuture.completedFuture(null);
}
}