Uses of Class
com.neovisionaries.ws.client.WebSocketFrame
-
Uses of WebSocketFrame in com.neovisionaries.ws.client
Fields in com.neovisionaries.ws.client declared as WebSocketFrameModifier and TypeFieldDescriptionprivate WebSocketFrameWebSocket.mClientCloseFrameprivate WebSocketFrameReadingThread.mCloseFrameprivate WebSocketFrameWritingThread.mCloseFrameprivate WebSocketFrameWebSocket.mServerCloseFrameFields in com.neovisionaries.ws.client with type parameters of type WebSocketFrameModifier and TypeFieldDescriptionprivate List<WebSocketFrame> ReadingThread.mContinuationprivate final LinkedList<WebSocketFrame> WritingThread.mFramesMethods in com.neovisionaries.ws.client that return WebSocketFrameModifier and TypeMethodDescription(package private) static WebSocketFrameWebSocketFrame.compressFrame(WebSocketFrame frame, PerMessageCompressionExtension pmce) static WebSocketFrameWebSocketFrame.createBinaryFrame(byte[] payload) Create a binary frame.private WebSocketFrameReadingThread.createCloseFrame(WebSocketException wse) static WebSocketFrameWebSocketFrame.createCloseFrame()Create a close frame.static WebSocketFrameWebSocketFrame.createCloseFrame(int closeCode) Create a close frame.static WebSocketFrameWebSocketFrame.createCloseFrame(int closeCode, String reason) Create a close frame.static WebSocketFrameWebSocketFrame.createContinuationFrame()Create a continuation frame.static WebSocketFrameWebSocketFrame.createContinuationFrame(byte[] payload) Create a continuation frame.static WebSocketFrameWebSocketFrame.createContinuationFrame(String payload) Create a continuation frame.private WebSocketFramePeriodicalFrameSender.createFrame()protected abstract WebSocketFramePeriodicalFrameSender.createFrame(byte[] payload) protected WebSocketFramePingSender.createFrame(byte[] payload) protected WebSocketFramePongSender.createFrame(byte[] payload) static WebSocketFrameWebSocketFrame.createPingFrame()Create a ping frame.static WebSocketFrameWebSocketFrame.createPingFrame(byte[] payload) Create a ping frame.static WebSocketFrameWebSocketFrame.createPingFrame(String payload) Create a ping frame.static WebSocketFrameWebSocketFrame.createPongFrame()Create a pong frame.static WebSocketFrameWebSocketFrame.createPongFrame(byte[] payload) Create a pong frame.static WebSocketFrameWebSocketFrame.createPongFrame(String payload) Create a pong frame.static WebSocketFrameWebSocketFrame.createTextFrame(String payload) Create a text frame.private WebSocketFrameReadingThread.readFrame()WebSocketInputStream.readFrame()WebSocketFrame.setCloseFramePayload(int closeCode, String reason) Set the payload that conforms to the payload format of close frames.WebSocketFrame.setFin(boolean fin) Set the value of FIN bit.(package private) WebSocketFrameWebSocketFrame.setMask(boolean mask) Set the value of MASK bit.WebSocketFrame.setOpcode(int opcode) Set the opcodeWebSocketFrame.setPayload(byte[] payload) Set the unmasked payload.WebSocketFrame.setPayload(String payload) Set the payload.WebSocketFrame.setRsv1(boolean rsv1) Set the value of RSV1 bit.WebSocketFrame.setRsv2(boolean rsv2) Set the value of RSV2 bit.WebSocketFrame.setRsv3(boolean rsv3) Set the value of RSV3 bit.Methods in com.neovisionaries.ws.client that return types with arguments of type WebSocketFrameModifier and TypeMethodDescriptionprivate static List<WebSocketFrame> WebSocketFrame.split(WebSocketFrame frame, int maxPayloadSize) private List<WebSocketFrame> WebSocket.splitIfNecessary(WebSocketFrame frame) (package private) static List<WebSocketFrame> WebSocketFrame.splitIfNecessary(WebSocketFrame frame, int maxPayloadSize, PerMessageCompressionExtension pmce) Methods in com.neovisionaries.ws.client with parameters of type WebSocketFrameModifier and TypeMethodDescriptionprivate voidWritingThread.addHighPriorityFrame(WebSocketFrame frame) voidListenerManager.callOnBinaryFrame(WebSocketFrame frame) private voidReadingThread.callOnBinaryFrame(WebSocketFrame frame) CallonBinaryFramemethod of the listeners.voidListenerManager.callOnCloseFrame(WebSocketFrame frame) private voidReadingThread.callOnCloseFrame(WebSocketFrame frame) CallonCloseFramemethod of the listeners.voidListenerManager.callOnContinuationFrame(WebSocketFrame frame) private voidReadingThread.callOnContinuationFrame(WebSocketFrame frame) CallonContinuationFramemethod of the listeners.voidListenerManager.callOnDisconnected(WebSocketFrame serverCloseFrame, WebSocketFrame clientCloseFrame, boolean closedByServer) voidListenerManager.callOnFrame(WebSocketFrame frame) private voidReadingThread.callOnFrame(WebSocketFrame frame) CallonFramemethod of the listeners.voidListenerManager.callOnFrameError(WebSocketException cause, WebSocketFrame frame) private voidReadingThread.callOnFrameError(WebSocketException cause, WebSocketFrame frame) CallonFrameErrormethod of the listeners.voidListenerManager.callOnFrameSent(WebSocketFrame frame) voidListenerManager.callOnFrameUnsent(WebSocketFrame frame) voidListenerManager.callOnPingFrame(WebSocketFrame frame) private voidReadingThread.callOnPingFrame(WebSocketFrame frame) CallonPingFramemethod of the listeners.voidListenerManager.callOnPongFrame(WebSocketFrame frame) private voidReadingThread.callOnPongFrame(WebSocketFrame frame) CallonPongFramemethod of the listeners.voidListenerManager.callOnSendError(WebSocketException cause, WebSocketFrame frame) voidListenerManager.callOnSendingFrame(WebSocketFrame frame) voidListenerManager.callOnTextFrame(WebSocketFrame frame) private voidReadingThread.callOnTextFrame(WebSocketFrame frame) CallonTextFramemethod of the listeners.(package private) static WebSocketFrameWebSocketFrame.compressFrame(WebSocketFrame frame, PerMessageCompressionExtension pmce) private byte[]ReadingThread.getMessage(WebSocketFrame frame) private booleanReadingThread.handleBinaryFrame(WebSocketFrame frame) private booleanReadingThread.handleCloseFrame(WebSocketFrame frame) private booleanReadingThread.handleContinuationFrame(WebSocketFrame frame) private booleanReadingThread.handleFrame(WebSocketFrame frame) private booleanReadingThread.handlePingFrame(WebSocketFrame frame) private booleanReadingThread.handlePongFrame(WebSocketFrame frame) private booleanReadingThread.handleTextFrame(WebSocketFrame frame) private static booleanWritingThread.isHighPriorityFrame(WebSocketFrame frame) voidWebSocketAdapter.onBinaryFrame(WebSocket websocket, WebSocketFrame frame) voidWebSocketListener.onBinaryFrame(WebSocket websocket, WebSocketFrame frame) Called when a binary frame (opcode = 0x2) was received.voidWebSocketAdapter.onCloseFrame(WebSocket websocket, WebSocketFrame frame) voidWebSocketListener.onCloseFrame(WebSocket websocket, WebSocketFrame frame) Called when a close frame (opcode = 0x8) was received.voidWebSocketAdapter.onContinuationFrame(WebSocket websocket, WebSocketFrame frame) voidWebSocketListener.onContinuationFrame(WebSocket websocket, WebSocketFrame frame) Called when a continuation frame (opcode = 0x0) was received.voidWebSocketAdapter.onDisconnected(WebSocket websocket, WebSocketFrame serverCloseFrame, WebSocketFrame clientCloseFrame, boolean closedByServer) voidWebSocketListener.onDisconnected(WebSocket websocket, WebSocketFrame serverCloseFrame, WebSocketFrame clientCloseFrame, boolean closedByServer) Called after the WebSocket connection was closed.voidWebSocketAdapter.onFrame(WebSocket websocket, WebSocketFrame frame) voidWebSocketListener.onFrame(WebSocket websocket, WebSocketFrame frame) Called when a frame was received.voidWebSocketAdapter.onFrameError(WebSocket websocket, WebSocketException cause, WebSocketFrame frame) voidWebSocketListener.onFrameError(WebSocket websocket, WebSocketException cause, WebSocketFrame frame) Called when a WebSocket frame failed to be read from the WebSocket.voidWebSocketAdapter.onFrameSent(WebSocket websocket, WebSocketFrame frame) voidWebSocketListener.onFrameSent(WebSocket websocket, WebSocketFrame frame) Called when a WebSocket frame was sent to the server (but not flushed yet).voidWebSocketAdapter.onFrameUnsent(WebSocket websocket, WebSocketFrame frame) voidWebSocketListener.onFrameUnsent(WebSocket websocket, WebSocketFrame frame) Called when a WebSocket frame was not sent to the server because a close frame has already been sent.voidWebSocketAdapter.onPingFrame(WebSocket websocket, WebSocketFrame frame) voidWebSocketListener.onPingFrame(WebSocket websocket, WebSocketFrame frame) Called when a ping frame (opcode = 0x9) was received.voidWebSocketAdapter.onPongFrame(WebSocket websocket, WebSocketFrame frame) voidWebSocketListener.onPongFrame(WebSocket websocket, WebSocketFrame frame) Called when a pong frame (opcode = 0xA) was received.(package private) voidWebSocket.onReadingThreadFinished(WebSocketFrame closeFrame) Called by the reading thread as its last step.voidWebSocketAdapter.onSendError(WebSocket websocket, WebSocketException cause, WebSocketFrame frame) voidWebSocketListener.onSendError(WebSocket websocket, WebSocketException cause, WebSocketFrame frame) Called when an error occurred when a frame was tried to be sent to the server.voidWebSocketAdapter.onSendingFrame(WebSocket websocket, WebSocketFrame frame) voidWebSocketListener.onSendingFrame(WebSocket websocket, WebSocketFrame frame) Called before a WebSocket frame is sent.voidWebSocketAdapter.onTextFrame(WebSocket websocket, WebSocketFrame frame) voidWebSocketListener.onTextFrame(WebSocket websocket, WebSocketFrame frame) Called when a text frame (opcode = 0x1) was received.(package private) voidWebSocket.onWritingThreadFinished(WebSocketFrame closeFrame) Called by the writing thread as its last step.booleanWritingThread.queueFrame(WebSocketFrame frame) WebSocket.sendFrame(WebSocketFrame frame) Send a WebSocket frame to the server.private voidWritingThread.sendFrame(WebSocketFrame frame) private static List<WebSocketFrame> WebSocketFrame.split(WebSocketFrame frame, int maxPayloadSize) private List<WebSocketFrame> WebSocket.splitIfNecessary(WebSocketFrame frame) (package private) static List<WebSocketFrame> WebSocketFrame.splitIfNecessary(WebSocketFrame frame, int maxPayloadSize, PerMessageCompressionExtension pmce) private voidReadingThread.verifyFrame(WebSocketFrame frame) private voidReadingThread.verifyFrameFragmentation(WebSocketFrame frame) private voidReadingThread.verifyFrameMask(WebSocketFrame frame) Ensure that the given frame is not masked.private voidReadingThread.verifyFrameOpcode(WebSocketFrame frame) Ensure that the opcode of the give frame is a known one.private voidReadingThread.verifyFrameSize(WebSocketFrame frame) private voidReadingThread.verifyReservedBit1(WebSocketFrame frame) Verify the RSV1 bit of a frame.private booleanReadingThread.verifyReservedBit1ForPMCE(WebSocketFrame frame) Verify the RSV1 bit of a frame using the rule described in RFC 7692.private voidReadingThread.verifyReservedBit2(WebSocketFrame frame) Verify the RSV2 bit of a frame.private voidReadingThread.verifyReservedBit3(WebSocketFrame frame) Verify the RSV3 bit of a frame.private voidReadingThread.verifyReservedBits(WebSocketFrame frame) voidWebSocketOutputStream.write(WebSocketFrame frame) private voidWebSocketOutputStream.writeFrame0(WebSocketFrame frame) private voidWebSocketOutputStream.writeFrame1(WebSocketFrame frame) private voidWebSocketOutputStream.writeFrameExtendedPayloadLength(WebSocketFrame frame) private voidWebSocketOutputStream.writeFramePayload(WebSocketFrame frame, byte[] maskingKey) Method parameters in com.neovisionaries.ws.client with type arguments of type WebSocketFrameModifier and TypeMethodDescriptionvoidListenerManager.callOnMessageError(WebSocketException cause, List<WebSocketFrame> frames) private voidReadingThread.callOnMessageError(WebSocketException cause, List<WebSocketFrame> frames) CallonMessageErrormethod of the listeners.private byte[]ReadingThread.concatenatePayloads(List<WebSocketFrame> frames) private byte[]ReadingThread.getMessage(List<WebSocketFrame> frames) voidWebSocketAdapter.onMessageError(WebSocket websocket, WebSocketException cause, List<WebSocketFrame> frames) voidWebSocketListener.onMessageError(WebSocket websocket, WebSocketException cause, List<WebSocketFrame> frames) Called when it failed to concatenate payloads of multiple frames to construct a message.