net.openhft.chronicle.network.api.session.SessionProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of chronicle-network Show documentation

Chronicle-Network

There is a newer version: 2.17.4

/*
 * Copyright 2016 higherfrequencytrading.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
 *
 *     http://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 net.openhft.chronicle.network.api.session;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * A holder for the Session speicifc details i.e. for a remote client.
 */
public interface SessionProvider {
    /**
     * @return the current session details
     */
    @Nullable
    SessionDetails get();

    /**
     * Replace the session details
     *
     * @param sessionDetails to set to
     */
    void set(@NotNull SessionDetails sessionDetails);

    /**
     * There is no longer any valid session detaisl and get() will return null.
     */
    void remove();
}