com.mobaijun.websocket.session.WebSocketSessionStore Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of websocket-spring-boot-starter Show documentation

spring boot's web socket component simplifies web socket operations

There is a newer version: 3.0.10

Show newest version

/*
 * Copyright (C) 2022 [www.mobaijun.com]
 *
 * 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 com.mobaijun.websocket.session;

import java.util.Collection;
import org.springframework.web.socket.WebSocketSession;

/**
 * Description: 存储 WebSocketSession 的接口
 * Author: [mobaijun]
 * Date: [2024/8/23 9:29]
 * IntelliJ IDEA Version: [IntelliJ IDEA 2023.1.4]
 */
public interface WebSocketSessionStore {

    /**
     * 添加一个 session
     *
     * @param session 待添加的 WebSocketSession
     */
    void addSession(WebSocketSession session);

    /**
     * 删除一个 session
     *
     * @param session WebSocketSession
     */
    void removeSession(WebSocketSession session) throws Exception;

    /**
     * 获取当前所有在线的 wsSessions
     *
     * @return Collection websocket session集合
     */
    Collection getSessions();

    /**
     * 根据指定的 sessionKey 获取对应的 wsSessions
     *
     * @param sessionKey wsSession 标识
     * @return Collection websocket session集合
     */
    Collection getSessions(Object sessionKey);

    /**
     * 获取所有的 sessionKeys
     *
     * @return sessionKey 集合
     */
    Collection