Package de.craftsblock.craftsnet.api.requirements.websocket

Class MessageTypeRequirement

java.lang.Object

de.craftsblock.craftsnet.api.requirements.Requirement<T,RouteRegistry.EndpointMapping>

de.craftsblock.craftsnet.api.requirements.websocket.WebSocketRequirement<Frame>

de.craftsblock.craftsnet.api.requirements.websocket.MessageTypeRequirement

public class MessageTypeRequirement
extends WebSocketRequirement<Frame>

A specific websocket requirement that checks if the domain of a websocket connection matches certain criteria.

Since:

3.0.5-SNAPSHOT

See Also:

• WebRequirement

Constructor Summary

Constructors

Constructor	Description
MessageTypeRequirement()	Constructs a new websocket message type requirement.

Method Summary

Modifier and Type	Method	Description
boolean	applies(Frame frame, RouteRegistry.EndpointMapping endpointMapping)	Checks if the requirement applies given the specified websocket message and socket mapping.

Methods inherited from class de.craftsblock.craftsnet.api.requirements.Requirement

getAnnotation

Methods inherited from class java.lang.Object

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

Constructor Details

MessageTypeRequirement

public MessageTypeRequirement()

Constructs a new websocket message type requirement.

Method Details

applies

public boolean applies(Frame frame,
 RouteRegistry.EndpointMapping endpointMapping)

Checks if the requirement applies given the specified websocket message and socket mapping.

Specified by:

applies in class Requirement<Frame,RouteRegistry.EndpointMapping>

Parameters:

frame - the websocket message frame

endpointMapping - the socket mapping

Returns:

true if the requirement applies, false otherwise