com.zink.fly

Interface FlyPrime

All Known Subinterfaces:

Fly, MultiFly, NotiFly

All Known Implementing Classes:

FlyStub

public interface FlyPrime

FlyPrime is the simple (but powerful) interface to a Fly systems. Use this interface to read, write and take java objects to and from the Fly server.

Method Summary

Modifier and Type	Method and Description
<T> T	read(T template, long waitTime) The read method can be used to read but not remove an object from the space.
java.lang.Object	snapshot(java.lang.Object template) Snapshot will make a copy of an object which may help the stub prepare the object for submission to the space.
<T> T	take(T template, long waitTime) The Take method uses the same matching strategy as the read method via the template, however if an object is matched under this (take) method the object is removed from the space and returned.
long	write(java.lang.Object entry, long leaseTime) The write method will write an entry into the fly space for the amount of time given in the in the lease parameter.

Method Detail

write

long write(java.lang.Object entry,
           long leaseTime)

The write method will write an entry into the fly space for the amount of time given in the in the lease parameter. This is the time in milli-seconds that the object will 'live' in the space.

Parameters:

entry - - The object to put in the FlyPrime

leaseTime - - The time in milliseconds the object will live in the Space

Returns:

leaseTime - The space can return a shorter lease than the requested lease time. To be sure that your object has been leased for the given time check that the returned lease is the same as the requested lease.

read

<T> T read(T template,
           long waitTime)

The read method can be used to read but not remove an object from the space. The template will be matched on all of its non-null fields. If fields are set to null this means that the template will match any value in that field. The waitTime is the time in milliseconds that this method will block, waiting for an object to appear that matches the template.

Parameters:

template - - The object template to match in the space.

waitTime - - Time in milliseconds to wait before the object is matched.

Returns:

The object tht has been matched or null if the template has not been matched in the given wait time.

take

<T> T take(T template,
           long waitTime)

The Take method uses the same matching strategy as the read method via the template, however if an object is matched under this (take) method the object is removed from the space and returned.

Parameters:

template - - The object template to match in the space.

waitTime - - The time to wait in milliseconds for the template to be matched.

Returns:

The object tht has been matched or null if no object has been matched in the given wait time.

snapshot

java.lang.Object snapshot(java.lang.Object template)

Snapshot will make a copy of an object which may help the stub prepare the object for submission to the space. This is an non essential method but may be used for performance reasons, if for example a templae is not going to channge and is going to be submitted many times to the space in a read or take method.

Parameters:

template - object

Returns:

snapshot object