Package com.neovisionaries.ws.client

High-quality WebSocket client implementation in Java.

See: Description

Interface Summary

Interface	Description
WebSocketListener	Listener interface to receive web socket events.

Class Summary

Class	Description
ProxySettings	Proxy settings.
WebSocket	Web socket.
WebSocketAdapter	An empty implementation of WebSocketListener interface.
WebSocketCloseCode	Close code.
WebSocketExtension	A class to hold the name and the parameters of a web socket extension.
WebSocketFactory	Factory to create WebSocket instances.
WebSocketFrame	Web socket frame.
WebSocketOpcode	Opcode.

Enum Summary

Enum	Description
WebSocketError	Web socket error codes.
WebSocketState	Web socket state.

Exception Summary

Exception	Description
WebSocketException	Web socket exception.

Package com.neovisionaries.ws.client Description

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 web socket to configure it,
• provides a method for Basic Authentication,
• provides a factory class which utilizes SocketFactory interface,
• provides a rich listener interface to hook web socket 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,
• and supports HTTP proxy, especially "Secure WebSocket" (wss) through "Secure Proxy" (https).

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>1.16</version>
 </dependency>

Version:

1.16

Author:

Takahiko Kawasaki