org.eclipse.jetty.websocket.common.events

Interface EventDriverImpl

All Known Implementing Classes:

JettyAnnotatedImpl, JettyListenerImpl, JsrClientEndpointImpl, JsrEndpointImpl, JsrServerEndpointImpl, JsrServerExtendsEndpointImpl

public interface EventDriverImpl

A specific implementation of a EventDriver.

Method Summary

Methods

Modifier and Type	Method and Description
EventDriver	create(Object websocket, WebSocketPolicy policy) Create the EventDriver based on this implementation.
String	describeRule() human readable string describing the rule that would support this EventDriver.
boolean	supports(Object websocket) Test for if this implementation can support the provided websocket.

Method Detail

create

EventDriver create(Object websocket,
                 WebSocketPolicy policy)
                   throws Throwable

Create the EventDriver based on this implementation.

Parameters:

websocket - the websocket to wrap

policy - the policy to use

Returns:

the created EventDriver

Throws:

Throwable - if unable to create the EventDriver

describeRule

String describeRule()

human readable string describing the rule that would support this EventDriver.

Used to help developer with possible object annotations, listeners, or base classes.

Returns:

the human readable description of this event driver rule(s).

supports

boolean supports(Object websocket)

Test for if this implementation can support the provided websocket.

Parameters:

websocket - the possible websocket to test

Returns:

true if implementation can support it, false if otherwise.