edu.vt.marian.uip
Class rpc_function

java.lang.Object
  |
  +--edu.vt.marian.uip.rpc_function
public class rpc_function
extends java.lang.Object

class name: rpc_function class description: this class represent a rpc (remote procedure call) function uses the services of class(es): parameter, xdr, debug designer(s): Jianxin Zhao (jxzhao@csgrad.cs.vt.edu) implementator(s): Xuelei Sun (xusun@csgrad.cs.vt.edu) finished time: December 6, 1998 known bugs: JDK version: 1.1.5 side effects:

Field Summary
static int ADD_PARAMETER_INVALID_INDEX
           
static int ADD_PARAMETER_INVALID_PARAMETER
           
static int DELETE_PARAMETER_INVALID_INDEX
           
static int OK
           
static int SET_PARAMETER_INVALID_INDEX
           
static int SET_PARAMETER_INVALID_PARAMETER
           
static int TO_STREAM_IN_XDR_FUNCTION_NOT_VALID
           
static int TO_STREAM_IN_XDR_INVALID_VERSION
           
static int TO_STREAM_IN_XDR_NULL_NAME
           
static int TO_STREAM_IN_XDR_NULL_STREAM
           
static int TO_STREAM_IN_XDR_WRITE_FAILED
           
static int TO_STREAM_NULL_STREAM
           
static int TO_STREAM_WRITE_FAILED
           
static int TO_STREAM_WRITE_PARAMETER_FAILED
           
static int TO_TREAM_IN_XDR_UNKNOWN_FUNCTION
           
 
Constructor Summary
rpc_function(java.io.BufferedInputStream bis, int version, edu.vt.marian.common.Debug debug)
          method description: this constructor will create a rpc_function object from a stream according to different versions uses the services of class(es): Debug, xdr, parameter input parameter(s): BufferedInputStream bis: input stream int version: version 1 -- hard coded function and parameters version 2 -- all the information is in xdr format Debug debug: debug object output parameter(s): none return value: none synchronization consideration: none
rpc_function(edu.vt.marian.common.Debug debug)
          method description: this constructor will create a rpc_function object, the object is empty upon creation uses the services of class(es): Debug input parameter(s): Debug debug, debug object output parameter(s): none return value: none synchronization consideration: none
 
