Interface horb.orb.IOCIService
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface horb.orb.IOCIService

public interface IOCIService
extends Object
Services provided by IOCI. Programmers can get these services from IOCI.
 Client side:
	Server_Proxy server = new Server_Proxy(url);
	IOCIService ioci = (IOCIService)server._getIOCI();
	String threadName = ioci.getThreadName();
 Server side:
     IOCIService ioci = (IOCIService)HORBServer.getIOCI();
	ioci.setProperty(PROP_DEBUG, null); // debug flag of the IOCI
 

Variable Index

 o PROP_ANSWER
answer is needed.
 o PROP_DEBUG
turn on debug flag of the IOCI object.
 o PROP_LOOP_CHECK
loop check on.
 o PROP_NO_ANSWER
no answer is needed.
 o PROP_NO_DEBUG
turn off debug flag.
 o PROP_NO_LOOP_CHECK
no loop check.
 o PROP_NO_STRICT
no strict check
 o PROP_STRICT
strict check.
 o PROP_USER
users can use number from this to manipulate users IOCI.

Method Index

 o available()
return number of bytes available without blocking.
 o getAddress()
returns peer's network address.
 o getHostName()
returns peer's hostname.
 o getLocalAddress()
returns the network address of the local host.
 o getLocalHostName()
returns the hostname of the local host.
 o getMajorVersion()
get the major version number of this IOCI.
 o getMinorVersion()
get the major version number of this IOCI.
 o getProperty(int, Object)
get properties of IOCI.
 o getThreadName()
returns the thread name of the remote object.
 o getUsername()
return username.
 o isConnected()
true if connection is connected normally.
 o release()
release the connection.
 o setProperty(int, Object)
set properties of IOCI.

Variables

 o PROP_DEBUG
  public final static byte PROP_DEBUG
turn on debug flag of the IOCI object. Default off.
 Server side:
     IOCIService ioci = (IOCIService)HORBServer.getIOCI();
     ioci.setProperty(PROP_DEBUG, null); // debug flag of the IOCI
 Client side:
	  Server_Proxy server = new Server_Proxy(url);
	  IOCIService ioci = (IOCIService)server._getIOCI();
     ioci.setProperty(PROP_DEBUG, null); // debug flag of the IOCI
 o PROP_NO_DEBUG
  public final static byte PROP_NO_DEBUG
turn off debug flag.
 o PROP_STRICT
  public final static byte PROP_STRICT
strict check. Default is off. If on, an exception occures when:
 o PROP_NO_STRICT
  public final static byte PROP_NO_STRICT
no strict check
 o PROP_LOOP_CHECK
  public final static byte PROP_LOOP_CHECK
loop check on. If on, loop or merging data structure is passed as it is. If false, a program fails into an infinit loop when it passes a loop structure. Loop check causes slite speed penalty. Default is on.
 o PROP_NO_LOOP_CHECK
  public final static byte PROP_NO_LOOP_CHECK
no loop check.
 o PROP_ANSWER
  public final static short PROP_ANSWER
answer is needed. (This property is not used.)
 o PROP_NO_ANSWER
  public final static short PROP_NO_ANSWER
no answer is needed. (This property is not used.)
 o PROP_USER
  public final static short PROP_USER
users can use number from this to manipulate users IOCI.

Methods

 o getThreadName
  public abstract String getThreadName()
returns the thread name of the remote object.
 o setProperty
  public abstract void setProperty(int reqest,
                                   Object object)
set properties of IOCI.
Examples:
 Server side:
     IOCIService ioci = (IOCIService)HORBServer.getIOCI();
     ioci.setProperty(PROP_DEBUG, null); // debug flag of the IOCI
 Client side:
	  Server_Proxy server = new Server_Proxy(url);
	  IOCIService ioci = (IOCIService)server._getIOCI();
     ioci.setProperty(PROP_DEBUG, null); // debug flag of the IOCI
Parameters:
request - request code. PROP_*
object - request specific option
 o getProperty
  public abstract Object getProperty(int request,
                                     Object object)
get properties of IOCI. Currently no function is defined.
Parameters:
request - request code. PROP_*
object - request specific option
Returns:
object request specific option
 o getMajorVersion
  public abstract short getMajorVersion()
get the major version number of this IOCI. different numbers mean incompatibility.
 o getMinorVersion
  public abstract short getMinorVersion()
get the major version number of this IOCI. upward compatible with other minor version.
 o isConnected
  public abstract boolean isConnected()
true if connection is connected normally. Don't rely on this method of BasicIOCI.
See Also:
isConnected.
 o available
  public abstract int available() throws IOException
return number of bytes available without blocking.
 o release
  public abstract void release()
release the connection. If you want disconnect a connection between a client, use this method. Use proxy._release() from the client side.
 Server side:
    IOCIService ioci = (IOCIService)HORBServer.getIOCI();
    ioci.release();
 Client side:
    proxy._release();
See Also:
_release
 o getLocalHostName
  public abstract String getLocalHostName() throws IOException
returns the hostname of the local host.
 o getLocalAddress
  public abstract byte[] getLocalAddress() throws IOException
returns the network address of the local host. Note that BasicIOCI has getLocalInetAddress().
See Also:
getLocalInetAddress.
 o getHostName
  public abstract String getHostName()
returns peer's hostname.
 o getAddress
  public abstract byte[] getAddress()
returns peer's network address. Note that BasicIOCI has getInetAddress().
See Also:
getInetAddress
 o getUsername
  public abstract String getUsername()
return username. null means anonymous access. This method makes sense at the server side.

All Packages  Class Hierarchy  This Package  Previous  Next  Index