Package jenkins.websocket

Class WebSocketSession

java.lang.Object

jenkins.websocket.WebSocketSession

@Restricted(org.kohsuke.accmod.restrictions.Beta.class)
public abstract class WebSocketSession
extends Object

One WebSocket connection.

Since:

2.216

See Also:

• WebSockets

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebSocketSession()

Method Summary

Modifier and Type	Method	Description
protected void	binary(byte[] payload, int offset, int len)
protected final void	close()
protected void	closed(int statusCode, String reason)
protected void	error(Throwable cause)
protected void	opened()
protected final Future<Void>	sendBinary(ByteBuffer data)
protected final Future<Void>	sendBinary(ByteBuffer partialByte, boolean isLast)
protected final Future<Void>	sendText(String text)
protected void	text(String message)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebSocketSession

protected WebSocketSession()

Method Details

opened

protected void opened()

closed

protected void closed(int statusCode,
 String reason)

error

protected void error(Throwable cause)

binary

protected void binary(byte[] payload,
 int offset,
 int len)
               throws IOException

Throws:

IOException

text

protected void text(String message)
             throws IOException

Throws:

IOException

sendBinary

protected final Future<Void> sendBinary(ByteBuffer data)
                                 throws IOException

Throws:

IOException

sendBinary

protected final Future<Void> sendBinary(ByteBuffer partialByte,
 boolean isLast)
                                 throws IOException

Throws:

IOException

sendText

protected final Future<Void> sendText(String text)
                               throws IOException

Throws:

IOException

close

protected final void close()
                    throws IOException

Throws:

IOException