Method Summary
 int add_parameter(int index, parameter p)
          method description: this method will add the parameter to the function the parameter will be added at the place of index uses the services of class(es): Debug input parameter(s): int index, the index indicats the location for adding the parameter parameter p, the parameter to be added output parameter(s): none return value: OK ADD_PARAMETER_INVALID_INDEX ADD_PARAMETER_INVALID_PARAMETER synchronization consideration: synchronized
 int add_parameter(parameter p)
          method description: this method will add the parameter to the function the parameter will be added at the end of the parameter list uses the services of class(es): Debug input parameter(s): parameter p, the parameter to be added output parameter(s): none return value: OK ADD_PARAMETER_INVALID_PARAMETER synchronization consideration: synchroized
 int delete_parameter(int index)
          method description: this method will delete the parameter at the index position uses the services of class(es): Debug input parameter(s): int index, the index indicats the location for deleting the parameter output parameter(s): none return value: OK DELETE_PARAMETER_INVALID_INDEX synchronization consideration: synchroized
 java.lang.String get_name()
          method description: this method will return the name of the function uses the services of class(es): none input parameter(s): none output parameter(s): none return value: String name of the function synchronization consideration: none
 int get_number_parameters()
          method description: this method will return the number of the parameters in the function uses the services of class(es): none input parameter(s): none output parameter(s): none return value: integer, number of parameters of the function synchronization consideration: none
 parameter get_parameter(int index)
          method description: this method will return the parameter which locates at the index position uses the services of class(es): Debug input parameter(s): int index, the position of the parameter output parameter(s): none return value: parameter, the parameter object synchronization consideration: synchronized
 boolean is_valid()
          method description: this method will return the valid value uses the services of class(es): none input parameter(s): none output parameter(s): none return value: boolean valid value synchronization consideration: none
 int set_name(java.lang.String name)
          method description: this method will set the name of the function uses the services of class(es): none input parameter(s): String name, the name which will be set output parameter(s): none return value: OK 0; synchronization consideration: none
 int set_parameter(int index, parameter p)
          method description: this method will set the parameter at position index uses the services of class(es): Debug input parameter(s): int index, the position of the parameter parameter p, the parameter which will be set output parameter(s): none return value: OK SET_PARAMETER_INVALID_PARAMETER SET_PARAMETER_INVALID_INDEX synchronization consideration: synchronized
 int to_stream_in_xdr(java.io.BufferedOutputStream bos, int version)
          method description: this method will write the function into the stream in xdr format uses the services of class(es): Debug, xdr, parameter input parameter(s): BufferedOutputStream bos, output stream int version, version number output parameter(s): none return value: OK TO_STREAM_IN_XDR_NULL_STREAM TO_STREAM_IN_XDR_NULL_NAME TO_STREAM_IN_XDR_WRITE_FAILED TO_TREAM_IN_XDR_UNKNOWN_FUNCTION TO_STREAM_IN_XDR_INVALID_VERSION synchronization consideration: synchronized
 int to_stream(int detail_level, java.io.PrintWriter pw)
          method description: this method will write the function into the stream in readable format uses the services of class(es): Debug, xdr, parameter input parameter(s): int detail_level PrintWriter pw; output parameter(s): none return value: OK TO_STREAM_NULL_STREAM TO_STREAM_WRITE_FAILED TO_STREAM_WRITE_PARAMETER_FAILED synchronization consideration: synchronized
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OK

public static final int OK

ADD_PARAMETER_INVALID_PARAMETER

public static final int ADD_PARAMETER_INVALID_PARAMETER

ADD_PARAMETER_INVALID_INDEX

public static final int ADD_PARAMETER_INVALID_INDEX

DELETE_PARAMETER_INVALID_INDEX

public static final int DELETE_PARAMETER_INVALID_INDEX

SET_PARAMETER_INVALID_PARAMETER

public static final int SET_PARAMETER_INVALID_PARAMETER

SET_PARAMETER_INVALID_INDEX

public static final int SET_PARAMETER_INVALID_INDEX

TO_STREAM_IN_XDR_NULL_STREAM

public static final int TO_STREAM_IN_XDR_NULL_STREAM

TO_STREAM_IN_XDR_NULL_NAME

public static final int TO_STREAM_IN_XDR_NULL_NAME

TO_STREAM_IN_XDR_WRITE_FAILED

public static final int TO_STREAM_IN_XDR_WRITE_FAILED

TO_TREAM_IN_XDR_UNKNOWN_FUNCTION

public static final int TO_TREAM_IN_XDR_UNKNOWN_FUNCTION

TO_STREAM_IN_XDR_INVALID_VERSION

public static final int TO_STREAM_IN_XDR_INVALID_VERSION

TO_STREAM_NULL_STREAM

public static final int TO_STREAM_NULL_STREAM

TO_STREAM_WRITE_FAILED

public static final int TO_STREAM_WRITE_FAILED

TO_STREAM_WRITE_PARAMETER_FAILED

public static final int TO_STREAM_WRITE_PARAMETER_FAILED

TO_STREAM_IN_XDR_FUNCTION_NOT_VALID

public static final int TO_STREAM_IN_XDR_FUNCTION_NOT_VALID
Constructor Detail

rpc_function

public rpc_function(edu.vt.marian.common.Debug debug)
method description: this constructor will create a rpc_function object, the object is empty upon creation uses the services of class(es): Debug input parameter(s): Debug debug, debug object output parameter(s): none return value: none synchronization consideration: none

rpc_function

public rpc_function(java.io.BufferedInputStream bis,
                    int version,
                    edu.vt.marian.common.Debug debug)
