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.simp.stomp;
018
019import org.springframework.messaging.tcp.TcpConnectionHandler;
020import org.springframework.util.concurrent.ListenableFuture;
021
022/**
023 * A {@link StompSession} that implements
024 * {@link org.springframework.messaging.tcp.TcpConnectionHandler
025 * TcpConnectionHandler} in order to send and receive messages.
026 *
027 * <p>A ConnectionHandlingStompSession can be used with any TCP or WebSocket
028 * library that is adapted to the {@code TcpConnectionHandler} contract.
029 *
030 * @author Rossen Stoyanchev
031 * @since 4.2
032 */
033public interface ConnectionHandlingStompSession extends StompSession, TcpConnectionHandler<byte[]> {
034
035        /**
036         * Return a future that will complete when the session is ready for use.
037         */
038        ListenableFuture<StompSession> getSessionFuture();
039
040}