Rmif.Remote

java.lang.Object
- nxm.ice.net.Rmif.Remote

All Implemented Interfaces:

nxm.sys.inc.IDable, nxm.sys.inc.MessageHandler

Enclosing class:

Rmif
```
public class Rmif.Remote
extends java.lang.Object
implements nxm.sys.inc.IDable, nxm.sys.inc.MessageHandler
```
local reference to remote process

Field Summary

Fields
Modifier and Type Field and Description

java.lang.String host

nxm.sys.inc.MessageHandler mh

Rmif.Remote next

Rmif rmif

Fields
Modifier and Type	Field and Description
`java.lang.String`	`host`
`nxm.sys.inc.MessageHandler`	`mh`
`Rmif.Remote`	`next`
`Rmif`	`rmif`

Constructor Summary

Constructors
Constructor and Description

Remote()
Generic constructor.

Remote(Rmif rmif)
Generic constructor that sets default values using Rmif instance.

Constructors
Constructor and Description
`Remote()` Generic constructor.
`Remote(Rmif rmif)` Generic constructor that sets default values using Rmif instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAliveStatus()` Check to see of the connection is alive (checks for a timeout), returns "ON" or "OFF".
`int`	`getDropped()` Gets the count of dropped RDP packets (sent to remote, but not received by remote).
`java.lang.String`	`getHost()` Gets the host address of the connection.
`java.lang.String`	`getID()` local ID for remote command
`double`	`getLatency()` Gets an estimate of link latency (in seconds).
`double`	`getLinkBW()` Gets the estimated link bandwidth for this Remote.
`int`	`getLost()` Deprecated. Since NeXtMidas 2.5.0: Not used, always 0.
`int`	`getMaxQueue()` Gets the default value for maximum number of packets on the RDP queue.
`int`	`getPort()` Gets the port number used by this connection.
`int`	`getRecvQueue()` Gets the number of RDP messages on the recvQueue.
`int`	`getRecvSeq()` Gets the current recv sequence number for RDP packets.
`int`	`getReOrdered()` Gets the total number of RDP packets received out-of-order for this Remote.
`int`	`getRetried()`
`int`	`getRetry()` Gets the max number of retries for this Remote.
`int`	`getSendQueue()` Gets the number of queued RDP messages waiting to be sent.
`int`	`getSendSeq()` Gets the current send sequence number for RDP packets.
`int`	`getState()` Gets the current link status as an int.
`java.lang.String`	`getStatus()` Gets the current link status as a string.
`java.lang.String`	`getTag()` brief description of command
`double`	`getTimeLost()` Get time before declaring a RDP packet lost (seconds) for this Remote.
`double`	`getTimeRetry()` Gets time to retry (seconds) for this Remote.
`int`	`getWindow()` Gets the max window size used.
`boolean`	`isClient()` Get if this Remote is a client instance, otherwise it is a server instance.
`boolean`	`isClosed()` Return true if this Remote is closed, false otherwise.
`boolean`	`isOpen()` Deprecated. Since NeXtMidas 2.5.0: Use `isOpening()` or `isOpened()`. This method is functionally identical to `isOpening()` even though its name implied that it was the same as `isOpened()`.
`boolean`	`isOpened()` Return true if this Remote is open (client side and server side), false otherwise.
`boolean`	`isOpening()` Return true if this Remote is being opened (client side open, waiting for server).
`int`	`processMessage(nxm.sys.lib.Message msg)` process message on remote command
`void`	`setHost(java.lang.String host)` Sets the host address of the connection.
`void`	`setHP(java.lang.String hostport)` set Host:Port syntax parser
`void`	`setID(java.lang.String newID)` Sets the ID of this remote and updates its entry in the registry (if applicable).
`void`	`setIsClient(boolean isClient)` Set if this Remote is a client instance, otherwise it is a server instance.
`void`	`setMaxQueue(int value)` Sets the default value for maximum number of packets on the RDP queue.
`void`	`setNext(java.lang.String value)` set slaved remote command
`void`	`setPort(int port)` Sets the port number used by this connection.
`void`	`setRetry(int value)` Sets the max number of retries for this Remote.
`void`	`setTimeLost(double time)` Set time before declaring a RDP packet lost (seconds) for this Remote.
`void`	`setTimeRetry(double value)` Sets time to retry (seconds) for this Remote.
`void`	`setWindow(int value)` Sets the max window size used for this remote.
`java.lang.String`	`toString()` brief description of command

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

- Field Detail
  - host
```
public java.lang.String host
```
  - rmif
```
public Rmif rmif
```
  - mh
```
public nxm.sys.inc.MessageHandler mh
```
  - next
```
public Rmif.Remote next
```
- Constructor Detail
  - Remote
```
public Remote()
```
    Generic constructor.
  - Remote
```
public Remote(Rmif rmif)
```
    Generic constructor that sets default values using Rmif instance.
    
    Parameters:
    
    rmif - comment here
- Method Detail
  - getID
```
public java.lang.String getID()
```
    local ID for remote command
    
    Specified by:
    
    getID in interface nxm.sys.inc.IDable
    
    Returns:
    
    The registry ID for the object as a String.
  - isOpen
```
@Deprecated
public boolean isOpen()
```
    Deprecated. Since NeXtMidas 2.5.0: Use isOpening() or isOpened(). This method is functionally identical to isOpening() even though its name implied that it was the same as isOpened().
    
    Returns:
    
    comment here
  - isOpened
```
public boolean isOpened()
```
    Return true if this Remote is open (client side and server side), false otherwise. This returns true when: (1) the client's socket is open, and (2) the client is registered with the server (i.e. in the server's list of remotes).
    
    Returns:
    
    comment here
    
    Since:
    
    NeXtMidas 2.5.0
  - isOpening
```
public boolean isOpening()
```
    Return true if this Remote is being opened (client side open, waiting for server). This returns true during the brief period between an OPEN message being sent to the server and an OPENED message being sent back. In most cases, you will want to use the isOpened() method rather than this one.
    
    Returns:
    
    comment here
    
    Since:
    
    NeXtMidas 2.5.0
  - isClosed
```
public boolean isClosed()
```
    Return true if this Remote is closed, false otherwise.
    
    Returns:
    
    comment here
  - setHP
```
public void setHP(java.lang.String hostport)
```
    set Host:Port syntax parser
    
    Parameters:
    
    hostport - comment here
  - setHost
```
public void setHost(java.lang.String host)
```
    Sets the host address of the connection. If the host name is given with a '/' in it, only the part before the '/' is used. Note that host names are always converted to lower case.
    
    Parameters:
    
    host - comment here
  - setPort
```
public void setPort(int port)
```
    Sets the port number used by this connection.
    
    Parameters:
    
    port - comment here
  - setIsClient
```
public void setIsClient(boolean isClient)
```
    Set if this Remote is a client instance, otherwise it is a server instance.
    
    Parameters:
    
    isClient - comment here
    
    Since:
    
    NeXtMidas 2.7.3
  - isClient
```
public boolean isClient()
```
    Get if this Remote is a client instance, otherwise it is a server instance.
    
    Returns:
    
    comment here
    
    Since:
    
    NeXtMidas 2.7.3
  - setID
```
public void setID(java.lang.String newID)
```
    Sets the ID of this remote and updates its entry in the registry (if applicable).
    
    Parameters:
    
    newID - comment here
  - setWindow
```
public void setWindow(int value)
```
    Sets the max window size used for this remote. Must be in the range 1..Rmif.MAX_WINDOW, default is 12.
    
    Parameters:
    
    value - comment here
  - setMaxQueue
```
public void setMaxQueue(int value)
```
    Sets the default value for maximum number of packets on the RDP queue. Must be in the range 0..N, default is 1024.
    
    Parameters:
    
    value - comment here
    
    Since:
    
    NeXtMidas 2.5.0
  - getHost
```
public java.lang.String getHost()
```
    Gets the host address of the connection.
    
    Returns:
    
    comment here
  - getPort
```
public int getPort()
```
    Gets the port number used by this connection.
    
    Returns:
    
    comment here
  - getState
```
public int getState()
```
    Gets the current link status as an int. See Rmif.functionList for a list of valid states. Use getStatus() to get the status as a string (for macro use).
    
    Returns:
    
    comment here
    
    Since:
    
    NeXtMidas 2.5.0
  - getStatus
```
public java.lang.String getStatus()
```
    Gets the current link status as a string. See Rmif.functionList for a list of valid states. Use getState() to get the status as an int (for library use).
    
    Returns:
    
    comment here
  - getAliveStatus
```
public java.lang.String getAliveStatus()
```
    Check to see of the connection is alive (checks for a timeout), returns "ON" or "OFF".
    
    Returns:
    
    comment here
  - getWindow
```
public int getWindow()
```
    Gets the max window size used. This is the maximum number of outstanding RDP packets allowed at any given time. See RMIF explain file for a discussion of how the window is used.
    
    Returns:
    
    comment here
  - getMaxQueue
```
public int getMaxQueue()
```
    Gets the default value for maximum number of packets on the RDP queue. This is the maximum number of RDP packets waiting to be sent (due to the window being full). See RMIF explain file for a discussion of how the queue is used.
    
    Returns:
    
    comment here
    
    Since:
    
    NeXtMidas 2.5.0
  - getRetry
```
public int getRetry()
```
    Gets the max number of retries for this Remote.
    
    Returns:
    
    comment here
  - setRetry
```
public void setRetry(int value)
```
    Sets the max number of retries for this Remote.
    
    Parameters:
    
    value - comment here
  - getRetried
```
public int getRetried()
```
  - getLatency
```
public double getLatency()
```
    Gets an estimate of link latency (in seconds).
    
    Returns:
    
    comment here
  - getSendSeq
```
public int getSendSeq()
```
    Gets the current send sequence number for RDP packets.
    
    Returns:
    
    comment here
  - getSendQueue
```
public int getSendQueue()
```
    Gets the number of queued RDP messages waiting to be sent.
    
    Returns:
    
    comment here
  - getDropped
```
public int getDropped()
```
    Gets the count of dropped RDP packets (sent to remote, but not received by remote).
    
    Returns:
    
    comment here
  - getRecvSeq
```
public int getRecvSeq()
```
    Gets the current recv sequence number for RDP packets. Jeff: looks like recvChk is the last received sequence number and recvSeq is just incremented and not used.
    
    Returns:
    
    comment here
  - getRecvQueue
```
public int getRecvQueue()
```
    Gets the number of RDP messages on the recvQueue. When a RDP packet is received out-of-order it is added to the recvQueue pending receipt of preceding packets. This ensures that packets are delivered to the message handler in their intended order.
    
    Returns:
    
    comment here
  - getLost
```
@Deprecated
public int getLost()
```
    Deprecated. Since NeXtMidas 2.5.0: Not used, always 0.
    
    Returns:
    
    comment here
  - getReOrdered
```
public int getReOrdered()
```
    Gets the total number of RDP packets received out-of-order for this Remote.
    
    Returns:
    
    comment here
  - setTimeLost
```
public void setTimeLost(double time)
```
    Set time before declaring a RDP packet lost (seconds) for this Remote.
    
    Parameters:
    
    time - comment here
  - getTimeLost
```
public double getTimeLost()
```
    Get time before declaring a RDP packet lost (seconds) for this Remote.
    
    Returns:
    
    comment here
  - getTimeRetry
```
public double getTimeRetry()
```
    Gets time to retry (seconds) for this Remote.
    
    Returns:
    
    comment here
  - setTimeRetry
```
public void setTimeRetry(double value)
```
    Sets time to retry (seconds) for this Remote.
    
    Parameters:
    
    value - comment here
  - getLinkBW
```
public double getLinkBW()
```
    Gets the estimated link bandwidth for this Remote.
    
    Returns:
    
    comment here
  - processMessage
```
public int processMessage(nxm.sys.lib.Message msg)
```
    process message on remote command
    
    Specified by:
    
    processMessage in interface nxm.sys.inc.MessageHandler
    
    Parameters:
    
    msg - The message.
    
    Returns:
    
    Commandable.NORMAL after processing the message or Commandable.NOOP if the message is not processed.
  - setNext
```
public void setNext(java.lang.String value)
```
    set slaved remote command
    
    Parameters:
    
    value - comment here
  - toString
```
public java.lang.String toString()
```
    brief description of command
    
    Overrides:
    
    toString in class java.lang.Object
  - getTag
```
public java.lang.String getTag()
```
    brief description of command
    
    Returns:
    
    comment here

Class Rmif.Remote

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

host

rmif

mh

next

Constructor Detail

Remote

Remote

Method Detail

getID

isOpen

isOpened

isOpening

isClosed

setHP

setHost

setPort

setIsClient

isClient

setID

setWindow

setMaxQueue

getHost

getPort

getState

getStatus

getAliveStatus

getWindow

getMaxQueue

getRetry

setRetry

getRetried

getLatency

getSendSeq

getSendQueue

getDropped

getRecvSeq

getRecvQueue

getLost

getReOrdered

setTimeLost

getTimeLost

getTimeRetry

setTimeRetry

getLinkBW

processMessage

setNext

toString

getTag