Interface cern.lhcias.csgui.interfaces.DataServer

public interface DataServer

This interface describes a driver used to access the value of the Tags.
The case when the way to send the tags' values is different than the one to read
the values has been taken into account (setReadHost and setWriteHost,...).

If the driver works in a pooling way (or if it has been set to pooling via setType
for example, then a call to enable() will launch the pooling mechanism
(if pooling_interval is set to a value different from -1).
In that case, the driver must know about the TagArrays where to send the data.

DataServer may be used without TagArrays: the following methods can be used without
setting TagArrays:
public void write(String name, String stringValue);
public String read(String name);

Each instance of the driver is named using a "Process Name". So the user may indicates
to which process corresponds a Tag.

The config which is returned by toString and that can be sent to setConfig has the
following format:
ProcessName;Protocol;Type;ReadHost;ReadPort;WriteHost;WritePort;PoolFrequency;subscriptionMode[;param1=val1[;...]]
ex: String;Socket;OnChange;myHost;3000;;;-1;true


Method Index

 o addAlarmListener(AlarmListener)
 
 o closeConnection()
 
 o disable()
 
 o doYouImplement(String)
 
 o enable()
 
 o getDriverProtocol()
 
 o getMask()
 
 o getParameter(String)
 
 o getPassword()
 
 o getPoolingInterval()
 
 o getPossibleProtocols()
 
 o getProcessName()
 
 o getReadHost()
 
 o getReadPort()
 
 o getTagsSubscription()
 
 o getType()
 
 o getUser()
 
 o getWriteHost()
 
 o getWritePort()
 
 o isActive()
 
 o read(String)
 
 o read(Vector)
 
 o removeAlarmListener(AlarmListener)
 
 o setConfig(String)
 
 o setMask(boolean)
 
 o setParameter(String, String)
 
 o setPassword(String)
 
 o setPoolingInterval(long)
 
 o setProcessName(String)
 
 o setReadHost(String)
 
 o setReadPort(int)
 
 o setTagArrays(TagArrays)
 
 o setTagsSubscription(boolean)
 
 o setType(String)
 
 o setUser(String)
 
 o setWriteHost(String)
 
 o setWritePort(int)
 
 o toString()
 
 o write(String, String)
 

Methods

 o setReadHost

 public abstract void setReadHost(String host)

 o getReadHost

 public abstract String getReadHost()

 o setReadPort

 public abstract void setReadPort(int communicationReadPort)

 o getReadPort

 public abstract int getReadPort()

 o setWriteHost

 public abstract void setWriteHost(String host)

 o getWriteHost

 public abstract String getWriteHost()

 o setWritePort

 public abstract void setWritePort(int communicationWritePort)

 o getWritePort

 public abstract int getWritePort()

 o setPoolingInterval

 public abstract void setPoolingInterval(long poolingInterval)

 o getPoolingInterval

 public abstract long getPoolingInterval()

 o setType

 public abstract void setType(String communication_type)

 o getType

 public abstract String getType()

 o setMask

 public abstract void setMask(boolean mask)

 o getMask

 public abstract boolean getMask()

 o setUser

 public abstract void setUser(String user)

 o setPassword

 public abstract void setPassword(String password)

 o getUser

 public abstract String getUser()

 o getPassword

 public abstract String getPassword()

 o setTagArrays

 public abstract void setTagArrays(TagArrays tc)

 o setParameter

 public abstract void setParameter(String parameter,
                                   String value)

 o getParameter

 public abstract String getParameter(String parameter)

 o setTagsSubscription

 public abstract void setTagsSubscription(boolean subMode)

 o getTagsSubscription

 public abstract boolean getTagsSubscription()

 o setProcessName

 public abstract void setProcessName(String processName)

 o getProcessName

 public abstract String getProcessName()

 o setConfig

 public abstract void setConfig(String config)

 o toString

 public abstract String toString()
Overrides:
toString in class Object

 o enable

 public abstract void enable()

 o disable

 public abstract void disable()

 o isActive

 public abstract boolean isActive()

 o write

 public abstract void write(String name,
                            String stringValue)

 o read

 public abstract String read(String name)

 o read

 public abstract boolean read(Vector names)

 o closeConnection

 public abstract void closeConnection()

 o getDriverProtocol

 public abstract String getDriverProtocol()

 o getPossibleProtocols

 public abstract Vector getPossibleProtocols()

 o doYouImplement

 public abstract boolean doYouImplement(String protocol)

 o addAlarmListener

 public abstract void addAlarmListener(AlarmListener listener)

 o removeAlarmListener

 public abstract void removeAlarmListener(AlarmListener listener)