io.fluxcapacitor.javaclient.web.SocketSession Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

Default Java client library for interfacing with Flux Capacitor.

There is a newer version: 0.1015.0

/*
 * Copyright (c) Flux Capacitor IP B.V. or its affiliates. All Rights Reserved.
 *
 * 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 io.fluxcapacitor.javaclient.web;

import io.fluxcapacitor.common.Guarantee;

import java.util.concurrent.CompletableFuture;

public interface SocketSession {

    String sessionId();

    default void sendMessage(Object value) {
        sendMessage(value, Guarantee.NONE);
    }

    CompletableFuture sendMessage(Object value, Guarantee guarantee);

    default void sendPing(Object value) {
        sendPing(value, Guarantee.NONE);
    }

    CompletableFuture sendPing(Object value, Guarantee guarantee);

    default void close() {
        close(Guarantee.NONE);
    }

    default void close(int closeReason) {
        close(closeReason, Guarantee.NONE);
    }

    default CompletableFuture close(Guarantee guarantee) {
        return close(1000, guarantee);
    }

    CompletableFuture close(int closeReason, Guarantee guarantee);
}