Rmif

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

public class Rmif
extends java.lang.Object

Access point for all RMIF communications into and out of this Java process. Each instance of this class contains a set of Remote objects that serve as connection points to remote nodes. RMIF packets are sent and received through this class to and from the remote nodes. When an instance of this class is instantiated, it opens a single UDP socket on the local machine and begins listening for PDUs on that socket.

Each datagram that is received on that socket is interpreted as an RMIF packet. Each packet contains an opcode (instruction) along with parameters for that instruction. These opcodes are converted into Messages and delivered to the listening processes.

The following is the layout of an RMIF packet:

                  0                          31
                  +------+------+------+------+  ---
                  | func | flag | info | rep  |   |
                  +------+------+------+------+   | Main Header (8 bytes)
                  | seq  | try  | rpt  | adj  |   |
                  +------+------+------+------+  ---
                  |                           |   |
                  :       adjunct header      :   | Adjunct Header
                  |         (optional)        |   | (max of 127 bytes)
                  +---------------------------+  ---
                  |                           |   |
                  :            data           :   | Data
                  |                           |   | (max of 32 KiB bytes)
                  +---------------------------+  ---

        Main Header:
          byte func - Function opcode (see list below).
          byte flag - Format flag (see below).
          byte info - Info field (used for link test).
          byte rep  - Numeric representation, byte order ('I'=IEEE, 'E'=EEEI).
          byte seq  - Sequence number for RDP (0-127). Sequence numbers less
                      than 0 indicate protocol (other than RDP), times -1:
                        -1*UDP = -1
                        -1*TCP = -2 (future support)
                        -1*IDP = -3 (future support)
          byte try  - Number of retries (initially 0).
          byte rpt  - Packet report (reserved for future use, always 0).
          byte adj  - Bytes in adjunct header (0-127). Values less than 0 (i.e.
                      -1 to -128) should not be used and are reserved.

        Format Flag (clarification added in NeXtMidas 2.3.0):
          Lower 4 bits indicate data type (these are mutually exclusive):
              TYPE_RAW    = 0  - Raw data (type unknown / not set).
              TYPE_BINARY = 1  - Data is binary.
              TYPE_XML    = 2  - Data is XML.
              TYPE_ASCII  = 3  - Data is ASCII.
              [Types 4-15 are reserved for future use]

          Upper 4 bits indicate fields in the adjunct header:
            This specifies the first N 8-byte values in the adjunct header
            using a bit mask. If multiple fields are included in the bit
            mask they appear in the adjunct header increasing order (e.g.
            ADJ_TIME comes before ADJ_OFFSET). Any remaining space in the
            adjunct header (adj-N*8 bytes) is user-specific:
                ADJ_TIME   = 0x10  - TimeStamp  (double)
                ADJ_OFFSET = 0x20  - FileOffset (double)
                [reserved] = 0x40  - [reserved for future use]
                ADJ_USER   = 0x80  - UserType   (char[8])
            It is common for user-defined adjuncts to be immediately preceded
            by an UserType specifier which is an 8-byte Fortran string (padded
            with spaces) indicating the type of user data. The UserType string
            is user-defined, except names beginning with "NXM" or "XM" are
            reserved.

        Adjunct Header:
          byte[n]   - Any adjunct fields, often used for time code
                      or offset information. (See note about format
                      flag.)
        Data:
          byte[n]   - Remainder of packet, the included data.


        Function                    Purpose
        -----------------------------------------------------------------
        SET=101,     GET=102,       For results/message/parameter access.
        RET=103,     ACK=104,       For results/message/parameter access.
        OPEN=105,    CLOSE=106,     Open/close channel.
        SEND=107,    RECV=108,      Message access.
        PING=109,    PONG=110,      Keep alive checks.
        DHDR=111,    DBUF=112,      File data access.
        ADDR=113,    MODIFY=114,    Address, modify.
        OPENED=115,  CLOSED=116,    Response to OPEN,CLOSE.
        DBUFC=117,   DBUFD=118,     File data buffer, Compressed Direct.
        DBUFZ=119,   DBUFX=120,     File data buffer, Zipped eXtended.
        GETPROP=121, RETPROP=122,   Published keyname access.
        RECEIPT=123, LINKTEST=124,  Low-level RDP hooks.
        MFTP=125,                   Midas File Transfer Protocol command.
        DROPPED=0;                  Dropped remote state.

