com.fireflysource.net.websocket.client.WebSocketClientConnectionBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of firefly-net Show documentation

There is a newer version: 5.0.2

package com.fireflysource.net.websocket.client;

import com.fireflysource.net.websocket.common.WebSocketConnection;
import com.fireflysource.net.websocket.common.WebSocketMessageHandler;
import com.fireflysource.net.websocket.common.model.WebSocketPolicy;

import java.util.List;
import java.util.concurrent.CompletableFuture;

/**
 * @author Pengtao Qiu
 */
public interface WebSocketClientConnectionBuilder {

    /**
     * Set the websocket url.
     *
     * @param url The websocket url.
     * @return The websocket client connection builder.
     */
    WebSocketClientConnectionBuilder url(String url);

    /**
     * Set the websocket policy.
     *
     * @param policy The websocket policy.
     * @return The websocket client connection builder.
     */
    WebSocketClientConnectionBuilder policy(WebSocketPolicy policy);

    /**
     * Put the websocket extensions.
     *
     * @param extensions The websocket extensions.
     * @return The websocket client connection builder.
     */
    WebSocketClientConnectionBuilder extensions(List extensions);

    /**
     * Put the websocket sub protocols.
     *
     * @param subProtocols The websocket sub protocols.
     * @return The websocket client connection builder.
     */
    WebSocketClientConnectionBuilder subProtocols(List subProtocols);

    /**
     * Set the websocket message handler.
     *
     * @param handler The websocket handler.
     * @return The websocket client connection builder.
     */
    WebSocketClientConnectionBuilder onMessage(WebSocketMessageHandler handler);

    /**
     * Create the websocket connection.
     *
     * @return The future websocket connection.
     */
    CompletableFuture connect();
}