Package org.java_websocket.protocols

Class Protocol

java.lang.Object

org.java_websocket.protocols.Protocol

All Implemented Interfaces:

IProtocol

public class Protocol
extends Object
implements IProtocol

Class which represents the protocol used as Sec-WebSocket-Protocol

Since:

1.3.7

Constructor Summary

Constructors

Constructor	Description
Protocol(String providedProtocol)	Constructor for a Sec-Websocket-Protocol

Method Summary

Modifier and Type	Method	Description
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.
boolean	equals(Object o)
String	getProvidedProtocol()	Return the specific Sec-WebSocket-protocol header offer for this protocol if the endpoint.
int	hashCode()
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)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Protocol

public Protocol(String providedProtocol)

Constructor for a Sec-Websocket-Protocol

Parameters:

providedProtocol - the protocol string

Method Detail

acceptProvidedProtocol

public boolean acceptProvidedProtocol(String inputProtocolHeader)

Description copied from interface: IProtocol

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

Specified by:

acceptProvidedProtocol in interface IProtocol

Parameters:

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

Returns:

true, if the offer does fit to this specific protocol

getProvidedProtocol

public String getProvidedProtocol()

Description copied from interface: IProtocol

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.

Specified by:

getProvidedProtocol in interface IProtocol

Returns:

the specific Sec-WebSocket-Protocol header for this protocol

copyInstance

public IProtocol copyInstance()

Description copied from interface: IProtocol

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.

Specified by:

copyInstance in interface IProtocol

Returns:

a copy of the protocol

toString

public String toString()

Description copied from interface: IProtocol

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

Specified by:

toString in interface IProtocol

Overrides:

toString in class Object

Returns:

a string containing the protocol name as well as additional information

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object