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.web.socket.sockjs.transport;
018
019import org.springframework.web.socket.WebSocketSession;
020
021/**
022 * SockJS extension of Spring's standard {@link WebSocketSession}.
023 *
024 * @author Juergen Hoeller
025 * @author Rossen Stoyanchev
026 * @since 4.0
027 */
028public interface SockJsSession extends WebSocketSession {
029
030        /**
031         * Return the time (in ms) since the session was last active, or otherwise
032         * if the session is new, then the time since the session was created.
033         */
034        long getTimeSinceLastActive();
035
036        /**
037         * Disable the SockJS heartbeat, presumably because a higher-level protocol
038         * has heartbeats enabled for the session already. It is not recommended to
039         * disable this otherwise, as it helps proxies to know the connection is
040         * not hanging.
041         */
042        void disableHeartbeat();
043
044}