org.aoju.bus.http.socket

Interface WebSocket

All Known Implementing Classes:

RealWebSocket

public interface WebSocket

A non-blocking interface to a web socket. Use the factory to create instances; usually this is Client.

Web Socket Lifecycle

Upon normal operation each web socket progresses through a sequence of states:

• Connecting: the initial state of each web socket. Messages may be enqueued but they won't be transmitted until the web socket is open.
• Open: the web socket has been accepted by the remote peer and is fully operational. Messages in either direction are enqueued for immediate transmission.
• Closing: first of the peers on the web socket has initiated a graceful shutdown. The web socket will continue to transmit already-enqueued messages but will refuse to enqueue new ones.
• Closed: the web socket has transmitted all of its messages and has received all messages from the peer.

Web sockets may fail due to HTTP upgrade problems, connectivity problems, or if either peer chooses to short-circuit the graceful shutdown process:

• Canceled: the web socket connection failed. Messages that were successfully enqueued by either peer may not have been transmitted to the other.

Note that the state progression is independent for each peer. Arriving at a gracefully-closed state indicates that a peer has sent all of its outgoing messages and received all of its incoming messages. But it does not guarantee that the other peer will successfully receive all of its incoming messages.

Since:

JDK 1.8

Version:

3.6.5

Author:

Kimi Liu

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WebSocket.Factory

Method Summary

Modifier and Type	Method and Description
void	cancel()
boolean	close(int code, String reason)
long	queueSize()
Request	request()
boolean	send(ByteString bytes)
boolean	send(String text)

Method Detail

request

Request request()

queueSize

long queueSize()

send

boolean send(String text)

send

boolean send(ByteString bytes)

close

boolean close(int code,
              String reason)

cancel

void cancel()