FlyStub

java.lang.Object
- com.zink.fly.stub.FlyStub

All Implemented Interfaces:: Fly, FlyPrime, MultiFly, NotiFly

public class FlyStub
extends java.lang.Object
implements Fly

Constructor Summary

Constructors
Constructor and Description

FlyStub(java.net.InetAddress addr, FieldCodec fieldCodec)

FlyStub(java.lang.String hostname, FieldCodec fieldCodec)

Constructors
Constructor and Description
`FlyStub(java.net.InetAddress addr, FieldCodec fieldCodec)`
`FlyStub(java.lang.String hostname, FieldCodec fieldCodec)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`notify(java.lang.Object template, NotifyHandler handler, long leaseTime)` Deprecated.
`boolean`	`notifyTake(java.lang.Object template, Notifiable handler, long leaseTime)` The notifyTake method sets up a template object in the Fly Space.
`boolean`	`notifyWrite(java.lang.Object template, Notifiable handler, long leaseTime)` The notifyWrite method sets up a template object in the Fly Space.
`java.lang.Object`	`read(java.lang.Object template, long timeout)` The read method can be used to read but not remove an object from the space.
`java.util.Collection`	`readMany(java.lang.Object template, long matchLimit)` The readMany method can be used to read but not remove a number of objects 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.
`java.lang.Object`	`take(java.lang.Object template, long timeout)` 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.
`java.util.Collection`	`takeMany(java.lang.Object template, long matchLimit)` The takeMany method can be used to take (remove) a number of objects from the space.
`long`	`write(java.lang.Object entry, long lease)` The write method will write an entry into the fly space for the amount of time given in the in the lease parameter.
`long`	`writeMany(java.util.Collection entries, long lease)` The writeMany method will write a collection of entry objects into the space for amount of time given in the in the lease parameter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FlyStub
```
public FlyStub(java.lang.String hostname,
               FieldCodec fieldCodec)
```
  - FlyStub
```
public FlyStub(java.net.InetAddress addr,
               FieldCodec fieldCodec)
```
- Method Detail
  - read
```
public java.lang.Object read(java.lang.Object template,
                             long timeout)
```
    Description copied from interface: FlyPrime
    
    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.
    
    Specified by:
    
    read in interface FlyPrime
    
    Parameters:
    
    template - - The object template to match in the space.
    
    timeout - - 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
```
public java.lang.Object take(java.lang.Object template,
                             long timeout)
```
    Description copied from interface: FlyPrime
    
    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.
    
    Specified by:
    
    take in interface FlyPrime
    
    Parameters:
    
    template - - The object template to match in the space.
    
    timeout - - 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.
  - write
```
public long write(java.lang.Object entry,
                  long lease)
```
    Description copied from interface: FlyPrime
    
    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.
    
    Specified by:
    
    write in interface FlyPrime
    
    Parameters:
    
    entry - - The object to put in the FlyPrime
    
    lease - - 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.
  - snapshot
```
public java.lang.Object snapshot(java.lang.Object template)
```
    Description copied from interface: FlyPrime
    
    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.
    
    Specified by:
    
    snapshot in interface FlyPrime
    
    Parameters:
    
    template - object
    
    Returns:
    
    snapshot object
  - writeMany
```
public long writeMany(java.util.Collection entries,
                      long lease)
```
    Description copied from interface: MultiFly
    
    The writeMany method will write a collection of entry objects into the space for amount of time given in the in the lease parameter. This is the time in milli-seconds that the objects will 'live' in the Space.
    
    Specified by:
    
    writeMany in interface MultiFly
    
    Parameters:
    
    entries - - The object to put in the Space
    
    lease - - The time in milliseconds the objects 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.
  - readMany
```
public java.util.Collection readMany(java.lang.Object template,
                                     long matchLimit)
```
    Description copied from interface: MultiFly
    
    The readMany method can be used to read but not remove a number of objects 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 matchLimit is a limit to number of objects that the method will return in the Collection. For example if the the space contains 1000 objects that will match the template and the match limit is set to 200, then only the first 200 matching objects will be returned in the collection. If on the other hand if the match limit is 200 and the space contains only 135 matching entries then all 135 entries will be returned.
    
    Specified by:
    
    readMany in interface MultiFly
    
    Parameters:
    
    template - - Template to match
    
    matchLimit - - The upper limit of matched objects to return
    
    Returns:
    
    A collection of objects that have been matched or empty if no matches
  - takeMany
```
public java.util.Collection takeMany(java.lang.Object template,
                                     long matchLimit)
```
    Description copied from interface: MultiFly
    
    The takeMany method can be used to take (remove) a number of objects 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 matchLimit is a limit to number of objects that the method will return in the Collection. For example if the the space contains 1000 objects that will match the template and the match limit is set to 200, then only the first 200 matching objects will be returned in the collection. If on the other hand if the match limit is 200 and the space contains only 135 matching entries then all 135 entries will be returned.
    
    Specified by:
    
    takeMany in interface MultiFly
    
    Parameters:
    
    template - - Template to match
    
    matchLimit - - The upper limit of matched objects to return
    
    Returns:
    
    A collection of objects that have been matched or empty if no matches
  - notify
```
@Deprecated
public boolean notify(java.lang.Object template,
                                  NotifyHandler handler,
                                  long leaseTime)
```
    Deprecated.
    
    Specified by:
    
    notify in interface NotiFly
    
    Parameters:
    
    template - - the template to match to triger this notify
    
    handler - - An object that implements the NotifyHandler interface
    
    leaseTime - - The time in milliseconds the template will live in the Space
    
    Returns:
    
    boolen - Setup ok
  - notifyWrite
```
public boolean notifyWrite(java.lang.Object template,
                           Notifiable handler,
                           long leaseTime)
```
    Description copied from interface: NotiFly
    
    The notifyWrite method sets up a template object in the Fly Space. If an object is written to the Space in the lifetime of the notify template, that matches the template, then the method templateMatched() will be called in the object that implements the interface NotifyHandler. Take care when setting up notify templates; a large number of pending notifies can impead 'write' performance in the space. Set the lease of the notify template to a reasonable time and renew the template lease periodicaly. Use the NotifyLeaseRenewer helper in the examples to periodicly renew leases.
    
    Specified by:
    
    notifyWrite in interface NotiFly
    
    Parameters:
    
    template - - the template to match to triger this notify
    
    handler - - An object that implements the NotifyHandler interface
    
    leaseTime - - The time in milliseconds the template will live in the Space
    
    Returns:
    
    boolen - Setup ok
  - notifyTake
```
public boolean notifyTake(java.lang.Object template,
                          Notifiable handler,
                          long leaseTime)
```
    Description copied from interface: NotiFly
    
    The notifyTake method sets up a template object in the Fly Space. If an object is taken from the Space in the lifetime of the notify template that matches the template, then the method templateMatched() will be called in the object that implements the interface NotifyHandler. Take care when setting up notify templates; a large number of peneding notifies can impead 'take' performance in the space. Set the lease of the notify template to a reasonable time and renew the template lease periodicaly. Use the NotifyLeaseRenewer helper in the examples to periodicly renew leases.
    
    Specified by:
    
    notifyTake in interface NotiFly
    
    Parameters:
    
    template - - the template to match to triger this notify
    
    handler - - An object that implements the NotifyHandler interface
    
    leaseTime - - The time in milliseconds the template will live in the Space
    
    Returns:
    
    boolen - Setup ok

Class FlyStub

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FlyStub

FlyStub

Method Detail

read

take

write

snapshot

writeMany

readMany

takeMany

notify

notifyWrite

notifyTake