javax.net.websocket
Interface ClientContainer

All Known Subinterfaces:

ServerContainer

All Known Implementing Classes:

ServerContainerImpl

public interface ClientContainer

A ClientContainer is an implementation provided object that allows the developer to initiate a web socket handshake from the provided endpoint.

Since:

DRAFT 001

Author:

dannycoward

Method Summary

void	connectToServer(Endpoint endpoint, ClientConfiguration olc) Connect the supplied endpoint to its server using the supplied handshake parameters
Set<Session>	getActiveSessions() Return an unordered collection of the currently active web socket sessions.
long	getMaxBinaryMessageBufferSize() Returns the maximum size of binary message in number of bytes that this container will buffer.
long	getMaxSessionIdleTimeout() Return the maximum time in seconds that a web socket session may be idle before the container may close it.
long	getMaxTextMessageBufferSize() Sets the maximum size of text message in number of bytes that this container will buffer.
void	setMaxBinaryMessageBufferSize(long max) Sets the maximum size of binary message in number of bytes that this container will buffer.
void	setMaxSessionIdleTimeout(long timeout) Sets the maximum time in seconds that a web socket session may be idle before the container may close it.
void	setMaxTextMessageBufferSize(long max) Returns the maximum size of text message in number of bytes that this container will buffer.

Method Detail

connectToServer

void connectToServer(Endpoint endpoint,
                     ClientConfiguration olc)

Connect the supplied endpoint to its server using the supplied handshake parameters

Parameters:

endpoint -

olc -

getActiveSessions

Set<Session> getActiveSessions()

Return an unordered collection of the currently active web socket sessions.

Returns:

getMaxSessionIdleTimeout

long getMaxSessionIdleTimeout()

Return the maximum time in seconds that a web socket session may be idle before the container may close it.

Returns:

setMaxSessionIdleTimeout

void setMaxSessionIdleTimeout(long timeout)

Sets the maximum time in seconds that a web socket session may be idle before the container may close it.

getMaxBinaryMessageBufferSize

long getMaxBinaryMessageBufferSize()

Returns the maximum size of binary message in number of bytes that this container will buffer.

Returns:

setMaxBinaryMessageBufferSize

void setMaxBinaryMessageBufferSize(long max)

Sets the maximum size of binary message in number of bytes that this container will buffer.

getMaxTextMessageBufferSize

long getMaxTextMessageBufferSize()

Sets the maximum size of text message in number of bytes that this container will buffer.

Returns:

setMaxTextMessageBufferSize

void setMaxTextMessageBufferSize(long max)

Returns the maximum size of text message in number of bytes that this container will buffer.