Package com.attivio.client.streaming

Class StreamRequestInfo

java.lang.Object

com.attivio.client.streaming.StreamRequestInfo

All Implemented Interfaces:

java.lang.Cloneable

public class StreamRequestInfo
extends java.lang.Object
implements java.lang.Cloneable

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_BUFFER_SIZE
static long	DEFAULT_CONNECT_TIMEOUT	Default connection timeout.
static long	DEFAULT_MIN_KEEPALIVE_PING_FREQUENCE_MILLIS	Default smallest number of milliseconds between pings sent to the client.
protected StreamMode	documentMode
protected boolean	facets
static java.lang.String	PROP_PREFIX

Constructor Summary

Constructors

Constructor	Description
StreamRequestInfo()
StreamRequestInfo(PlatformMessage msg)

Method Summary

Modifier and Type	Method	Description
StreamRequestInfo	clone()
boolean	equals(java.lang.Object obj)
int	getBufferSize()
long	getConnectTimeout()	Get the connection timeout (milliseconds).
StreamMode	getDocumentMode()	Get the mode for streaming documents.
long	getKeepAlivePingFrequency()
int	getRoutingDepth()	EXPERT: Should not be set by clients.
int	hashCode()
boolean	isSSL()
boolean	isStreamDocumentIds()
boolean	isStreamDocuments()
boolean	isStreamFacets()
static boolean	messageContainsStreamRequest(PlatformMessage msg)
void	serializeIntoMessage(PlatformMessage msg)
void	setBufferSize(int value)
void	setConnectTimeout(long value)	Set the connection timeout (milliseconds).
void	setDocumentMode(StreamMode value)	Get the mode for streaming documents.
protected void	setDocumentMode(java.lang.String value)
void	setKeepAliveFrequency(long keepAliveFrequency)
void	setRoutingDepth(int value)	EXPERT: Should not be set by clients.
void	setSSL(boolean value)
void	setStreamDocumentIds(boolean value)	Deprecated. use setDocumentMode(StreamMode).
void	setStreamDocuments(boolean value)	Deprecated. use setDocumentMode(StreamMode).
void	setStreamFacets(boolean value)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CONNECT_TIMEOUT

public static final long DEFAULT_CONNECT_TIMEOUT

Default connection timeout.

See Also:

Constant Field Values

DEFAULT_MIN_KEEPALIVE_PING_FREQUENCE_MILLIS

public static final long DEFAULT_MIN_KEEPALIVE_PING_FREQUENCE_MILLIS

Default smallest number of milliseconds between pings sent to the client. A value of 0 indicates not to send pings to the client. Zero is the default.

See Also:

Constant Field Values

PROP_PREFIX

public static final java.lang.String PROP_PREFIX

See Also:

Constant Field Values

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

documentMode

protected StreamMode documentMode

facets

protected boolean facets

Constructor Detail

StreamRequestInfo

public StreamRequestInfo()

StreamRequestInfo

public StreamRequestInfo(PlatformMessage msg)

Method Detail

messageContainsStreamRequest

public static boolean messageContainsStreamRequest(PlatformMessage msg)

serializeIntoMessage

public void serializeIntoMessage(PlatformMessage msg)

getConnectTimeout

public long getConnectTimeout()

Get the connection timeout (milliseconds).

The client must connect to the stream within this timeout or the query will fail.

setConnectTimeout

public void setConnectTimeout(long value)

Set the connection timeout (milliseconds).

getRoutingDepth

public int getRoutingDepth()

EXPERT: Should not be set by clients.

This value is used when dispatching streamed requests across multiple engines and should not be set/used by the client.

isSSL

public boolean isSSL()

setSSL

public void setSSL(boolean value)

setRoutingDepth

public void setRoutingDepth(int value)

EXPERT: Should not be set by clients.

This value is used when dispatching streamed requests across multiple engines and should not be set/used by the client.

getBufferSize

public int getBufferSize()

setBufferSize

public void setBufferSize(int value)

getDocumentMode

public StreamMode getDocumentMode()

Get the mode for streaming documents.

setDocumentMode

public void setDocumentMode(StreamMode value)

Get the mode for streaming documents.

setDocumentMode

protected void setDocumentMode(java.lang.String value)

isStreamDocuments

public boolean isStreamDocuments()

isStreamDocumentIds

public boolean isStreamDocumentIds()

setStreamDocumentIds

@Deprecated
public void setStreamDocumentIds(boolean value)

Deprecated.

use setDocumentMode(StreamMode).

setStreamDocuments

@Deprecated
public void setStreamDocuments(boolean value)

Deprecated.

use setDocumentMode(StreamMode).

isStreamFacets

public boolean isStreamFacets()

setStreamFacets

public void setStreamFacets(boolean value)

getKeepAlivePingFrequency

public long getKeepAlivePingFrequency()

Returns:

the keepAliveFrequency

setKeepAliveFrequency

public void setKeepAliveFrequency(long keepAliveFrequency)

Parameters:

keepAliveFrequency - the keepAliveFrequency to set

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

public StreamRequestInfo clone()

Overrides:

clone in class java.lang.Object