method description: this constructor will create a rpc_function object from a stream according to different versions uses the services of class(es): Debug, xdr, parameter input parameter(s): BufferedInputStream bis: input stream int version: version 1 -- hard coded function and parameters version 2 -- all the information is in xdr format Debug debug: debug object output parameter(s): none return value: none synchronization consideration: none
Method Detail

add_parameter

public int add_parameter(parameter p)
method description: this method will add the parameter to the function the parameter will be added at the end of the parameter list uses the services of class(es): Debug input parameter(s): parameter p, the parameter to be added output parameter(s): none return value: OK ADD_PARAMETER_INVALID_PARAMETER synchronization consideration: synchroized

add_parameter

public int add_parameter(int index,
                         parameter p)
method description: this method will add the parameter to the function the parameter will be added at the place of index uses the services of class(es): Debug input parameter(s): int index, the index indicats the location for adding the parameter parameter p, the parameter to be added output parameter(s): none return value: OK ADD_PARAMETER_INVALID_INDEX ADD_PARAMETER_INVALID_PARAMETER synchronization consideration: synchronized

delete_parameter

public int delete_parameter(int index)
method description: this method will delete the parameter at the index position uses the services of class(es): Debug input parameter(s): int index, the index indicats the location for deleting the parameter output parameter(s): none return value: OK DELETE_PARAMETER_INVALID_INDEX synchronization consideration: synchroized

get_name

public java.lang.String get_name()
method description: this method will return the name of the function uses the services of class(es): none input parameter(s): none output parameter(s): none return value: String name of the function synchronization consideration: none

get_number_parameters

public int get_number_parameters()
method description: this method will return the number of the parameters in the function uses the services of class(es): none input parameter(s): none output parameter(s): none return value: integer, number of parameters of the function synchronization consideration: none

get_parameter

public parameter get_parameter(int index)
method description: this method will return the parameter which locates at the index position uses the services of class(es): Debug input parameter(s): int index, the position of the parameter output parameter(s): none return value: parameter, the parameter object synchronization consideration: synchronized

set_name

public int set_name(java.lang.String name)
method description: this method will set the name of the function uses the services of class(es): none input parameter(s): String name, the name which will be set output parameter(s): none return value: OK 0; synchronization consideration: none

set_parameter

public int set_parameter(int index,
                         parameter p)
method description: this method will set the parameter at position index uses the services of class(es): Debug input parameter(s): int index, the position of the parameter parameter p, the parameter which will be set output parameter(s): none return value: OK SET_PARAMETER_INVALID_PARAMETER SET_PARAMETER_INVALID_INDEX synchronization consideration: synchronized

to_stream_in_xdr

public int to_stream_in_xdr(java.io.BufferedOutputStream bos,
                            int version)
method description: this method will write the function into the stream in xdr format uses the services of class(es): Debug, xdr, parameter input parameter(s): BufferedOutputStream bos, output stream int version, version number output parameter(s): none return value: OK TO_STREAM_IN_XDR_NULL_STREAM TO_STREAM_IN_XDR_NULL_NAME TO_STREAM_IN_XDR_WRITE_FAILED TO_TREAM_IN_XDR_UNKNOWN_FUNCTION TO_STREAM_IN_XDR_INVALID_VERSION synchronization consideration: synchronized

to_stream

public int to_stream(int detail_level,
                     java.io.PrintWriter pw)
method description: this method will write the function into the stream in readable format uses the services of class(es): Debug, xdr, parameter input parameter(s): int detail_level PrintWriter pw; output parameter(s): none return value: OK TO_STREAM_NULL_STREAM TO_STREAM_WRITE_FAILED TO_STREAM_WRITE_PARAMETER_FAILED synchronization consideration: synchronized

is_valid

public boolean is_valid()
method description: this method will return the valid value uses the services of class(es): none input parameter(s): none output parameter(s): none return value: boolean valid value synchronization consideration: none