Author:: Jeff Schoen / J. Czechowski IV / Neon Ngo
See Also:: rmif

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`Rmif.Channel` channel from client to served property on Remote
`class`	`Rmif.FilePropertyMember` File Property Structure
`class`	`Rmif.Packet` Packet to serve to clients (for sending or receiving).
`class`	`Rmif.PipePropertyMember` Pipe Property Structure
`class`	`Rmif.Property` property to serve to clients
`class`	`Rmif.Remote` local reference to remote process
`class`	`Rmif.RemoteAddress` A remote address.

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`ACK` Packet message functions (see `Rmif` for details).
`static byte`	`ADDR` Packet message functions (see `Rmif` for details).
`static byte`	`ADJ` Packet header byte offsets (see `Rmif` for details).
`static byte`	`ADJ_OFFSET` Adjunct header type flag (see `Rmif` for details).
`static byte`	`ADJ_TIME` Adjunct header type flag (see `Rmif` for details).
`static byte`	`ADJ_USER` Adjunct header type flag (see `Rmif` for details).
`nxm.sys.lib.KeyVector`	`channels` Deprecated. Since NeXtMidas 2.5.0: Use `getChannels()`.
`static byte`	`CLOSE` Packet message functions (see `Rmif` for details).
`static byte`	`CLOSED` Packet message functions (see `Rmif` for details).
`static byte`	`DATA` Packet header byte offsets (see `Rmif` for details).
`static byte`	`DBUF` Packet message functions (see `Rmif` for details).
`static byte`	`DBUFC` Packet message functions (see `Rmif` for details).
`static byte`	`DBUFD` Packet message functions (see `Rmif` for details).
`static byte`	`DBUFX` Packet message functions (see `Rmif` for details).
`static byte`	`DBUFZ` Packet message functions (see `Rmif` for details).
`static byte`	`DC_BAND` packet DBUF compression modes
`static byte`	`DC_CONST` packet DBUF compression modes
`static byte`	`DC_PACK` packet DBUF compression modes
`static byte`	`DC_RAW` packet DBUF compression modes
`static byte`	`DHDR` Packet message functions (see `Rmif` for details).
`static byte`	`DROPPED` Packet message functions (see `Rmif` for details).
`static byte`	`FILE` property types (see `typeList`)
`static byte`	`FLAG` Packet header byte offsets (see `Rmif` for details).
`static byte`	`FUNC` Packet header byte offsets (see `Rmif` for details).
`static java.lang.String[]`	`functionList` Array of strings for the different function types (see `Rmif` for details).
`static byte`	`GET` Packet message functions (see `Rmif` for details).
`static byte`	`GETPROP` Packet message functions (see `Rmif` for details).
`static byte`	`IDP` Packet transport layer reliability modes (see `Rmif` for details).
`static byte`	`INFO` Packet header byte offsets (see `Rmif` for details).
`static byte`	`KEY` property types (see `typeList`)
`static byte`	`LINKTEST` Packet message functions (see `Rmif` for details).
`static int`	`MAX_WINDOW` Max number of outstanding RDP packets per Remote
`static int`	`MAXFUNCTION` The index of the highest numbered function.
`static byte`	`MESSAGE` property types (see `typeList`)
`static byte`	`MFTP` Packet message functions (see `Rmif` for details).
`static int`	`MINFUNCTION` The index of the lowest numbered function.
`static byte`	`MODIFY` Packet message functions (see `Rmif` for details).
`static int`	`MULTI` channel flags types
`int`	`nchannel` Deprecated. Since NeXtMidas 2.5.0: Use `getChannels().getSize()`.
`int`	`nproperty` Deprecated. Since NeXtMidas 2.5.0: Use `getProperties().getSize()`.
`static byte`	`OPEN` Packet message functions (see `Rmif` for details).
`static byte`	`OPENED` Packet message functions (see `Rmif` for details).
`static byte`	`PING` Packet message functions (see `Rmif` for details).
`static byte`	`PIPE` property types (see `typeList`)
`static byte`	`PONG` Packet message functions (see `Rmif` for details).
`nxm.sys.lib.KeyVector`	`properties` Deprecated. Since NeXtMidas 2.5.0: Use `getProperties()`.
`static java.lang.String`	`protocolList` List of packet transport protocols (starts at 0, not 1)
`static byte`	`RDP` Packet transport layer reliability modes (see `Rmif` for details).
`static byte`	`RECEIPT` Packet message functions (see `Rmif` for details).
`static byte`	`RECV` Packet message functions (see `Rmif` for details).
`nxm.sys.lib.KeyVector`	`remotes` Deprecated. Since NeXtMidas 2.5.0: Use `getRemotes()`.
`static byte`	`REP` Packet header byte offsets (see `Rmif` for details).
`static byte`	`RESULT` property types (see `typeList`)
`static byte`	`RET` Packet message functions (see `Rmif` for details).
`static byte`	`RETPROP` Packet message functions (see `Rmif` for details).
`static byte`	`RPT` Packet header byte offsets (see `Rmif` for details).
`static byte`	`SEND` Packet message functions (see `Rmif` for details).
`static byte`	`SEQ` Packet header byte offsets (see `Rmif` for details).
`static byte`	`SET` Packet message functions (see `Rmif` for details).
`static byte`	`TCP` Packet transport layer reliability modes (see `Rmif` for details).
`static byte`	`TRY` Packet header byte offsets (see `Rmif` for details).
`static byte`	`TYPE_ASCII` Data type indicator (see `Rmif` for details).
`static byte`	`TYPE_BINARY` Data type indicator (see `Rmif` for details).
`static byte`	`TYPE_RAW` Data type indicator (see `Rmif` for details).
`static byte`	`TYPE_XML` Data type indicator (see `Rmif` for details).
`static java.lang.String`	`typeList` Property types: `"Pipe,Result,Key,Message,File"`
`static byte`	`UDP` Packet transport layer reliability modes (see `Rmif` for details).

Constructor Summary

