Package org.javacord.core.util.gateway

Class DiscordWebSocketAdapter


  • public class DiscordWebSocketAdapter
extends com.neovisionaries.ws.client.WebSocketAdapter
    The main websocket adapter.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void disconnect​()
      Disconnects from the websocket.
      com.neovisionaries.ws.client.WebSocket getWebSocket​()
      Gets the websocket of the adapter.
      void handleCallbackError​(com.neovisionaries.ws.client.WebSocket websocket, Throwable cause)  
      CompletableFuture<Boolean> isReady​()
      Gets the Future which tells whether the connection is ready or failed.
      void onBinaryMessage​(com.neovisionaries.ws.client.WebSocket websocket, byte[] binary)  
      void onConnectError​(com.neovisionaries.ws.client.WebSocket websocket, com.neovisionaries.ws.client.WebSocketException exception)  
      void onDisconnected​(com.neovisionaries.ws.client.WebSocket websocket, com.neovisionaries.ws.client.WebSocketFrame serverCloseFrame, com.neovisionaries.ws.client.WebSocketFrame clientCloseFrame, boolean closedByServer)  
      void onError​(com.neovisionaries.ws.client.WebSocket websocket, com.neovisionaries.ws.client.WebSocketException cause)  
      void onTextMessage​(com.neovisionaries.ws.client.WebSocket websocket, String text)  
      void onUnexpectedError​(com.neovisionaries.ws.client.WebSocket websocket, com.neovisionaries.ws.client.WebSocketException cause)  
      void queueRequestGuildMembers​(Server server)
      Adds a server id to be queued for the "request guild members" packet.
      void sendVoiceStateUpdate​(Server server, ServerVoiceChannel channel, Boolean selfMuted, Boolean selfDeafened)
      Sends the voice state update packet.
      static void setGateway​(String gateway)
      Sets the gateway used to connect.
      void updateStatus​()
      Sends the update status packet.

      • Methods inherited from class com.neovisionaries.ws.client.WebSocketAdapter

        onBinaryFrame, onCloseFrame, onConnected, onContinuationFrame, onFrame, onFrameError, onFrameSent, onFrameUnsent, onMessageDecompressionError, onMessageError, onPingFrame, onPongFrame, onSendError, onSendingFrame, onSendingHandshake, onStateChanged, onTextFrame, onTextMessage, onTextMessageError, onThreadCreated, onThreadStarted, onThreadStopping

    • Constructor Detail

      • DiscordWebSocketAdapter

        public DiscordWebSocketAdapter​(DiscordApiImpl api)
        Creates a new discord websocket adapter.
        Parameters:
        api - The discord api instance.

    • Method Detail

      • setGateway

        public static void setGateway​(String gateway)
        Sets the gateway used to connect.
        Parameters:
        gateway - The gateway to set.

      • disconnect

        public void disconnect​()
        Disconnects from the websocket.

      • onDisconnected

        public void onDisconnected​(com.neovisionaries.ws.client.WebSocket websocket,
                           com.neovisionaries.ws.client.WebSocketFrame serverCloseFrame,
                           com.neovisionaries.ws.client.WebSocketFrame clientCloseFrame,
                           boolean closedByServer)
        Overrides:
        onDisconnected in class com.neovisionaries.ws.client.WebSocketAdapter

      • onTextMessage

        public void onTextMessage​(com.neovisionaries.ws.client.WebSocket websocket,
                          String text)
                   throws Exception
        Overrides:
        onTextMessage in class com.neovisionaries.ws.client.WebSocketAdapter
        Throws:
        Exception

      • onBinaryMessage

        public void onBinaryMessage​(com.neovisionaries.ws.client.WebSocket websocket,
                            byte[] binary)
                     throws Exception
        Overrides:
        onBinaryMessage in class com.neovisionaries.ws.client.WebSocketAdapter
        Throws:
        Exception

      • sendVoiceStateUpdate

        public void sendVoiceStateUpdate​(Server server,
                                 ServerVoiceChannel channel,
                                 Boolean selfMuted,
                                 Boolean selfDeafened)
        Sends the voice state update packet.
        Parameters:
        server - The server to send the voice state update for. Can be null if channel is given.
        channel - The channel to connect to or null to disconnect from voice.
        selfMuted - Whether to self-mute on the given server. If null, current state remains unchanged.
        selfDeafened - Whether to self-deafen on the given server. If null, current state remains unchanged.

      • getWebSocket

        public com.neovisionaries.ws.client.WebSocket getWebSocket​()
        Gets the websocket of the adapter.
        Returns:
        The websocket of the adapter.

      • isReady

        public CompletableFuture<Boolean> isReady​()
        Gets the Future which tells whether the connection is ready or failed.
        Returns:
        The Future.

      • updateStatus

        public void updateStatus​()
        Sends the update status packet.

      • queueRequestGuildMembers

        public void queueRequestGuildMembers​(Server server)
        Adds a server id to be queued for the "request guild members" packet.
        Parameters:
        server - The server.

      • onError

        public void onError​(com.neovisionaries.ws.client.WebSocket websocket,
                    com.neovisionaries.ws.client.WebSocketException cause)
        Overrides:
        onError in class com.neovisionaries.ws.client.WebSocketAdapter

      • handleCallbackError

        public void handleCallbackError​(com.neovisionaries.ws.client.WebSocket websocket,
                                Throwable cause)
        Overrides:
        handleCallbackError in class com.neovisionaries.ws.client.WebSocketAdapter

      • onUnexpectedError

        public void onUnexpectedError​(com.neovisionaries.ws.client.WebSocket websocket,
                              com.neovisionaries.ws.client.WebSocketException cause)
        Overrides:
        onUnexpectedError in class com.neovisionaries.ws.client.WebSocketAdapter

      • onConnectError

        public void onConnectError​(com.neovisionaries.ws.client.WebSocket websocket,
                           com.neovisionaries.ws.client.WebSocketException exception)
        Overrides:
        onConnectError in class com.neovisionaries.ws.client.WebSocketAdapter