WebSocketSession.java

Go to the documentation of this file.

package dev.rafex.ether.websocket.core;
 
/*-
 * #%L
 * ether-websocket-core
 * %%
 * Copyright (C) 2025 - 2026 Raúl Eduardo González Argote
 * %%
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * #L%
 */
 
import java.nio.ByteBuffer;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletionStage;
 
public interface WebSocketSession {
 
    String id();
 
    String path();
 
    String subprotocol();
 
    boolean isOpen();
 
    String pathParam(String name);
 
    String queryFirst(String name);
 
    List<String> queryAll(String name);
 
    String headerFirst(String name);
 
    Object attribute(String name);
 
    void attribute(String name, Object value);
 
    Map<String, String> pathParams();
 
    Map<String, List<String>> queryParams();
 
    Map<String, List<String>> headers();
 
    CompletionStage<Void> sendText(String text);
 
    CompletionStage<Void> sendBinary(ByteBuffer data);
 
    CompletionStage<Void> close(WebSocketCloseStatus status);
}