Package gov.aps.jca.cas

Class ServerChannel

java.lang.Object

gov.aps.jca.cas.ServerChannel

public class ServerChannel
extends Object

Server channel (client connection to process variable). This (default) implementation grants all access rights.

Version:

$Id: ServerChannel.java,v 1.8 2006-08-28 12:28:32 msekoranja Exp $

Author:

Matej Sekoranja

Field Summary

Fields

Modifier and Type	Field	Description
protected int	cid	Channel CID.
protected boolean	destroyed	Destroy state.
protected Map	monitors	Monitors.
protected ProcessVariable	processVariable	Process variable.
protected int	sid	Channel SID.

Constructor Summary

Constructors

Constructor	Description
ServerChannel(ProcessVariable processVariable, int cid, int sid, String userName, String hostName)	Create server channel for given process variable.

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destory server channel.
protected void	destroyAllMonitors()	Destroy all registered monitors.
int	getCID()	Get channel CID.
ServerMonitor	getMonitor(int ioid)	Get monitor by its IOID.
ProcessVariable	getProcessVariable()	Get process variable.
int	getSID()	Get channel SID.
void	printInfo()	Prints detailed information about the process variable to the standard output stream.
void	printInfo(PrintStream out)	Prints detailed information about the process variable to the specified output stream.
CAStatus	read(DBR value, ProcessVariableReadCallback asyncReadCallback)	Read process variable value.
boolean	readAccess()	Check if read access is granted.
void	registerMonitor(ServerMonitor monitor)	Register monitor.
void	unregisterMonitor(ServerMonitor monitor)	Unregister monitor.
CAStatus	write(DBR value, ProcessVariableWriteCallback asyncWriteCallback)	Write process variable value.
boolean	writeAccess()	Check if write access is granted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

processVariable

protected ProcessVariable processVariable

Process variable.

sid

protected int sid

Channel SID.

cid

protected int cid

Channel CID.

monitors

protected Map monitors

Monitors.

destroyed

protected boolean destroyed

Destroy state.

Constructor Detail

ServerChannel

public ServerChannel(ProcessVariable processVariable,
                     int cid,
                     int sid,
                     String userName,
                     String hostName)

Create server channel for given process variable.

Parameters:

processVariable - process variable.

cid - channel CID.

sid - channel SID.

userName - client user name.

hostName - client host name.

Method Detail

getProcessVariable

public ProcessVariable getProcessVariable()

Get process variable.

Returns:

process variable.

getCID

public int getCID()

Get channel CID.

Returns:

channel CID.

getSID

public int getSID()

Get channel SID.

Returns:

channel SID.

read

public CAStatus read(DBR value,
                     ProcessVariableReadCallback asyncReadCallback)
              throws CAException

Read process variable value. Default implementation calls ProcessVariable.read() method.

Throws:

CAException

See Also:

ProcessVariable

write

public CAStatus write(DBR value,
                      ProcessVariableWriteCallback asyncWriteCallback)
               throws CAException

Write process variable value. Default implementation calls ProcessVariable.write() method.

Throws:

CAException

See Also:

ProcessVariable

readAccess

public boolean readAccess()

Check if read access is granted.

Returns:

true (default) if read access is granted, false otherwise.

writeAccess

public boolean writeAccess()

Check if write access is granted.

Returns:

true (default) if write access is granted, false otherwise.

registerMonitor

public void registerMonitor(ServerMonitor monitor)

Register monitor.

Parameters:

monitor - monitor to be registered.

unregisterMonitor

public void unregisterMonitor(ServerMonitor monitor)

Unregister monitor.

Parameters:

monitor - monitor to be unregistered.

getMonitor

public ServerMonitor getMonitor(int ioid)

Get monitor by its IOID.

Parameters:

ioid - monitor IOID

Returns:

monitor with given IOID, null if there is no monitor with such IOID.

destroyAllMonitors

protected void destroyAllMonitors()

Destroy all registered monitors.

destroy

public void destroy()

Destory server channel. This method MUST BE called if this it is overriden.

printInfo

public void printInfo()
               throws IllegalStateException

Prints detailed information about the process variable to the standard output stream.

Throws:

IllegalStateException - if the context has been destroyed.

printInfo

public void printInfo(PrintStream out)
               throws IllegalStateException

Prints detailed information about the process variable to the specified output stream.

Parameters:

out - the output stream.

Throws:

IllegalStateException - if the context has been destroyed.