org.eclipse.jetty.websocket.common.scopes.WebSocketSessionScope Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of websocket-common Show documentation

There is a newer version: 9.4.56.v20240826

//
//  ========================================================================
//  Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
//  ------------------------------------------------------------------------
//  All rights reserved. This program and the accompanying materials
//  are made available under the terms of the Eclipse Public License v1.0
//  and Apache License v2.0 which accompanies this distribution.
//
//      The Eclipse Public License is available at
//      http://www.eclipse.org/legal/epl-v10.html
//
//      The Apache License v2.0 is available at
//      http://www.opensource.org/licenses/apache2.0.php
//
//  You may elect to redistribute this code under either of these licenses.
//  ========================================================================
//

package org.eclipse.jetty.websocket.common.scopes;

import org.eclipse.jetty.websocket.common.WebSocketSession;

/**
 * Defined Scope for a WebSocketSession (active connection)
 */
public interface WebSocketSessionScope
{
    /**
     * Active {@link WebSocketSession} associated with this scope.
     *
     * @return the websocket session
     */
    WebSocketSession getWebSocketSession();

    /**
     * The parent {@link WebSocketContainerScope} for this session scope.
     *
     * @return the websocket container scope
     */
    WebSocketContainerScope getContainerScope();
}