org.spincast.core.websocket

Interface IWebsocketEndpointManager

All Superinterfaces:

IWebsocketEndpointWriter

All Known Subinterfaces:

IWebsocketEndpoint

All Known Implementing Classes:

SpincastWebsocketEndpoint

public interface IWebsocketEndpointManager
extends IWebsocketEndpointWriter

Manager for a WebSocket endpoint. Extend IWebsocketEndpointWriter since it can write on the endpoint, but also adds some managements features.

Method Summary

Modifier and Type	Method and Description
void	closeEndpoint() Closes the entire WebSocket endpoint.
void	closeEndpoint(int closingCode, String closingReason) Closes the entire WebSocket endpoint.
void	closePeer(String peerId) Closes a specific peer connection on the endpoint.
void	closePeer(String peerId, int closingCode, String closingReason) Closes a specific peer connection on the endpoint.
String	getEndpointId() The endpoint id
Set<String>	getPeersIds() The connected peers' ids.

Methods inherited from interface org.spincast.core.websocket.IWebsocketEndpointWriter

sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessageExcept, sendMessageExcept, sendMessageExcept, sendMessageExcept

Method Detail

getEndpointId

String getEndpointId()

The endpoint id

getPeersIds

Set<String> getPeersIds()

The connected peers' ids.

closePeer

void closePeer(String peerId)

Closes a specific peer connection on the endpoint.

closePeer

void closePeer(String peerId,
               int closingCode,
               String closingReason)

Closes a specific peer connection on the endpoint.

closeEndpoint

void closeEndpoint()

Closes the entire WebSocket endpoint. All peer connections of this endpoint will be closed and the endpoint will be removed.

closeEndpoint

void closeEndpoint(int closingCode,
                   String closingReason)

Closes the entire WebSocket endpoint. All peer connections of this endpoint will be closed and the endpoint will be removed.