All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.arcsinc.hardwarehost.HdwHostImpl

java.lang.Object
   |
   +----java.rmi.server.RemoteObject
           |
           +----java.rmi.server.RemoteServer
                   |
                   +----java.rmi.server.UnicastRemoteObject
                           |
                           +----com.arcsinc.hardwarehost.HdwHostImpl

public class HdwHostImpl
extends UnicastRemoteObject
implements HdwHost
The HdwHostImpl class provides the base functionality associated with coordinating access to the hardware.

See Also:
HdwHost, HdwHostAdost.HdwHostAddOn.html#_top_">HdwHostAddOn, HdwMgr, HdwMgrImpl, HdwComm, HdwCommImpl, CoffHandler, ClientDataMgr, DataClient, MonitoringClient, ControllingClient, ClientProxy, CntlClientProxy, Remote, RemoteException, UnicastRemoteObject

Variable Index

 o activeControlProxy
 o clientProxies
 o cntlClientProxies
 o hdwHostAddOns

Constructor Index

 o HdwHostImpl()
Default constructor.

Method Index

small.gif addDataClient(DataClient)
Registers a DataClient to receive on-line data.
 o addHdwHostAddOn(HdwHostAddOn)
Provides the ability to add objects to the HdwHostImpl instantance.
 o finalize()
 o getCoffHandler()
Gets a reference to the CoffHandler.
 o getHdwComm()
Gets a reference to the HdwComm.
 o getHdwMgr()
Gets a reference to the HdwMgr.
 o getNumClientProxies()
 o initClientProxy(MonitoringClient) >(MonitoringClient)
Establishes a ClientProxy for a MonitoringClient.
 o initCntlClientProxy(ControllingClient)
Establishes a CntlClientProxy for a ControllingClient.
 o relinguishActiveControl(ControllingClient)
Relinguish control of the HdwHost by its current ControllingClient.
 o removeClient(MonitoringClient)
Removes a MonitoringClient.
 o removeClientUtil(HdwClient, Vector)
Basic utility function for disposing of client relationships.
 o removeCntlClient(ControllingClient)
Removes a ControllingClient.
 o removeDataClient(DataClient)
Unregisters a DataClient.
 o removeHdwHostAddOn(HdwHostAddOn)
Removes an add-on object from this instance of HdwHostImpl.
 o requestActiveControl(ControllingClient)
Request control of the HdwHost by a particular ControllingClient.

Variables

 o activeControlProxy
 protected CntlClientProxy activeControlProxy
 o cntlClientProxies
 protected Vector cntlClientProxies
 o clientProxies
 protected Vector c
 protected Vector clientProxies
 o hdwHostAddOns
 protected Vector hdwHostAddOns

Constructors

s">  o HdwHostImpl
 public HdwHostImpl() throws RemoteException
Default constructor. It creates an instance of HdwHostImpl, as well as, its instances of HdwMgrImpl, HdwCommImpl, and its CoffHandler.

Throws: RemoteException
a general network or Remote failure.

Methods

 o finalize
 public void finalize()
Overrides:
finalize in class Object
 o getNumClientProxies
 public int getNumClientProxies()
 o getHdwMgr
 public HdwMgr getHdwMgr()
Gets a reference to the HdwMgr.

reference to the HdwMgr.

Returns:
the HdwHostImpl's HdwMgr.
 o getHdwComm
 public HdwComm getHdwComm()
Gets a reference to the HdwComm.

Returns:
the HdwHostImpl's HdwComm.
 o getCoffHandler
 public CoffHandler getCoffHandler()
Gets a reference to the CoffHandler.

Returns:
the HdwHostImpl's CoffHandler.
 o initClientProxy
 public ClientProxy initClientProxy(MonitoringClient v) throws RemoteException
Establishes a ClientProxy for a MonitoringClient.

Parameters:
v - the MonitoringClient which requires a ClientProxy
Returns:
the created ClientProxy
Throws: RemoteException
a general network or Remote failure.
 o initCntlClientProxy
 public 
 public CntlClientProxy initCntlClientProxy(ControllingClient v) throws RemoteException
Establishes a CntlClientProxy for a ControllingClient. This implementation allows for only one ControllingClient; active control is granted with successful completion of this call.

Parameters:
v - the ControllingClient which requires a CntlClientProxy
Returns:
the created CntlClientProxy or null if a ControllingClient has already been established.
Throws: RemoteException
a general network or Remote failure.
 o removeClientUtil
 protected boolean removeClientUtil(HdwClient v,
                                    Vector x) throws RemoteException
Basic utility function for disposing of client relationships.

Parameters:
v - client to be removed.
x - Vector of currently registered proxies.
Returns:
true if successfully removed, otherwise false.
Throws: RemoteException
a general network or Remote failure.
 o removeClient
 public boolean removeClient(MonitoringClient v) throws RemoteException
Removes a MonitoringClient. This function should also delete the client's ClientProxy

Parameters:
v - the MonitoringClient to be removed.
Returns:
success or failure
Throws: RemoteException
a general network or Remote failure.
 o removeCntlClient
b>
 public boolean removeCntlClient(ControllingClient v) throws RemoteException
Removes a ControllingClient. This function should also delete the client's CntlClientProxy

Parameters:
v - the ControllingClient to be removed.
Returns:
success or failure
Throws: RemoteException
a general network or Remote failure.
 o relinguishActiveControl
 public boolean relinguishActiveControl(ControllingClient v) throws RemoteException
Relinguish control of the HdwHost by its current ControllingClient. This function is not currently implemented; always returns true.

Parameters:
v - the ControllingClient with active control.
Returns:
success or failure
Throws: RemoteException
a general network or Remote failure.
 o requestActiveControl
 public boolean requestActiveControl(ControllingClient v) throws RemoteException
Request control of the HdwHost by a particular ControllingClient. This function is not currently implemented; always returns true.

Parameters:
v - the ControllingClieollingClient with active control.
Returns:
true if control is granted, otherwise false.
Throws: RemoteException
a general network or Remote failure.
 o addDataClient
 public ClientDataMgr addDataClient(DataClient dc)
Registers a DataClient to receive on-line data. This implementation provides a simple call to the host's HostDataMgrImpl.

Parameters:
dc - the DataClient to be registered.
Returns:
the client's dedicated manager.
 o removeDataClient
 public void removeDataClient(DataClient dc)
Unregisters a DataClient. This implementation provides a simple call to the host's HostDataMgrImpl.

P

Parameters:
dc - the DataClient to be unregistered.
 o addHdwHostAddOn
 public void addHdwHostAddOn(HdwHostAddOn addOn)
Provides the ability to add objects to the HdwHostImpl instantance. Any object wishing registration must implement the HdwHostAddOn n interface. The add-on object is automatically registered as a HdwListener.

Parameters:
addOn - the add-on object
 o removeHdwHostAddOn
 public void removeHdwHostAddOn(HdwHostAddOn addOn)
Removes an add-on object from this instance of HdwHostImpl.

Parameters:
addOn - object to remove as an add-on.

All Packages  Class Hierarchy  This Package  Previous  Next  Index
/pre>