public Class Protocol

Constructor for a Sec-Websocket-Protocol

Parameters

providedProtocol:String

the protocol string

Implements org.java_websocket.protocols.IProtocol.acceptProvidedProtocol.

Doc from org.java_websocket.protocols.IProtocol.acceptProvidedProtocol.

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

Annotations

@Override

Implements org.java_websocket.protocols.IProtocol.copyInstance.

Doc from org.java_websocket.protocols.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.

Annotations

@Override

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

Implements org.java_websocket.protocols.IProtocol.getProvidedProtocol.

Doc from org.java_websocket.protocols.IProtocol.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.

Annotations

@Override

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

Overrides java.lang.Object.toString.

Implements org.java_websocket.protocols.IProtocol.toString.

Doc from org.java_websocket.protocols.IProtocol.toString.

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

Annotations

@Override