com.taobao.api.internal.toplink.embedded.websocket

接口 WebSocket

所有已知实现类:

WebSocketBase, WebSocketDraft06, WebSocketDraft76, WebSocketImpl

public interface WebSocket

The Interface WebSocket.

作者:

Takahiro Hashimoto

方法概要

限定符和类型	方法和说明
void	awaitClose() await close
void	close() Close.
void	connect() Connect.
Frame	createFrame(byte[] bytes) Creates the frame.
Frame	createFrame(ByteBuffer buffer) Creates the frame.
Frame	createFrame(Object obj) Creates the frame.
Frame	createFrame(String str) Creates the frame.
int	getBufferSize() Gets the buffer size.
int	getConnectionTimeout() Gets the connection timeout.
InetSocketAddress	getEndpoint() Gets the endpoint.
URI	getLocation() Gets the location.
boolean	isBlockingMode() Checks if is blocking mode.
boolean	isConnected() Checks if is connected.
void	send(byte[] bytes) Send.
void	send(ByteBuffer buffer) Send.
void	send(Frame frame) Send.
void	send(String text) Send.
void	setBlockingMode(boolean blockingMode) Sets the blocking mode.
void	setConnectionTimeout(int connectionTimeout) Sets the connection timeout.

方法详细资料

send

void send(Frame frame)
   throws WebSocketException

Send.

参数:

frame - the frame

抛出:

WebSocketException - the web socket exception

send

void send(ByteBuffer buffer)
   throws WebSocketException

Send.

参数:

buffer - the ByteBuffer

抛出:

WebSocketException - the web socket exception

send

void send(byte[] bytes)
   throws WebSocketException

Send.

参数:

bytes - the bytes

抛出:

WebSocketException - the web socket exception

send

void send(String text)
   throws WebSocketException

Send.

参数:

text - the text

抛出:

WebSocketException - the web socket exception

connect

void connect()
      throws WebSocketException,
             IOException

Connect.

抛出:

WebSocketException - the web socket exception

IOException - Signals that an I/O exception has occurred.

isConnected

boolean isConnected()

Checks if is connected.

返回:

true, if is connected

close

void close()

Close.

awaitClose

void awaitClose()
         throws InterruptedException

await close

抛出:

InterruptedException

isBlockingMode

boolean isBlockingMode()

Checks if is blocking mode.

返回:

true, if is blocking mode

setBlockingMode

void setBlockingMode(boolean blockingMode)

Sets the blocking mode.

参数:

blockingMode - the new blocking mode

getLocation

URI getLocation()

Gets the location.

返回:

the location

getEndpoint

InetSocketAddress getEndpoint()

Gets the endpoint.

返回:

the endpoint

getBufferSize

int getBufferSize()

Gets the buffer size.

返回:

the buffer size

getConnectionTimeout

int getConnectionTimeout()

Gets the connection timeout.

返回:

the connection timeout

setConnectionTimeout

void setConnectionTimeout(int connectionTimeout)

Sets the connection timeout.

参数:

connectionTimeout - the new connection timeout

createFrame

Frame createFrame(Object obj)
           throws WebSocketException

Creates the frame.

参数:

obj - the obj

返回:

the frame

抛出:

WebSocketException - the web socket exception

createFrame

Frame createFrame(byte[] bytes)
           throws WebSocketException

Creates the frame.

参数:

bytes - the byte array

返回:

the frame

抛出:

WebSocketException - the web socket exception

createFrame

Frame createFrame(ByteBuffer buffer)
           throws WebSocketException

Creates the frame.

参数:

buffer - the ByteBuffer

返回:

the frame

抛出:

WebSocketException - the web socket exception

createFrame

Frame createFrame(String str)
           throws WebSocketException

Creates the frame.

参数:

str - the str

返回:

the frame

抛出:

WebSocketException - the web socket exception