com.alipay.api.java_websocket.protocols

接口 IProtocol

所有已知实现类:

Protocol

public interface IProtocol

Interface which specifies all required methods for a Sec-WebSocket-Protocol

从以下版本开始:

1.3.7

方法概要

限定符和类型	方法和说明
boolean	acceptProvidedProtocol(String inputProtocolHeader) Check if the received Sec-WebSocket-Protocol header field contains a offer for the specific protocol
IProtocol	copyInstance() To prevent protocols to be used more than once the Websocket implementation should call this method in order to create a new usable version of a given protocol instance.
String	getProvidedProtocol() Return the specific Sec-WebSocket-protocol header offer for this protocol if the endpoint.
String	toString() Return a string which should contain the protocol name as well as additional information about the current configurations for this protocol (DEBUG purposes)

方法详细资料

acceptProvidedProtocol

boolean acceptProvidedProtocol(String inputProtocolHeader)

Check if the received Sec-WebSocket-Protocol header field contains a offer for the specific protocol

参数:

inputProtocolHeader - the received Sec-WebSocket-Protocol header field offered by the other endpoint

返回:

true, if the offer does fit to this specific protocol

从以下版本开始:

1.3.7

getProvidedProtocol

String getProvidedProtocol()

Return the specific Sec-WebSocket-protocol header offer for this protocol if the endpoint. If the extension returns an empty string (""), the offer will not be included in the handshake.

返回:

the specific Sec-WebSocket-Protocol header for this protocol

从以下版本开始:

1.3.7

copyInstance

IProtocol copyInstance()

To prevent protocols to be used more than once the Websocket implementation should call this method in order to create a new usable version of a given protocol instance.

返回:

a copy of the protocol

从以下版本开始:

1.3.7

toString

String toString()

Return a string which should contain the protocol name as well as additional information about the current configurations for this protocol (DEBUG purposes)

覆盖:

toString 在类中 Object

返回:

a string containing the protocol name as well as additional information

从以下版本开始:

1.3.7