Package NeoVisionaries.WebSockets
High-quality WebSocket client implementation in Java. This implementation
- complies with RFC 6455 (The WebSocket Protocol),
- works on Java SE 1.5+ and Android,
- supports all the frame types (continuation, binary, text, close, ping and pong),
- provides a method to send a fragmented frame in addition to methods for unfragmented frames,
- provides a method to get the underlying raw socket of a WebSocket to configure it,
- provides a method for Basic Authentication,
- provides a factory class which utilizes
SocketFactory
interface, - provides a rich listener interface to hook WebSocket events,
- has fine-grained error codes for fine-grained controllability on errors,
- allows to disable validity checks on RSV1/RSV2/RSV3 bits and opcode of frames,
- supports HTTP proxy, especially "Secure WebSocket" (
wss
) through "Secure Proxy" (https
), - and supports RFC 7692 (Compression Extensions for WebSocket), also known as permessage-deflate (not enabled by default).
See the description of WebSocket
class for usage. The source code is hosted at
GitHub.
For Maven:
<dependency> <groupId>com.neovisionaries</groupId> <artifactId>nv-websocket-client</artifactId> <version>2.14</version> </dependency>
-
Interface Summary Java Entity Description PayloadGenerator Payload generatorWebSocketListener Listener interface to receive WebSocket eventsClass Summary Java Entity Description ProxySettings Proxy settingsSocketInitiator Lets multiple sockets race the given IP addresses until one has been establishedStatusLine HTTP status line returned from an HTTP serverWebSocket WebSocketWebSocketAdapter An empty implementation ofWebSocketListener
interfaceWebSocketCloseCode Close codeWebSocketExtension A class to hold the name and the parameters of a WebSocket extensionWebSocketFactory Factory to createWebSocket
instancesWebSocketFrame WebSocket frameWebSocketOpcode OpcodeEnum Summary Java Entity Description DualStackMode The dual stack mode defines which IP address families will be used to establish a connectionThreadType Types of threads which are created internally in the implementationWebSocketError WebSocket error codesWebSocketState WebSocket stateException Summary Java Entity Description HostnameUnverifiedException The certificate of the peer does not match the expected hostnameOpeningHandshakeException An exception raised due to a violation against the WebSocket protocolWebSocketException WebSocket exception