javax.net.websocket

Interface ClientEndpointConfiguration

All Superinterfaces:

EndpointConfiguration

All Known Implementing Classes:

DefaultClientConfiguration, DefaultClientEndpointConfiguration

public interface ClientEndpointConfiguration
extends EndpointConfiguration

The ClientEndpointConfiguration is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.

Since:

DRAFT 001

Author:

dannycoward

Method Summary

Methods

Modifier and Type	Method and Description
List<Extension>	getExtensions() Return the list of all the extensions that this client supports.
List<String>	getPreferredSubprotocols() The ordered list of sub protocols a client endpoint would like to use.

Methods inherited from interface javax.net.websocket.EndpointConfiguration

getDecoders, getEncoders

Method Detail

getPreferredSubprotocols

List<String> getPreferredSubprotocols()

The ordered list of sub protocols a client endpoint would like to use. This list is used to generate the Sec-WebSocket-Protocol header in the opening handshake for clients using this configuration. The first protocol name is the most preferred. See Client Opening Handshake

Returns:

a list of subprotocols

getExtensions

List<Extension> getExtensions()

Return the list of all the extensions that this client supports. These are the extensions that will be used to populate the Sec-WebSocket-Extensions header in the opening handshake for clients using this configuration. The first extension in the list is the most preferred extension. See Negotiating Extensions

Returns:

a list of extensions