Constructors
Constructor and Description
`Rmif(nxm.sys.inc.MessageHandler handler)` Create without an owner or Midas.
`Rmif(nxm.sys.lib.Midas M, nxm.sys.inc.MessageHandler owner, nxm.sys.inc.MessageHandler handler)` Create an Rmif.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addChannel(Rmif.Remote r, int ic, java.lang.String name)` Adds a channel.
`void`	`addChannel(Rmif.Remote r, int ic, java.lang.String name, int flags)` Adds a channel to a Remote.
`void`	`addProperty(java.lang.String name)` Adds a property.
`Rmif.Remote`	`addRemote(nxm.sys.lib.Table targs)` Adds a new remote.
`int`	`checkRemotes()` check the remote link for RDP book-keeping
`void`	`close()` Close remotes, close sockets, disconnect.
`void`	`closeChannel(int ic)` Closes a channel.
`void`	`closeChannel(java.lang.String name)` Closes a channel.
`void`	`closeRemote(Rmif.Remote r)` Close the given remote, removing it from the context registry in the process.
`void`	`delProperty(int ip)` Deletes a property.
`static java.lang.String`	`functionName(byte func)` Converts from function ID to name (see `functionList`).
`boolean`	`getCaseSensitive()` Keep tables keys case sensitive.
`Rmif.Channel`	`getChannel(int i)` Return the channel at the given integer index from the set of channels
`nxm.sys.lib.KeyVector`	`getChannels()` return the KeyVector of channels
`boolean`	`getDebug()` Indicates if internal debug is enabled.
`double`	`getLinkBW()` return total link bandwidth since last poll in bytes/sec
`int`	`getLinkLatency()` return average link latency in milliseconds
`nxm.sys.lib.TextFile`	`getLogFile()` Get the log file in use.
`int`	`getMaxErrorsToNotServeProperty()` Get maximum number of errors when serving a property (pipe,result, etc.) to client before removing it to prevent flood of errors on server side.
`int`	`getMaxQueue()` Gets the default maximum number of packets on the RDP queue used by new remote connections.
`nxm.sys.inc.MessageHandler`	`getMessageHandler()` Get the current message handler for messages received from remotes.
`int`	`getPort()` Return the local port that the instance is connected to (returns -1 if not connected).
`nxm.sys.lib.KeyVector`	`getProperties()` return the KeyVector of properties
`Rmif.Property`	`getProperty(int i)` Return the property at the given integer index from the set of properties
`Rmif.Property`	`getProperty(java.lang.String name)` Return the property by name
`Rmif.Remote`	`getRemote(int i)` Return the remote at the given integer index from the set of remotes
`Rmif.Remote`	`getRemote(java.lang.Object obj)` Converts the given object to a remote.
`Rmif.Remote`	`getRemote(nxm.sys.lib.Table targs)` Get a remote based on the ID in a table
`Rmif.Remote`	`getRemoteForAddress(Rmif.RemoteAddress ra)` get temporary Remote for writing to an unOpened Remote
`nxm.sys.lib.KeyVector`	`getRemotes()` return the KeyVector of remotes
`boolean`	`getReOpen()` Indicates if automatic reopen of connections is enabled.
`boolean`	`getRequireOpen()` Get if requiring unknown remote to first OPEN a connection to this RMIF otherwise, unsolicited packets will be ignored and a QUIET CLOSE packet may be sent back.
`int`	`getRetry()` Gets the default value for the max retries for RDP packets.
`java.lang.String`	`getTag()` brief description of command
`double`	`getTimeCloseOut()` Get the time to wait for remote connections to close (in seconds).
`double`	`getTimeLost()` Get default time before declaring a RDP packet lost (seconds) for new Remote(s).
`double`	`getTimeOut()` Get the socket timeout in seconds.
`double`	`getTimePing()` Get the time between pings (in seconds).
`boolean`	`getVerbose()` Indicates if verbose output is enabled.
`int`	`getWindow()` Gets the default max window size used by new remote connections.
`void`	`hardKillForTestingOnly()` DO NOT call this method.
`void`	`open(int port, int prange)` Create and set up the DatagramSocket, allocate buffers and start read/write threads.
`void`	`open(java.lang.String host, int port, int prange)` Create and set up the DatagramSocket, allocate buffers and start read/write threads.
`Rmif.Remote`	`openRemote(nxm.sys.lib.Table args)` Adds a new remote and opens it.
`static java.lang.String`	`propTypeName(int type)` Converts property type ID to string (see `typeList`).
`static java.lang.String`	`protocolName(int protocol)` Converts from protocol ID to name.
`static java.lang.String`	`protocolNameForSeq(int seq)` Converts from packet sequence number to protocol name (see `Rmif` for details).
`void`	`removeRemote(Rmif.Remote r)` Closes the given remote and removes it from the set of remotes.
`void`	`removeRemote(nxm.sys.lib.Table targs)` Closes the given remote and removes it from the set of remotes.
`void`	`sendPacket(byte func, int info, byte[] buffer, int boff, int bytes, Rmif.Remote r, int flags, double adjval)` Send an RMIF message packet with the given fields through the specified remote.
`void`	`sendPacket(byte func, int info, byte[] bytes, Rmif.Remote r, int flags)` Send an RMIF message packet with the given fields through the specified remote.
`void`	`sendPacket(byte func, int info, Rmif.Remote r, int flags)` Send an RMIF message packet with the given fields through the specified remote.
`int`	`sendPacketRaw(byte[] buf, int off, int len, java.net.InetAddress addr, int port)` Send raw byte data to a destination.
`int`	`serveFileProperty(Rmif.Property p)` Deprecated. Since NeXtMidas 2.5.0: Internal use only; use `serveProperties()`.
`void`	`servePacket(byte func, int info, byte[] bytes, int flags)` Serves a packet.
`int`	`servePipeProperty(Rmif.Property p)` Deprecated. Since NeXtMidas 2.5.0: Internal use only; use `serveProperties()`.
`int`	`serveProperties()` serve all properties loop
`int`	`serveResultProperty(Rmif.Property p)` Deprecated. Since NeXtMidas 2.5.0: Internal use only; use `serveProperties()`.
`void`	`setCaseSensitive(boolean cs)` Keep tables keys case sensitive.
`void`	`setDebug(boolean debug)` Enable/disable internal debug.
`void`	`setLogFile(nxm.sys.lib.TextFile logfile)` Set the log file to use.
`void`	`setMaxErrorsToNotServeProperty(int newValue)` Set maximum number of errors when serving a property (pipe,result, etc.) to client before removing it to prevent flood of errors on server side.
`void`	`setMaxQueue(int value)` Sets the default value for maximum number of packets on the RDP queue.
`nxm.sys.inc.MessageHandler`	`setMessageHandler(nxm.sys.inc.MessageHandler mh)` Set the message handler for messages received from remotes.
`void`	`setReOpen(boolean reOpen)` Enable/disable automatic reopen of connections.
`void`	`setRequireOpen(boolean val)` Set to true to require unknown remote to first OPEN a connection to this RMIF otherwise, unsolicited packets will be ignored and a QUIET CLOSE packet may be sent back.
`void`	`setRetry(int value)` Sets the default value for the max retries for RDP packets.
`void`	`setTimeCloseOut(double time)` Set the time to wait for remote connections to close (in seconds).
`void`	`setTimeDrop(double time)` Set the time before dropping a connection (in seconds).
`void`	`setTimeLost(double time)` Set default time before declaring a RDP packet lost (seconds) for new Remote(s).
`void`	`setTimeOut(double time)` Set the socket timeout in seconds.
`void`	`setTimeOutR(double time)` Deprecated. Since NeXtMidas 2.5.0: This is not used.
`void`	`setTimePing(double time)` Set the time between pings (in seconds).
`void`	`setVerbose(boolean verbose)` Enable/disable verbose output.
`void`	`setWindow(int value)` Sets the default value for the max window size used.
`void`	`testLink(Rmif.Remote r, int mode)` Tests the UDP connection between this system and the given remote.
`void`	`testLinkReport(Rmif.Remote r, int len, byte[] buf, int off)` Deprecated. Since NeXtMidas 2.5.0: Internal use only; use `testLink(Rmif.Remote,int)`.

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

- Field Detail
  - SET
```
public static final byte SET
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - GET
```
public static final byte GET
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - RET
```
public static final byte RET
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - ACK
```
public static final byte ACK
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - OPEN
```
public static final byte OPEN
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - CLOSE
```
public static final byte CLOSE
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - SEND
```
public static final byte SEND
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - RECV
```
public static final byte RECV
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - PING
```
public static final byte PING
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - PONG
```
public static final byte PONG
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - DHDR
```
public static final byte DHDR
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - DBUF
```
public static final byte DBUF
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - ADDR
```
public static final byte ADDR
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - MODIFY
```
public static final byte MODIFY
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - OPENED
```
public static final byte OPENED
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - CLOSED
```
public static final byte CLOSED
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - DBUFC
```
public static final byte DBUFC
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - DBUFD
```
public static final byte DBUFD
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - DBUFZ
```
public static final byte DBUFZ
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - DBUFX
```
public static final byte DBUFX
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - GETPROP
```
public static final byte GETPROP
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - RETPROP
```
public static final byte RETPROP
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - RECEIPT
```
public static final byte RECEIPT
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - LINKTEST
```
public static final byte LINKTEST
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - MFTP
```
public static final byte MFTP
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - DROPPED
```
public static final byte DROPPED
```
    Packet message functions (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - functionList
```
public static java.lang.String[] functionList
```
    Array of strings for the different function types (see Rmif for details).
  - MINFUNCTION
```
public static final int MINFUNCTION
```
    The index of the lowest numbered function.
    
    See Also:
    
    Constant Field Values
  - MAXFUNCTION
```
public static final int MAXFUNCTION
```
    The index of the highest numbered function.
  - FUNC
```
public static final byte FUNC
```
    Packet header byte offsets (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - FLAG
```
public static final byte FLAG
```
    Packet header byte offsets (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - INFO
```
public static final byte INFO
```
    Packet header byte offsets (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - REP
```
public static final byte REP
```
    Packet header byte offsets (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - SEQ
```
public static final byte SEQ
```
    Packet header byte offsets (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - TRY
```
public static final byte TRY
```
    Packet header byte offsets (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - RPT
```
public static final byte RPT
```
    Packet header byte offsets (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - ADJ
```
public static final byte ADJ
```
    Packet header byte offsets (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - DATA
```
public static final byte DATA
```
    Packet header byte offsets (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - RDP
```
public static final byte RDP
```
    Packet transport layer reliability modes (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - UDP
```
public static final byte UDP
```
    Packet transport layer reliability modes (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - TCP
```
public static final byte TCP
```
    Packet transport layer reliability modes (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - IDP
```
public static final byte IDP
```
    Packet transport layer reliability modes (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - protocolList
```
public static final java.lang.String protocolList
```
    List of packet transport protocols (starts at 0, not 1)
    
    See Also:
    
    Constant Field Values
  - TYPE_RAW
```
public static final byte TYPE_RAW
```
    Data type indicator (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - TYPE_BINARY
```
public static final byte TYPE_BINARY
```
    Data type indicator (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - TYPE_XML
```
public static final byte TYPE_XML
```
    Data type indicator (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - TYPE_ASCII
```
public static final byte TYPE_ASCII
```
    Data type indicator (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - ADJ_TIME
```
public static final byte ADJ_TIME
```
    Adjunct header type flag (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - ADJ_OFFSET
```
public static final byte ADJ_OFFSET
```
    Adjunct header type flag (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - ADJ_USER
```
public static final byte ADJ_USER
```
    Adjunct header type flag (see Rmif for details).
    
    See Also:
    
    Constant Field Values
  - PIPE
```
public static final byte PIPE
```
    property types (see typeList)
    
    See Also:
    
    Constant Field Values
  - RESULT
```
public static final byte RESULT
```
    property types (see typeList)
    
    See Also:
    
    Constant Field Values
  - KEY
```
public static final byte KEY
```
    property types (see typeList)
    
    See Also:
    
    Constant Field Values
  - MESSAGE
```
public static final byte MESSAGE
```
    property types (see typeList)
    
    See Also:
    
    Constant Field Values
  - FILE
```
public static final byte FILE
```
    property types (see typeList)
    
    See Also:
    
    Constant Field Values
  - typeList
```
public static final java.lang.String typeList
```
    Property types: "Pipe,Result,Key,Message,File"
    
    See Also:
    
    Constant Field Values
  - DC_RAW
```
public static final byte DC_RAW
```
    packet DBUF compression modes
    
    See Also:
    
    Constant Field Values
  - DC_BAND
```
public static final byte DC_BAND
```
    packet DBUF compression modes
    
    See Also:
    
    Constant Field Values
  - DC_CONST
```
public static final byte DC_CONST
```
    packet DBUF compression modes
    
    See Also:
    
    Constant Field Values
  - DC_PACK
```
public static final byte DC_PACK
```
    packet DBUF compression modes
    
    See Also:
    
    Constant Field Values
  - MULTI
```
public static final int MULTI
```
    channel flags types
    
    See Also:
    
    Constant Field Values
  - MAX_WINDOW
```
public static final int MAX_WINDOW
```
    Max number of outstanding RDP packets per Remote
    
    See Also:
    
    Constant Field Values
  - nchannel
```
@Deprecated
public int nchannel
```
    Deprecated. Since NeXtMidas 2.5.0: Use getChannels().getSize().
  - nproperty
```
@Deprecated
public int nproperty
```
    Deprecated. Since NeXtMidas 2.5.0: Use getProperties().getSize().
  - remotes
```
@Deprecated
public nxm.sys.lib.KeyVector remotes
```
    Deprecated. Since NeXtMidas 2.5.0: Use getRemotes().
  - properties
```
@Deprecated
public nxm.sys.lib.KeyVector properties
```
    Deprecated. Since NeXtMidas 2.5.0: Use getProperties().
  - channels
```
@Deprecated
public nxm.sys.lib.KeyVector channels
```
    Deprecated. Since NeXtMidas 2.5.0: Use getChannels().
- Constructor Detail
  - Rmif
```
public Rmif(nxm.sys.inc.MessageHandler handler)
```
    Create without an owner or Midas. This constructor is used when RMIF is loaded as a stand-alone library.
    
    Parameters:
    
    handler - The Message Handler (for messages received from remotes).
  - Rmif
```
public Rmif(nxm.sys.lib.Midas M,
            nxm.sys.inc.MessageHandler owner,
            nxm.sys.inc.MessageHandler handler)
```
    Create an Rmif. This constructor is used by the RMIF primitive.
    
    Parameters:
    
    M - Midas reference, created if null.
    
    owner - Used as the reference (and for status messages).
    
    handler - The Message Handler (for messages received from remotes).
- Method Detail
  - open
```
public void open(java.lang.String host,
                 int port,
                 int prange)
```
    Create and set up the DatagramSocket, allocate buffers and start read/write threads.
    
    Parameters:
    
    host - Socket host to bind on (if host == "" then use the wildcard address (0.0.0.0), an IP address chosen by the kernel).
    
    port - Socket port (port < 0: use any local port).
    
    prange - The port range to try.
    
    Since:
    
    NeXtMidas 3.1.2
  - open
```
public void open(int port,
                 int prange)
```
    Create and set up the DatagramSocket, allocate buffers and start read/write threads.
    
    Parameters:
    
    port - Socket port (port < 0: use any local port).
    
    prange - The port range to try.
  - close
```
public void close()
```
    Close remotes, close sockets, disconnect.
  - hardKillForTestingOnly
```
public void hardKillForTestingOnly()
```
    DO NOT call this method. It is for testing only. Closes socket and reader thread so to simulate a dead RMIF.
    
    Since:
    
    NeXtMidas 2.7.3
  - setLogFile
```
public void setLogFile(nxm.sys.lib.TextFile logfile)
```
    Set the log file to use.
    
    Parameters:
    
    logfile - comment here
  - getLogFile
```
public nxm.sys.lib.TextFile getLogFile()
```
    Get the log file in use.
    
    Returns:
    
    comment here
  - setVerbose
```
public void setVerbose(boolean verbose)
```
    Enable/disable verbose output.
    
    Parameters:
    
    verbose - comment here
  - getVerbose
```
public boolean getVerbose()
```
    Indicates if verbose output is enabled.
    
    Returns:
    
    comment here
  - setDebug
```
public void setDebug(boolean debug)
```
    Enable/disable internal debug.
    
    Parameters:
    
    debug - comment here
  - getDebug
```
public boolean getDebug()
```
    Indicates if internal debug is enabled.
    
    Returns:
    
    comment here
  - setReOpen
```
public void setReOpen(boolean reOpen)
```
    Enable/disable automatic reopen of connections.
    
    Parameters:
    
    reOpen - comment here
  - getReOpen
```
public boolean getReOpen()
```
    Indicates if automatic reopen of connections is enabled.
    
    Returns:
    
    comment here
  - setRequireOpen
```
public void setRequireOpen(boolean val)
```
    Set to true to require unknown remote to first OPEN a connection to this RMIF otherwise, unsolicited packets will be ignored and a QUIET CLOSE packet may be sent back. This feature is here to resolve users's with crosstalk issues as described in BUG 1548.
    
    Parameters:
    
    val - set to true to prevent crosstalk issue, false (default) to allow packets from unknown remote's to get forwarded to the upper level (i.e. the macro).
    
    Since:
    
    NeXtMidas 2.8.1
  - getRequireOpen
```
public boolean getRequireOpen()
```
    Get if requiring unknown remote to first OPEN a connection to this RMIF otherwise, unsolicited packets will be ignored and a QUIET CLOSE packet may be sent back. This feature is here to resolve users's with crosstalk issues as described in BUG 1548.
    
    Returns:
    
    comment here
    
    Since:
    
    NeXtMidas 2.8.1
  - setTimeOut
```
public void setTimeOut(double time)
```
    Set the socket timeout in seconds.
    
    Parameters:
    
    time - comment here
  - getTimeOut
```
public double getTimeOut()
```
    Get the socket timeout in seconds.
    
    Returns:
    
    comment here
  - setTimeLost
```
public void setTimeLost(double time)
```
    Set default time before declaring a RDP packet lost (seconds) for new Remote(s).
    
    Parameters:
    
    time - comment here
  - getTimeLost
```
public double getTimeLost()
```
    Get default time before declaring a RDP packet lost (seconds) for new Remote(s).
    
    Returns:
    
    comment here
  - setTimeOutR
```
@Deprecated
public void setTimeOutR(double time)
```
    Deprecated. Since NeXtMidas 2.5.0: This is not used.
    
    Parameters:
    
    time - comment here
  - setTimeCloseOut
```
public void setTimeCloseOut(double time)
```
    Set the time to wait for remote connections to close (in seconds).
    
    Parameters:
    
    time - comment here
  - getTimeCloseOut
```
public double getTimeCloseOut()
```
    Get the time to wait for remote connections to close (in seconds).
    
    Returns:
    
    comment here
  - setTimeDrop
```
public void setTimeDrop(double time)
```
    Set the time before dropping a connection (in seconds). TBD
    
    Parameters:
    
    time - comment here
  - setTimePing
```
public void setTimePing(double time)
```
    Set the time between pings (in seconds).
    
    Parameters:
    
    time - comment here
  - getTimePing
```
public double getTimePing()
```
    Get the time between pings (in seconds).
    
    Returns:
    
    comment here
  - setRetry
```
public void setRetry(int value)
```
    Sets the default value for the max retries for RDP packets. New remote connections will be initialized with this value.
    
    Parameters:
    
    value - comment here
    
    See Also:
    
    Rmif.Remote.setRetry(int)
  - getRetry
```
public int getRetry()
```
    Gets the default value for the max retries for RDP packets. New remote connections will be initialized with this value.
    
    Returns:
    
    comment here
    
    See Also:
    
    Rmif.Remote.getRetry()
  - getCaseSensitive
```
public boolean getCaseSensitive()
```
    Keep tables keys case sensitive.
    
    Returns:
    
    comment here
    
    Since:
    
    NeXtMidas 2.5.0
  - setCaseSensitive
```
public void setCaseSensitive(boolean cs)
```
    Keep tables keys case sensitive. (You probably do not want this!!!)
    
    Parameters:
    
    cs - comment here
    
    Since:
    
    NeXtMidas 2.5.0
  - setWindow
```
public void setWindow(int value)
```
    Sets the default value for the max window size used. Must be in the range 1..MAX_WINDOW default is 12. New remote connections will be initialized with this value.
    
    Parameters:
    
    value - comment here
    
    See Also:
    
    Rmif.Remote.setWindow(int)
  - getWindow
```
public int getWindow()
```
    Gets the default max window size used by new remote connections.
    
    Returns:
    
    comment here
    
    Since:
    
    NeXtMidas 2.5.0
    
    See Also:
    
    Rmif.Remote.getWindow()
  - 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. New remote connections will be initialized with this value.
    
    Parameters:
    
    value - comment here
    
    Since:
    
    NeXtMidas 2.5.0
    
    See Also:
    
    Rmif.Remote.setMaxQueue(int)
  - getMaxQueue
```
public int getMaxQueue()
```
    Gets the default maximum number of packets on the RDP queue used by new remote connections.
    
    Returns:
    
    comment here
    
    Since:
    
    NeXtMidas 2.5.0
    
    See Also:
    
    Rmif.Remote.getMaxQueue()
  - getRemotes
```
public nxm.sys.lib.KeyVector getRemotes()
```
    return the KeyVector of remotes
    
    Returns:
    
    comment here
  - getRemote
```
public Rmif.Remote getRemote(int i)
```
    Return the remote at the given integer index from the set of remotes
    
    Parameters:
    
    i - comment here
    
    Returns:
    
    comment here
  - getProperties
```
public nxm.sys.lib.KeyVector getProperties()
```
    return the KeyVector of properties
    
    Returns:
    
    comment here
  - getProperty
```
public Rmif.Property getProperty(int i)
```
    Return the property at the given integer index from the set of properties
    
    Parameters:
    
    i - comment here
    
    Returns:
    
    comment here
  - getProperty
```
public Rmif.Property getProperty(java.lang.String name)
```
    Return the property by name
    
    Parameters:
    
    name - comment here
    
    Returns:
    
    comment here
  - getChannels
```
public nxm.sys.lib.KeyVector getChannels()
```
    return the KeyVector of channels
    
    Returns:
    
    comment here
  - getChannel
```
public Rmif.Channel getChannel(int i)
```
    Return the channel at the given integer index from the set of channels
    
    Parameters:
    
    i - comment here
    
    Returns:
    
    comment here
  - getPort
```
public int getPort()
```
    Return the local port that the instance is connected to (returns -1 if not connected).
    
    Returns:
    
    comment here
  - testLink
```
public void testLink(Rmif.Remote r,
                     int mode)
```
    Tests the UDP connection between this system and the given remote.
```
        mode =  0   - Test sending and receiving (same as testLink(r,8); testLink(r,-8);
                      testLink(r,1024); testLink(r,-1024);)
        mode = -N   - Test receiving with a packet that is 2^N bytes long.
        mode =  N   - Test sending with a packet that is 2^N bytes long.
      
```
    Parameters:
    
    r - The remote to test.
    
    mode - The test mode.
  - testLinkReport
```
@Deprecated
public void testLinkReport(Rmif.Remote r,
                                       int len,
                                       byte[] buf,
                                       int off)
```
    Deprecated. Since NeXtMidas 2.5.0: Internal use only; use testLink(Rmif.Remote,int).
    
    Parameters:
    
    r - comment here
    
    len - comment here
    
    buf - comment here
    
    off - comment here
  - getRemoteForAddress
```
public Rmif.Remote getRemoteForAddress(Rmif.RemoteAddress ra)
```
    get temporary Remote for writing to an unOpened Remote
    
    Parameters:
    
    ra - comment here
    
    Returns:
    
    comment here
  - sendPacket
```
public void sendPacket(byte func,
                       int info,
                       byte[] buffer,
                       int boff,
                       int bytes,
                       Rmif.Remote r,
                       int flags,
                       double adjval)
```
    Send an RMIF message packet with the given fields through the specified remote. A new packet is constructed using the parameter values and is sent to the remote listener through the Remote. If the flag parameter is set to RDP then the packet will be sent using the reliable mechanism.
    
    Parameters:
    
    func - The function value to send.
    
    info - The info value to send.
    
    buffer - The data to send.
    
    boff - The byte offset in buffer where data starts.
    
    bytes - The number of bytes to send.
    
    r - The remote containing the connection parameters to send to.
    
    flags - Controls how the data is to be sent.
    
    adjval - comment here
  - sendPacket
```
public void sendPacket(byte func,
                       int info,
                       byte[] bytes,
                       Rmif.Remote r,
                       int flags)
```
    Send an RMIF message packet with the given fields through the specified remote. If bytes==null, this is the same as sendPacket(func,info,null,0,0,r,flags,0.0); otherwise it matches sendPacket(func,info,bytes,0,bytes.length,r,flags,0.0).
    
    Parameters:
    
    func - The function value to send.
    
    info - The info value to send.
    
    bytes - The data to send.
    
    r - The remote containing the connection parameters to send to.
    
    flags - Controls how the data is to be sent.
  - sendPacket
```
public void sendPacket(byte func,
                       int info,
                       Rmif.Remote r,
                       int flags)
```
    Send an RMIF message packet with the given fields through the specified remote. This is the same as sendPacket(func,info,null,0,0,r,flags,0.0)
    
    Parameters:
    
    func - The function value to send.
    
    info - The info value to send.
    
    r - The remote containing the connection parameters to send to.
    
    flags - Controls how the data is to be sent.
  - sendPacketRaw
```
public int sendPacketRaw(byte[] buf,
                         int off,
                         int len,
                         java.net.InetAddress addr,
                         int port)
```
    Send raw byte data to a destination. The data is the len bytes from the buf parameter starting at the given offset. The destination is determined by the remote parameter.
    
    Parameters:
    
    buf - The buffer containing the data to send.
    
    off - The offset into the buffer of the data start.
    
    len - The number of bytes to send.
    
    addr - The remote address to send the data through.
    
    port - The remote port to send the data through.
    
    Returns:
    
    comment here
  - checkRemotes
```
public int checkRemotes()
```
    check the remote link for RDP book-keeping
    
    Returns:
    
    comment here
  - getLinkBW
```
public double getLinkBW()
```
    return total link bandwidth since last poll in bytes/sec
    
    Returns:
    
    comment here
  - getLinkLatency
```
public int getLinkLatency()
```
    return average link latency in milliseconds
    
    Returns:
    
    comment here
  - addProperty
```
public void addProperty(java.lang.String name)
```
    Adds a property. The following syntax is allowed for the name:
```
        _pipe               Data pipe (same name on client/server)
        _local=_remote      Data pipe (different name on client/server)
       {_local=_remote}     Data pipe (alternate syntax)
        Q:<name>            Message Queue
        F:<name>            File (MFTP)
        <name>              Result
      
```
    Parameters:
    
    name - comment here
    
    See Also:
    
    delProperty(int)
  - delProperty
```
public void delProperty(int ip)
```
    Deletes a property.
    
    Parameters:
    
    ip - Property index in the KeyVector (see getProperties()).
    
    See Also:
    
    addProperty(String)
  - addRemote
```
public Rmif.Remote addRemote(nxm.sys.lib.Table targs)
```
    Adds a new remote.
    
    Parameters:
    
    targs - Table of arguments used to initialize a new remote connection.
    
    Returns:
    
    comment here
    
    See Also:
    
    openRemote(Table)
  - openRemote
```
public Rmif.Remote openRemote(nxm.sys.lib.Table args)
```
    Adds a new remote and opens it. This calls addRemote(args) and then opens the the connection.
    
    Parameters:
    
    args - Table of arguments used to initialize a new remote connection.
    
    Returns:
    
    comment here
    
    See Also:
    
    addRemote(Table)
  - getRemote
```
public Rmif.Remote getRemote(java.lang.Object obj)
```
    Converts the given object to a remote.
    
    Parameters:
    
    obj - The object to convert to a remote.
    
    Returns:
    
    The remote instance or null if unable to convert this object to a remote instance.
  - getRemote
```
public Rmif.Remote getRemote(nxm.sys.lib.Table targs)
```
    Get a remote based on the ID in a table
    
    Parameters:
    
    targs - comment here
    
    Returns:
    
    comment here
  - removeRemote
```
public void removeRemote(nxm.sys.lib.Table targs)
```
    Closes the given remote and removes it from the set of remotes. This is the same as removeRemote(getRemote(targs)).
    
    Parameters:
    
    targs - The remote to remove.
    
    See Also:
    
    removeRemote(Rmif.Remote)
  - removeRemote
```
public void removeRemote(Rmif.Remote r)
```
    Closes the given remote and removes it from the set of remotes. This calls closeRemote(Rmif.Remote) to close the remote if it is still open.
    
    Parameters:
    
    r - The remote to remove.
    
    See Also:
    
    closeRemote(Rmif.Remote)
  - closeRemote
```
public void closeRemote(Rmif.Remote r)
```
    Close the given remote, removing it from the context registry in the process. All open channels and properties associated with this remote are also closed. If the remote is null then the method has no effect.
    
    Upon returning from this method the given remote will be closed along with all of its channels and properties. The state of the remote will have been set to CLOSED but it will NOT have been removed from the set of remotes (this allows it to be reopened later). Use removeRemote(Rmif.Remote) to remove a remote from the set of remotes.
    
    Parameters:
    
    r - The remote to close.
    
    See Also:
    
    removeRemote(Rmif.Remote)
  - addChannel
```
public void addChannel(Rmif.Remote r,
                       int ic,
                       java.lang.String name)
```
    Adds a channel. Same as addChannel(r,ic,name,0).
    
    Parameters:
    
    r - Remote connection.
    
    ic - Channel number.
    
    name - Channel name.
  - addChannel
```
public void addChannel(Rmif.Remote r,
                       int ic,
                       java.lang.String name,
                       int flags)
```
    Adds a channel to a Remote.
    
    Parameters:
    
    r - Remote connection.
    
    ic - Channel number (use ic=-1 to automatically assign next available number).
    
    name - Channel name (e.g. "SET", "GET", "RET", "ACK".
    
    flags - Channel flags (see Rmif.Channel).
  - closeChannel
```
public void closeChannel(int ic)
```
    Closes a channel.
    
    Parameters:
    
    ic - Channel number.
  - closeChannel
```
public void closeChannel(java.lang.String name)
```
    Closes a channel.
    
    Parameters:
    
    name - Channel name.
  - functionName
```
public static java.lang.String functionName(byte func)
```
    Converts from function ID to name (see functionList).
    
    Parameters:
    
    func - comment here
    
    Returns:
    
    comment here
  - protocolName
```
public static java.lang.String protocolName(int protocol)
```
    Converts from protocol ID to name.
    
    Parameters:
    
    protocol - comment here
    
    Returns:
    
    comment here
  - protocolNameForSeq
```
public static java.lang.String protocolNameForSeq(int seq)
```
    Converts from packet sequence number to protocol name (see Rmif for details).
    
    Parameters:
    
    seq - comment here
    
    Returns:
    
    comment here
    
    Since:
    
    NeXtMidas 2.5.0
  - propTypeName
```
public static java.lang.String propTypeName(int type)
```
    Converts property type ID to string (see typeList).
    
    Parameters:
    
    type - comment here
    
    Returns:
    
    comment here
  - getTag
```
public java.lang.String getTag()
```
    brief description of command
    
    Returns:
    
    comment here
  - serveProperties
```
public int serveProperties()
```
    serve all properties loop
    
    Returns:
    
    comment here
  - servePacket
```
public void servePacket(byte func,
                        int info,
                        byte[] bytes,
                        int flags)
```
    Serves a packet. This is used to broadcast a packet to all subscribers of a given property type. This iterates over all of the listeners for the property and sends the packet to each of them with sendPacket(byte,int,byte[],int,int,Rmif.Remote,int,double).
    
    Parameters:
    
    func - The property type (ACK, RET, SET, or GET).
    
    info - The packet info (passed to sendPacket(..)).
    
    bytes - The packet bytes (passed to sendPacket(..)).
    
    flags - The packet flags (passed to sendPacket(..)).
  - servePipeProperty
```
@Deprecated
public int servePipeProperty(Rmif.Property p)
```
    Deprecated. Since NeXtMidas 2.5.0: Internal use only; use serveProperties().
    
    Parameters:
    
    p - comment here
    
    Returns:
    
    comment here
  - serveResultProperty
```
@Deprecated
public int serveResultProperty(Rmif.Property p)
```
    Deprecated. Since NeXtMidas 2.5.0: Internal use only; use serveProperties().
    
    Parameters:
    
    p - comment here
    
    Returns:
    
    comment here
  - serveFileProperty
```
@Deprecated
public int serveFileProperty(Rmif.Property p)
```
    Deprecated. Since NeXtMidas 2.5.0: Internal use only; use serveProperties().
    
    Parameters:
    
    p - comment here
    
    Returns:
    
    comment here
  - setMessageHandler
```
public nxm.sys.inc.MessageHandler setMessageHandler(nxm.sys.inc.MessageHandler mh)
```
    Set the message handler for messages received from remotes.
    
    Parameters:
    
    mh - The Message Handler (for messages received from remotes).
    
    Returns:
    
    previous message handler
    
    Since:
    
    NeXtMidas 3.3.0
  - getMessageHandler
```
public nxm.sys.inc.MessageHandler getMessageHandler()
```
    Get the current message handler for messages received from remotes.
    
    Returns:
    
    current message handler (null for none)
    
    Since:
    
    NeXtMidas 3.3.0
  - getMaxErrorsToNotServeProperty
```
public int getMaxErrorsToNotServeProperty()
```
    Get maximum number of errors when serving a property (pipe,result, etc.) to client before removing it to prevent flood of errors on server side. This count is per Property and gets reset after success.
    
    Returns:
    
    comment here
    
    Since:
    
    NeXtMidas 3.5.0
  - setMaxErrorsToNotServeProperty
```
public void setMaxErrorsToNotServeProperty(int newValue)
```
    Set maximum number of errors when serving a property (pipe,result, etc.) to client before removing it to prevent flood of errors on server side. This count is per Property and gets reset after success. Used in serveProperties().
    
    Parameters:
    
    newValue - comment here
    
    Since:
    
    NeXtMidas 3.5.0

Class Rmif

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SET

GET

RET

ACK

OPEN

CLOSE

SEND

RECV

PING

PONG

DHDR

DBUF

ADDR

MODIFY

OPENED

CLOSED

DBUFC

DBUFD

DBUFZ

DBUFX

GETPROP

RETPROP

RECEIPT

LINKTEST

MFTP

DROPPED

functionList

MINFUNCTION

MAXFUNCTION

FUNC

FLAG

INFO

REP

SEQ

TRY

RPT

ADJ

DATA

RDP

UDP

TCP

IDP

protocolList

TYPE_RAW

TYPE_BINARY

TYPE_XML

TYPE_ASCII

ADJ_TIME

ADJ_OFFSET

ADJ_USER

PIPE

RESULT

KEY

MESSAGE

FILE

typeList

DC_RAW

DC_BAND

DC_CONST

DC_PACK

MULTI

MAX_WINDOW

nchannel

nproperty

remotes

properties

channels

Constructor Detail

Rmif

Rmif

Method Detail

open

open