com.github.patrick.websocket

Class WebSocketAPI

com.github.patrick.websocket.WebSocketAPI

public class WebSocketAPI

This API object provides simple WebSocket client for Bukkit plugins.

Field Detail

INSTANCE

public static WebSocketAPI INSTANCE

This API object provides simple WebSocket client for Bukkit plugins.

Constructor Detail

WebSocketAPI

private WebSocketAPI()

This API object provides simple WebSocket client for Bukkit plugins.

Method Detail

createWebSocket

@JvmStatic
 @Nullable
public static WebSocketClient createWebSocket(@NotNull
                                                                      java.lang.String url)

Creates a websocket client without tls support. Returns null when websocket has no response.

Parameters:

url - websocket url to connect

Returns:

nullable WebSocketClient

createWebSocket

@JvmStatic
 @Nullable
public static WebSocketClient createWebSocket(@NotNull
                                                                      java.lang.String url,
                                                                      boolean tls,
                                                                      boolean suppress)

Creates a websocket client with tls option. Returns null when websocket has no response.

Parameters:

url - websocket url to connect

tls - whether to use tls support

Returns:

nullable WebSocketClient

createUnsafeWebSocket

@JvmStatic
 @NotNull
public static WebSocketClient createUnsafeWebSocket(@NotNull
                                                                           java.lang.String url)

Creates a websocket client without tls support. This method throws WebSocketNoResponseException when websocket has no response.

Parameters:

url - websocket url to connect

Returns:

WebSocketClient

createUnsafeWebSocket

@JvmStatic
 @NotNull
public static WebSocketClient createUnsafeWebSocket(@NotNull
                                                                           java.lang.String url,
                                                                           boolean tls,
                                                                           boolean suppress)

Creates a websocket client with tls option. This method throws WebSocketNoResponseException when websocket has no response.

Parameters:

url - websocket url to connect

tls - whether to use tls support

Returns:

WebSocketClient