com.tibco.as.space

Class InvokeOptions

java.lang.Object

com.tibco.as.space.InvokeOptions

All Implemented Interfaces:

SpaceOptions<InvokeOptions>

public abstract class InvokeOptions
extends java.lang.Object
implements SpaceOptions<InvokeOptions>

InvokeOptions allows you to specify various options for performing remote invocation operations. InvokeOptions is used as a parameter to the following methods of Space:

• Space.invoke(Tuple, InvokeOptions)
• Space.invokeLeeches(InvokeOptions)
• Space.invokeMember(Member, InvokeOptions)
• Space.invokeMembers(Collection, InvokeOptions)
• Space.invokeMembers(InvokeOptions)
• Space.invokeRemoteMembers(InvokeOptions)
• Space.invokeSeeders(InvokeOptions)

InvokeOptions is an abstract class. To create an instance of InvokeOptions, call create().

Constructor Summary

Constructors

Constructor and Description
InvokeOptions()

Method Summary

Modifier and Type	Method and Description
static InvokeOptions	create() Create default invoke options
abstract Tuple	getContext() Returns context tuple passed in
abstract java.lang.String	getInvocable() Deprecated.
abstract long	getTimeout() Timeout for invoke operation.
abstract InvokeOptions	setContext(Tuple context)
abstract InvokeOptions	setInvocable(java.lang.String invocable) Deprecated.
abstract InvokeOptions	setTimeout(long timeout) Set timeout for invoke operation

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tibco.as.space.SpaceOptions

getClosure, getResultHandler, setClosure, setResultHandler

Constructor Detail

InvokeOptions

public InvokeOptions()

Method Detail

create

public static InvokeOptions create()

Create default invoke options

Returns:

InvokeOptions

getTimeout

public abstract long getTimeout()

Timeout for invoke operation. Default behavior is to wait until invocation completes

Returns:

long timeout

setTimeout

public abstract InvokeOptions setTimeout(long timeout)

Set timeout for invoke operation

Parameters:

timeout - timeout in milliseconds

Returns:

InvokeOptions

setInvocable

public abstract InvokeOptions setInvocable(java.lang.String invocable)

Deprecated.

Parameters:

invocable - The class that implements the Invocable interface.

Returns:

Invocable

setContext

public abstract InvokeOptions setContext(Tuple context)

Parameters:

context - Tuple which can be used to pass extra arguments or data to the invoke method of the Invocable interface.

Returns:

InvokeOptions options

getInvocable

public abstract java.lang.String getInvocable()

Deprecated.

Returns Invocable as String

Returns:

Invocable

getContext

public abstract Tuple getContext()

Returns context tuple passed in

Returns:

Context object