TIBCO.EFTL.IKVMap Interface Reference

A key-value map object represents a program's connection to an FTL map. More...

Public Member Functions
void	Get (String key, IKVMapListener listener)
	Get the value of a key from the map, or null if the key is not set More...
void	Remove (String key, IKVMapListener listener)
	Remove a key-value pair from the map. More...
void	Set (String key, IMessage value, IKVMapListener listener)
	Set a key-value pair in the map, overwriting any existing value. More...

Detailed Description

A key-value map object represents a program's connection to an FTL map.

Programs use key-value map objects to set, get, and remove key-value pairs in an FTL map.

Member Function Documentation

void TIBCO.EFTL.IKVMap.Get	(	String	key,
		IKVMapListener	listener
	)

Get the value of a key from the map, or null if the key is not set

This call returns immediately; getting continues asynchronously. When the get completes successfully, the eFTL library calls your IKVListener.OnSuccess callback.

Parameters

key	Get the value for this key.
listener	This listener defines callback methods for successful completion and for errors.

Exceptions

Exception

The connection is not open.

See Also

IKVMapListener, IConnection.CreateKVMap

void TIBCO.EFTL.IKVMap.Remove	(	String	key,
		IKVMapListener	listener
	)

Remove a key-value pair from the map.

This call returns immediately; removing continues asynchronously. When the remove completes successfully, the eFTL library calls your IKVListener.OnSuccess callback.

Parameters

key	Remove the value for this key.
listener	This listener defines callback methods for successful completion and for errors.

Exceptions

Exception

The connection is not open.

See Also

IKVMapListener, IConnection.CreateKVMap

void TIBCO.EFTL.IKVMap.Set	(	String	key,
		IMessage	value,
		IKVMapListener	listener
	)

Set a key-value pair in the map, overwriting any existing value.

This call returns immediately; setting continues asynchronously. When the set completes successfully, the eFTL library calls your IKVListener.OnSuccess callback.

Parameters

key	Set the value for this key.
value	Set this value for the key.
listener	This listener defines callback methods for successful completion and for errors.

Exceptions

Exception	The connection is not open.
Exception	The message would exceed the eFTL server's maximum message size.

See Also

IKVMapListener, IConnection.CreateKVMap