XPRD

Field Detail

• fsrvPort

  public int fsrvPort

  UDP port number used by findXsrvs for its broadcast messages. Default value: 2514

• fsrvIteration

  public int fsrvIteration

  Number of iterations performed by findXsrvs. Default value: 1

• fsrvMaxWait

  public int fsrvMaxWait

  Maximum amount of time (in milliseconds) the function findXsrvs waits for replies. Default value: 1000

• rcmdEnv

  public java.util.Map<java.lang.String,java.lang.String> rcmdEnv

  Environment variables to be defined when starting Mosel via 'rcmd'. A variable can be removed from the target environment by associating a null value to this variable. Default value: null

Constructor Detail

• XPRD

  public XPRD()

  Generate an XPRD object for remote Mosel instance management.

Method Detail

• findXsrvs

  public int findXsrvs(int group,
                       int maxIps,
                       java.util.Set<java.lang.String> addrs)

  Search xprmsrv servers on the local network. This function sends a broadcast message over the local network and waits for replies from running xprmsrv servers. A given server will reply only to selected group numbers: the group argument specifies this property. The IP addresses of the hosts having replied to the request are returned via the last argument of the function in the form of strings. The maximum size of this set is fixed by maxIps. Note that the provided set is not cleared: if it already contains maxIps elements the routine returns immediately.

  Parameters:

  group - group number of the request

  maxIps - maximum number of addresses to collect

  addrs - set to return addresses as strings

  Returns:

  the size of addrs or -1 if the socket cannot be created

  See Also:

  fsrvPort, fsrvIteration, fsrvMaxWait

• start

  public static void start()

  Start the dispatcher. Each dispatcher started with this method must be terminated by a call to shutdown()

• shutdown

  public static void shutdown()

  Shut down the dispatcher. This method must be used in pair with start()

• setKeepAlive

  public static boolean setKeepAlive(long maxfail,
                                     long interval)

  Change the keepalive timer settings. The server sends to its client a keepalive message at fixed interval. A connection is considered broken if more than maxfail* interval seconds have elapsed since the last message received. Setting 0 for maxfail disables this mechanism.

  Parameters:

  maxfail - number of time intervals before the connection is considered broken (use 0 to disable; default value:2)

  interval - number of seconds between 2 keepalive messages (default value:60)

  Returns:

  true if the operation is successful. This function can be used only if no node is connected

• connect

  public XPRDMosel connect(java.lang.String cnstr,
                           XPRDFileManager fmgr)
                    throws java.io.IOException

  Create a new instance using a user defined file manager by opening a connection.

  Parameters:

  cnstr - connection string. An empty string is equivalent to "rcmd:mosel -r"

  fmgr - optional file manager (may be null).

  Returns:

  the newly connected instance

  Throws:

  java.io.IOException - If the connection fails.

• connect

  public XPRDMosel connect(java.lang.String cnstr)
                    throws java.io.IOException

  Create a new instance by opening a connection.

  Parameters:

  cnstr - connection string. An empty string is equivalent to "rcmd:mosel -r"

  Returns:

  the newly connected instance

  Throws:

  java.io.IOException - If the connection fails.

  See Also:

  connect(cnstr,null)

• disconnect

  public int disconnect(XPRDMosel inst)

  Disconnect the specified instance.

  Parameters:

  inst - instance to disconnect

  Returns:

  exit status of the instance

  Throws:

  java.util.NoSuchElementException - If the instance is not connected through this XPRD

• isQueueEmpty

  public boolean isQueueEmpty()

  Check whether the event queue is empty.

  Returns:

  true if the queue of events is empty

• getNextEvent

  public XPRDEvent getNextEvent()

  Get the next event in the queue.

  Returns:

  next available event or null if the queue is empty

• dropNextEvent

  public void dropNextEvent()

  Drop the next event in the queue. Nothing is done if the queue is empty

• waitForEvent

  public void waitForEvent()

  Wait until an event is available.

• waitForEvent

  public void waitForEvent(long timeout)

  Wait until an event is available with a time limit.

  Parameters:

  timeout - time limit in seconds