ch.icosys.popjava.core.annotation

Annotation Type POPObjectDescription

@Retention(value=RUNTIME)
 @Target(value=CONSTRUCTOR)
public @interface POPObjectDescription

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	LOCAL_DEBUG_URL

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
float	bandwidth Bandwidth requested
ConnectionType	connection The type of connection to be used to the remote host if the object has to be created remotely
java.lang.String	connectionSecret
java.lang.String	connector An available connector present in a network jobmanager: contact remote machine via the jobmanager direct: connect directly (ex SSH) to the remote machine
Encoding	encoding
int	id Method id of the constructor.
java.lang.String	jvmParameters JVM parameters to be used when creating this object
boolean	localJVM Don't spawn a new process when creating this object.
float	memory Memory requested
float	minBandwidth Minimum bandwidth necessary
float	minMemory Minimum memory necessary
float	minPower Minimum power necessary
java.lang.String	network A network available on this machine
float	power Power requested
java.lang.String[]	protocols Protocols this object should use.
int	searchDepth How many hops can we go after ours
int	searchTime How much time elapse between the start and end of a research in the grid.
boolean	tracking Enable method usage tracking on this method by user.
boolean	upnp Set to true to make the object automatically available over UPNP
java.lang.String	url <url> or <url>:<port> where the object should be.

Field Detail

LOCAL_DEBUG_URL

public static final java.lang.String LOCAL_DEBUG_URL

Element Detail

url

public abstract java.lang.String url

<url> or <url>:<port> where the object should be. If multiple protocol are active you should also define protocols()

Returns:

the url of the object

Default:

""

jvmParameters

public abstract java.lang.String jvmParameters

JVM parameters to be used when creating this object

Returns:

custom jvm parameters

Default:

""

connection

public abstract ConnectionType connection

The type of connection to be used to the remote host if the object has to be created remotely

Returns:

which type of connection should we use

Default:

ch.icosys.popjava.core.baseobject.ConnectionType.ANY

connectionSecret

public abstract java.lang.String connectionSecret

Default:

""

encoding

public abstract Encoding encoding

Default:

ch.icosys.popjava.core.annotation.Encoding.Default

upnp

public abstract boolean upnp

Set to true to make the object automatically available over UPNP

Default:

false

tracking

public abstract boolean tracking

Enable method usage tracking on this method by user.

Returns:

is tracking enabled

Default:

false

localJVM

public abstract boolean localJVM

Don't spawn a new process when creating this object.

Returns:

is a local jvm object

Default:

false

protocols

public abstract java.lang.String[] protocols

Protocols this object should use. Options: "" "protocol" "protocol:port" {"protocol1", "protocol2"} {"protocol1:port1", "protocol2"} {"protocol1:port1", "protocol2:port2"} If nothing is specified all available protocols will be used.

Returns:

the protocol specified

Default:

""

network

public abstract java.lang.String network

A network available on this machine

Returns:

the network we are working into

Default:

""

connector

public abstract java.lang.String connector

An available connector present in a network jobmanager: contact remote machine via the jobmanager direct: connect directly (ex SSH) to the remote machine

Returns:

which type of connector was specified

Default:

""

power

public abstract float power

Power requested

Returns:

how much power

Default:

-1.0f

minPower

public abstract float minPower

Minimum power necessary

Returns:

how much power

Default:

-1.0f

memory

public abstract float memory

Memory requested

Returns:

how much memory

Default:

-1.0f

minMemory

public abstract float minMemory

Minimum memory necessary

Returns:

how much memory

Default:

-1.0f

bandwidth

public abstract float bandwidth

Bandwidth requested

Returns:

how much bandwidth

Default:

-1.0f

minBandwidth

public abstract float minBandwidth

Minimum bandwidth necessary

Returns:

how much bandwidth

Default:

-1.0f

searchDepth

public abstract int searchDepth

How many hops can we go after ours

Returns:

how many nodes should we traverse

Default:

-1

searchTime

public abstract int searchTime

How much time elapse between the start and end of a research in the grid. if 0 the first node found is used. any other value bigger than 0 (ms) will be a forced wait.

Returns:

how much time should we wait for answers

Default:

-1

id

public abstract int id

Method id of the constructor. Only use this if you absolutely know what you are doing.

Returns:

the id

Default:

-1