Package io.quarkus.websockets.next

Interface HandshakeRequest

public interface HandshakeRequest

Provides some useful information about the initial handshake request.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SEC_WEBSOCKET_ACCEPT	See Sec-WebSocket-Accept.
static final String	SEC_WEBSOCKET_EXTENSIONS	See Sec-WebSocket-Extensions.
static final String	SEC_WEBSOCKET_KEY	See Sec-WebSocket-Key.
static final String	SEC_WEBSOCKET_PROTOCOL	See Sec-WebSocket-Protocol.
static final String	SEC_WEBSOCKET_VERSION	See Sec-WebSocket-Version.

Method Summary

Modifier and Type	Method	Description
String	header(String name)	The name is case insensitive.
Map<String,List<String>>	headers()	Returned header names are lower case.
List<String>	headers(String name)	The name is case insensitive.
String	host()
String	path()
int	port()
String	query()
String	scheme()

Field Details

SEC_WEBSOCKET_KEY

static final String SEC_WEBSOCKET_KEY

See Sec-WebSocket-Key.

See Also:

• Constant Field Values

SEC_WEBSOCKET_EXTENSIONS

static final String SEC_WEBSOCKET_EXTENSIONS

See Sec-WebSocket-Extensions.

See Also:

• Constant Field Values

SEC_WEBSOCKET_ACCEPT

static final String SEC_WEBSOCKET_ACCEPT

See Sec-WebSocket-Accept.

See Also:

• Constant Field Values

SEC_WEBSOCKET_PROTOCOL

static final String SEC_WEBSOCKET_PROTOCOL

See Sec-WebSocket-Protocol.

See Also:

• Constant Field Values

SEC_WEBSOCKET_VERSION

static final String SEC_WEBSOCKET_VERSION

See Sec-WebSocket-Version.

See Also:

• Constant Field Values

Method Details

header

String header(String name)

The name is case insensitive.

Parameters:

name -

Returns:

the first header value for the given header name, or null

See Also:

• SEC_WEBSOCKET_KEY
• SEC_WEBSOCKET_ACCEPT
• SEC_WEBSOCKET_EXTENSIONS
• SEC_WEBSOCKET_PROTOCOL
• SEC_WEBSOCKET_VERSION

headers

List<String> headers(String name)

The name is case insensitive.

Parameters:

name -

Returns:

an immutable list of header values for the given header name, never null

See Also:

• SEC_WEBSOCKET_KEY
• SEC_WEBSOCKET_ACCEPT
• SEC_WEBSOCKET_EXTENSIONS
• SEC_WEBSOCKET_PROTOCOL
• SEC_WEBSOCKET_VERSION

headers

Map<String,List<String>> headers()

Returned header names are lower case.

Returns:

an immutable map of header names to header values

scheme

String scheme()

Returns:

the scheme

host

String host()

Returns:

the host

port

int port()

Returns:

the port

path

String path()

Returns:

the path

query

String query()

Returns:

the query string