001/*
002 * Copyright 2002-2015 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.messaging.tcp;
018
019import org.springframework.util.concurrent.ListenableFuture;
020
021/**
022 * A contract for establishing TCP connections.
023 *
024 * @author Rossen Stoyanchev
025 * @since 4.0
026 * @param <P> the type of payload for in and outbound messages
027 */
028public interface TcpOperations<P> {
029
030        /**
031         * Open a new connection.
032         * @param connectionHandler a handler to manage the connection
033         * @return a ListenableFuture that can be used to determine when and if the
034         * connection is successfully established
035         */
036        ListenableFuture<Void> connect(TcpConnectionHandler<P> connectionHandler);
037
038        /**
039         * Open a new connection and a strategy for reconnecting if the connection fails.
040         * @param connectionHandler a handler to manage the connection
041         * @param reconnectStrategy a strategy for reconnecting
042         * @return a ListenableFuture that can be used to determine when and if the
043         * initial connection is successfully established
044         */
045        ListenableFuture<Void> connect(TcpConnectionHandler<P> connectionHandler, ReconnectStrategy reconnectStrategy);
046
047        /**
048         * Shut down and close any open connections.
049         * @return a ListenableFuture that can be used to determine when and if the
050         * connection is successfully closed
051         */
052        ListenableFuture<Void> shutdown();
053
054}