flex.messaging.client
Class UserAgentSettings

java.lang.Object
  flex.messaging.client.UserAgentSettings

public class UserAgentSettings
extends Object

A class to hold user agent specific properties. For example, in streaming endpoints, a certain number of bytes need to be written before the streaming connection can be used and this value is specific to user agents. Similarly, the number of simultaneous connections a session can have is user agent specific.

Field Summary

static int	DEFAULT_MAX_STREAMING_CONNECTIONS_PER_SESSION The default number of streaming connections per session.
static int	FIREFOX_KICKSTART_BYTES Bytes needed to kickstart the streaming connections for Firefox.
static String	GENERIC_FIREFOX_USER_AGENT The prefix of the version token used by Firefox in its user agent values.
static String	GENERIC_MSIE_USER_AGENT The prefix of the version token used by IE in its user agent values.
static int	MSIE_KICKSTART_BYTES Bytes needed to kickstart the streaming connections for IE.

Constructor Summary

UserAgentSettings()

Method Summary

static UserAgentSettings	getAgent(String matchOn) Static method to retrieve pre-initialized IE and Firefox user agents.
int	getKickstartBytes() Returns the number of bytes needed to kickstart the streaming connections for the user agent.
String	getMatchOn() Returns the String to use to match the agent.
int	getMaxStreamingConnectionsPerSession() Returns the number of simultaneous streaming connections per session the user agent supports.
void	setKickstartBytes(int kickstartBytes) Sets the number of bytes needed to kickstart the streaming connections for the user agent.
void	setMatchOn(String matchOn) Sets the String to use to match the agent.
void	setMaxStreamingConnectionsPerSession(int maxStreamingConnectionsPerSession) Sets the number of simultaneous streaming connections per session the user agent supports.

Methods inherited from class java.lang.Object

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

Field Detail

GENERIC_MSIE_USER_AGENT

public static final String GENERIC_MSIE_USER_AGENT

The prefix of the version token used by IE in its user agent values. This lets us sniff for all IE versions.

See Also:

Constant Field Values

MSIE_KICKSTART_BYTES

public static final int MSIE_KICKSTART_BYTES

Bytes needed to kickstart the streaming connections for IE.

See Also:

Constant Field Values

GENERIC_FIREFOX_USER_AGENT

public static final String GENERIC_FIREFOX_USER_AGENT

The prefix of the version token used by Firefox in its user agent values. This lets us sniff for all Firefox versions.

See Also:

Constant Field Values

FIREFOX_KICKSTART_BYTES

public static final int FIREFOX_KICKSTART_BYTES

Bytes needed to kickstart the streaming connections for Firefox.

See Also:

Constant Field Values

DEFAULT_MAX_STREAMING_CONNECTIONS_PER_SESSION

public static final int DEFAULT_MAX_STREAMING_CONNECTIONS_PER_SESSION

The default number of streaming connections per session. In IE, there can be 4 persistent HTTP connections per session. In Firefox, this number is determined by network.http.max-connections-per-server config which is 8 by default. Streaming endpoints can technically support one less than this number of streaming connections per session (3 for IE, 7 for Firefox) but by default, we will have one streaming connection per session which can be changed by increasing maxStreamingConnectionsPerSession property if needed.

See Also:

Constant Field Values

Constructor Detail

UserAgentSettings

public UserAgentSettings()

Method Detail

getAgent

public static UserAgentSettings getAgent(String matchOn)

Static method to retrieve pre-initialized IE and Firefox user agents.

Parameters:

matchOn - String to use match the agent.

getMatchOn

public String getMatchOn()

Returns the String to use to match the agent.

Returns:

The String to use to match the agent.

setMatchOn

public void setMatchOn(String matchOn)

Sets the String to use to match the agent.

Parameters:

matchOn - The String to use to match the agent.

getKickstartBytes

public int getKickstartBytes()

Returns the number of bytes needed to kickstart the streaming connections for the user agent.

Returns:

The number of bytes needed to kickstart the streaming connections for the user agent.

setKickstartBytes

public void setKickstartBytes(int kickstartBytes)

Sets the number of bytes needed to kickstart the streaming connections for the user agent.

Parameters:

kickstartBytes - The number of bytes needed to kickstart the streaming connections for the user agent.

getMaxStreamingConnectionsPerSession

public int getMaxStreamingConnectionsPerSession()

Returns the number of simultaneous streaming connections per session the user agent supports.

Returns:

The number of streaming connections per session the user agent supports.

setMaxStreamingConnectionsPerSession

public void setMaxStreamingConnectionsPerSession(int maxStreamingConnectionsPerSession)

Sets the number of simultaneous streaming connections per session the user agent supports.

Parameters:

maxStreamingConnectionsPerSession - The number of simultaneous streaming connections per session the user agent supports.