Package com.cosylab.epics.caj

Class CAJContext

java.lang.Object

gov.aps.jca.Context

com.cosylab.epics.caj.CAJContext

All Implemented Interfaces:

CAJConstants, CAContext, LoggerProvider, Configurable

public class CAJContext
extends Context
implements CAContext, CAJConstants, Configurable

Implementation of CAJ JCA Context.

Version:

$id$

Author:

Matej Sekoranja

Field Summary

Fields

Modifier and Type	Field	Description
protected String	addressList	A space-separated list of broadcast address for process variable name resolution.
protected boolean	autoAddressList	Define whether or not the network interfaces should be discovered at runtime.
protected Map	beaconHandlers	Beacon handler map.
protected float	beaconPeriod	Period in second between two beacon signals.
protected BroadcastTransport	broadcastTransport	Broadcast transport needed for channel searches.
protected CachedByteBufferAllocator	cachedBufferAllocator	Cached byte buffer allocator.
static String	CAJ_SINGLE_THREADED_MODEL	String value of the JVM property key to turn on single threaded model.
protected IntHashMap	channelsByCID	Map of channels (keys are CIDs).
protected Map	channelsByName	Map of channels (keys are names).
protected float	connectionTimeout	If the context doesn't see a beacon from a server that it is connected to for connectionTimeout seconds then a state-of-health message is sent to the server over TCP/IP.
protected CAConnector	connector	CA connector (creates CA virtual circuit).
protected ArrayList	contextExceptionListeners	List of context exception listeners.
protected ArrayList	contextMessageListeners	List of context message listeners.
protected EventDispatcher	eventDispatcher	Event dispatcher.
protected LeaderFollowersThreadPool	leaderFollowersThreadPool	Leader/followers thread pool.
protected Logger	logger	Context logger.
protected int	maxArrayBytes	Length in bytes of the maximum array size that may pass through CA.
protected float	maxSearchInterval	Maximum interval in seconds between CA search broadcasts.
ArrayList<CAJNameClient>	nameClients
protected String	nameServersList
protected IntHashMap	pendingResponseRequests	Map of pending response requests (keys are IOID).
protected Reactor	reactor	Reactor.
protected boolean	registrationConfirmed	Registration confirmation status.
protected int	repeaterPort	Port number for the repeater to listen to.
protected int	serverPort	Port number for the server to listen to.
protected Timer	timer	Timer.
protected CATransportRegistry	transportRegistry	CA transport (virtual circuit) registry.
static Version	VERSION	Version.

Fields inherited from interface com.cosylab.epics.caj.CAJConstants

CAJ_DEBUG, CAJ_STRIP_HOSTNAME

Constructor Summary

Constructors

Constructor	Description
CAJContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addContextExceptionListener(ContextExceptionListener l)	Add a ContextExceptionListener to this context.
void	addContextMessageListener(ContextMessageListener l)	Add a ContextMessageListener to this context.
void	attachCurrentThread()	Attach the calling thread to the list of threads allowed to access this context and all its channels.
void	beaconAnomalyNotify()	Called each time beacon anomaly is detected.
protected void	checkState()	Check context state and tries to establish necessary state.
void	configure(Configuration configuration)	Pass the Configuration to the Configurable class.
Channel	createChannel(String name, ConnectionListener l, short priority)	Create a new Channel using this context to access a process variable with a ConnectionListener to receive ConnectionEvent from the newly created Channel.
void	decrementPendingRequests(int usedSequenceNumberIO)	Decrement pending requests counter.
void	destroy()	Clear all ressources attached to this Context
void	destroyChannel(CAJChannel channel, boolean force)	Destroy channel.
void	flushIO()	Flush outstanding IO request to the servers.
String	getAddressList()	Get search address list.
CABeaconHandler	getBeaconHandler(InetSocketAddress responseFrom)	Get (and if necessary create) beacon handler.
float	getBeaconPeriod()	Get beacon period (in seconds).
int	getBroadcastPort()	Get broadcast port.
BroadcastTransport	getBroadcastTransport()	Broadcast transport.
CachedByteBufferAllocator	getCachedBufferAllocator()	Get cached byte allocator.
CAJChannel	getChannel(int channelID)	Searches for a channel with given channel ID.
CAJChannel	getChannel(String name, short priority, boolean acquire)	Searches for a channel with given channel name.
Channel[]	getChannels()	Get all channels of this context.
ChannelSearchManager	getChannelSearchManager()	Get channel search manager.
float	getConnectionTimeout()	Get connection timeout (in seconds).
ContextExceptionListener[]	getContextExceptionListeners()
ContextMessageListener[]	getContextMessageListeners()
EventDispatcher	getEventDispatcher()	Get event dispatcher.
int	getLastReceivedSequenceNumber(int seqNo)	Set last UDP recived sequence number.
LeaderFollowersThreadPool	getLeaderFollowersThreadPool()	Get LF thread pool.
Logger	getLogger()	Get logger.
int	getMaxArrayBytes()	Get max size of payload.
float	getMaxSearchInterval()	Get max.
Reactor	getReactor()	Get context reactor.
int	getRepeaterPort()	Get repeater port.
ResponseRequest	getResponseRequest(int ioid)	Searches for a response request with given channel IOID.
int	getServerPort()	Get server port.
Timer	getTimer()	Get timer.
CATransport	getTransport(TransportClient client, InetSocketAddress serverAddress, short minorRevision, short priority)	Get, or create if necessary, transport of given server address.
CATransportRegistry	getTransportRegistry()	Get CA transport (virtual circuit) registry.
String	getUserName()	Get user name (used to report to the server).
Version	getVersion()	Get context version.
int	incrementPendingRequests()	Increment pending requests counter.
void	initialize()
protected void	initializeLogger()	Initialize context logger.
void	invalidateLastReceivedSequence()	Invalidate last (UDP) received sequence.
boolean	isAutoAddressList()	Get auto search-list flag.
boolean	isDestroyed()	Get destruction status.
boolean	isDoNotShareChannels()
boolean	isInitialized()	Get initialization status.
boolean	isRegistrationConfirmed()	Get repeater registration status.
protected void	loadConfiguration()	Load configuration.
void	modifyUserName(String userName)	Modifies client username and notifies connected servers about it.
void	notifyException(ContextExceptionEvent event)	Notifies context listeners about exception.
void	pendEvent(double timeout)	Process all pending events.
void	pendIO(double timeout)	Process all pending IO operations.
void	poll()	Flush the send buffer and process any outstanding CA background activity.
void	printInfo(PrintStream out)	Prints detailed information about the Context to the specified output stream.
int	registerResponseRequest(ResponseRequest request)	Register response request.
void	removeContextExceptionListener(ContextExceptionListener l)	Removes a ContextExceptionListener from this context.
void	removeContextMessageListener(ContextMessageListener l)	Removes a ContextMessageListener from this context.
void	repeaterConfirm(InetSocketAddress responseFrom)	Repeater registration confirmation.
void	searchResponse(int cid, int sid, short type, int count, short minorRevision, InetSocketAddress serverAddress)	Search response from server (channel found).
void	setDoNotShareChannels(boolean doNotShareChannels)
void	setLastReceivedSequenceNumber(int seqNo)	Set last UDP recived sequence number.
boolean	testIO()	Tests if all synchronous (ie not specifying listeners) get and channel creation requests are completed.
ResponseRequest	unregisterResponseRequest(ResponseRequest request)	Unregister response request.

Methods inherited from class gov.aps.jca.Context

createChannel, createChannel, createChannel, dispose, printInfo

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final Version VERSION

Version.

CAJ_SINGLE_THREADED_MODEL

public static final String CAJ_SINGLE_THREADED_MODEL

String value of the JVM property key to turn on single threaded model.

See Also:

Constant Field Values

logger

protected Logger logger

Context logger.

addressList

protected String addressList

A space-separated list of broadcast address for process variable name resolution. Each address must be of the form: ip.number:port or host.name:port

autoAddressList

protected boolean autoAddressList

Define whether or not the network interfaces should be discovered at runtime.

nameServersList

protected String nameServersList

connectionTimeout

protected float connectionTimeout

If the context doesn't see a beacon from a server that it is connected to for connectionTimeout seconds then a state-of-health message is sent to the server over TCP/IP. If this state-of-health message isn't promptly replied to then the context will assume that the server is no longer present on the network and disconnect.

beaconPeriod

protected float beaconPeriod

Period in second between two beacon signals.

repeaterPort

protected int repeaterPort

Port number for the repeater to listen to.

serverPort

protected int serverPort

Port number for the server to listen to.

maxArrayBytes

protected int maxArrayBytes

Length in bytes of the maximum array size that may pass through CA.

maxSearchInterval

protected float maxSearchInterval

Maximum interval in seconds between CA search broadcasts. Default is 5 minutes.

contextMessageListeners

protected ArrayList contextMessageListeners

List of context message listeners.

contextExceptionListeners

protected ArrayList contextExceptionListeners

List of context exception listeners.

eventDispatcher

protected EventDispatcher eventDispatcher

Event dispatcher.

timer

protected Timer timer

Timer.

reactor

protected Reactor reactor

Reactor.

leaderFollowersThreadPool

protected LeaderFollowersThreadPool leaderFollowersThreadPool

Leader/followers thread pool.

registrationConfirmed

protected boolean registrationConfirmed

Registration confirmation status.

broadcastTransport

protected BroadcastTransport broadcastTransport

Broadcast transport needed for channel searches.

connector

protected CAConnector connector

CA connector (creates CA virtual circuit).

nameClients

public ArrayList<CAJNameClient> nameClients

transportRegistry

protected CATransportRegistry transportRegistry

CA transport (virtual circuit) registry. This registry contains all active transports - connections to CA servers.

cachedBufferAllocator

protected CachedByteBufferAllocator cachedBufferAllocator

Cached byte buffer allocator. Used by transports which as send buffers.

channelsByCID

protected IntHashMap channelsByCID

Map of channels (keys are CIDs).

channelsByName

protected Map channelsByName

Map of channels (keys are names).

pendingResponseRequests

protected IntHashMap pendingResponseRequests

Map of pending response requests (keys are IOID).

beaconHandlers

protected Map beaconHandlers

Beacon handler map.

Constructor Detail

CAJContext

public CAJContext()

Constructor.

Method Detail

getVersion

public Version getVersion()

Get context version.

Specified by:

getVersion in class Context

Returns:

version of the context implementation.

See Also:

Context.getVersion()

isDoNotShareChannels

public boolean isDoNotShareChannels()

setDoNotShareChannels

public void setDoNotShareChannels(boolean doNotShareChannels)

initializeLogger

protected void initializeLogger()

Initialize context logger.

loadConfiguration

protected void loadConfiguration()

Load configuration.

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Description copied from interface: Configurable

Pass the Configuration to the Configurable class. This method must always be called after the constructor and before any other method.

Specified by:

configure in interface Configurable

Parameters:

configuration - the class configurations.

Throws:

ConfigurationException - if an error occurs

See Also:

Configurable.configure(gov.aps.jca.configuration.Configuration)

getContextMessageListeners

public ContextMessageListener[] getContextMessageListeners()
                                                    throws IllegalStateException

Specified by:

getContextMessageListeners in class Context

Returns:

an array containing all ContextMessageListeners attached to this context.

Throws:

IllegalStateException - if the context has been destroyed.

See Also:

Context.getContextMessageListeners()

addContextMessageListener

public void addContextMessageListener(ContextMessageListener l)
                               throws CAException,
                                      IllegalStateException

Description copied from class: Context

Add a ContextMessageListener to this context.

Specified by:

addContextMessageListener in class Context

Parameters:

l - the listener to add

Throws:

IllegalStateException - if the context has been destroyed.

CAException

See Also:

Context.addContextMessageListener(gov.aps.jca.event.ContextMessageListener)

removeContextMessageListener

public void removeContextMessageListener(ContextMessageListener l)
                                  throws CAException,
                                         IllegalStateException

Description copied from class: Context

Removes a ContextMessageListener from this context.

Specified by:

removeContextMessageListener in class Context

Parameters:

l - the listener to remove

Throws:

IllegalStateException - if the context has been destroyed.

CAException

See Also:

Context.removeContextMessageListener(gov.aps.jca.event.ContextMessageListener)

getContextExceptionListeners

public ContextExceptionListener[] getContextExceptionListeners()
                                                        throws IllegalStateException

Specified by:

getContextExceptionListeners in class Context

Returns:

an array containing all ContextExceptionListeners attached to this context.

Throws:

IllegalStateException - if the context has been destroyed.

See Also:

Context.getContextExceptionListeners()

addContextExceptionListener

public void addContextExceptionListener(ContextExceptionListener l)
                                 throws CAException,
                                        IllegalStateException

Description copied from class: Context

Add a ContextExceptionListener to this context.

Specified by:

addContextExceptionListener in class Context

Parameters:

l - the listener to add

Throws:

IllegalStateException - if the context has been destroyed.

CAException

See Also:

Context.addContextExceptionListener(gov.aps.jca.event.ContextExceptionListener)

removeContextExceptionListener

public void removeContextExceptionListener(ContextExceptionListener l)
                                    throws CAException,
                                           IllegalStateException

Description copied from class: Context

Removes a ContextExceptionListener from this context.

Specified by:

removeContextExceptionListener in class Context

Parameters:

l - the listener to remove

Throws:

IllegalStateException - if the context has been destroyed.

CAException

See Also:

Context.removeContextExceptionListener(gov.aps.jca.event.ContextExceptionListener)

notifyException

public void notifyException(ContextExceptionEvent event)

Notifies context listeners about exception.

Parameters:

event - context exception event to be fired.

checkState

protected void checkState()
                   throws CAException,
                          IllegalStateException

Check context state and tries to establish necessary state.

Throws:

CAException - JCA Exception

IllegalStateException - IllegalStateException

initialize

public void initialize()
                throws CAException

Overrides:

initialize in class Context

Throws:

CAException

See Also:

Context.initialize()

destroy

public void destroy()
             throws CAException,
                    IllegalStateException

Description copied from class: Context

Clear all ressources attached to this Context

Specified by:

destroy in class Context

Throws:

IllegalStateException - if the context has been destroyed.

CAException

See Also:

Context.destroy()

createChannel

public Channel createChannel(String name,
                             ConnectionListener l,
                             short priority)
                      throws CAException,
                             IllegalStateException

Description copied from class: Context

Create a new Channel using this context to access a process variable with a ConnectionListener to receive ConnectionEvent from the newly created Channel.

Specified by:

createChannel in class Context

Parameters:

name - the process variable to connect to.

l - the ConnectionListener.

priority - channel process priority

Returns:

the new Channel.

Throws:

CAException - is thrown if a Channel Access error occured while creating the channel.

IllegalStateException - if the context has been destroyed.

See Also:

Context.createChannel(java.lang.String, gov.aps.jca.event.ConnectionListener, short)

destroyChannel

public void destroyChannel(CAJChannel channel,
                           boolean force)
                    throws CAException,
                           IllegalStateException

Destroy channel.

Parameters:

channel - CAJChannel

force - force destruction regardless of reference count

Throws:

CAException - force destruction regardless of reference count

IllegalStateException - Signals that a method has been invoked at an illegal or inappropriate time

getChannel

public CAJChannel getChannel(int channelID)

Searches for a channel with given channel ID.

Parameters:

channelID - CID.

Returns:

channel with given CID, null if non-existant.

getChannel

public CAJChannel getChannel(String name,
                             short priority,
                             boolean acquire)

Searches for a channel with given channel name.

Parameters:

name - channel name.

priority - channel priority.

acquire - whether to acquire ownership (increment ref. counting)

Returns:

channel with given name, null if non-existant.

getChannels

public Channel[] getChannels()

Description copied from class: Context

Get all channels of this context.

Specified by:

getChannels in class Context

Returns:

array of channels of this context.

See Also:

Context.getChannels()

pendIO

public void pendIO(double timeout)
            throws TimeoutException,
                   CAException,
                   IllegalStateException

Description copied from class: Context

Process all pending IO operations.

Specified by:

pendIO in class Context

Parameters:

timeout - the timeout limit.

Throws:

TimeoutException - if all the IO couldn't be processed.

CAException - if a Channel Exception error occured while processing IOs.

IllegalStateException - if the context has been destroyed.

See Also:

Context.pendIO(double)

testIO

public boolean testIO()
               throws CAException,
                      IllegalStateException

Description copied from class: Context

Tests if all synchronous (ie not specifying listeners) get and channel creation requests are completed. It will only test request and channel created after the last pendIO() call.

Specified by:

testIO in class Context

Returns:

true if all pending IO request have been processed. False otherwise.

Throws:

CAException - if a Channel Access error occured while testing IOs

IllegalStateException - if the context has been destroyed.

See Also:

Context.testIO()

pendEvent

public void pendEvent(double timeout)
               throws CAException,
                      IllegalStateException

Description copied from class: Context

Process all pending events.

Specified by:

pendEvent in class Context

Parameters:

timeout - the time during which the Context will process events.

Throws:

CAException - if a Channel Access error occured while pending events

IllegalStateException - if the context has been destroyed.

See Also:

Context.pendEvent(double)

poll

public void poll()
          throws CAException,
                 IllegalStateException

Description copied from class: Context

Flush the send buffer and process any outstanding CA background activity.

Specified by:

poll in class Context

Throws:

CAException - if a Channel Access error occured while testing IOs

IllegalStateException - if the context has been destroyed.

See Also:

Context.poll()

flushIO

public void flushIO()
             throws CAException,
                    IllegalStateException

Description copied from class: Context

Flush outstanding IO request to the servers.

Specified by:

flushIO in class Context

Throws:

CAException - if a Channel Access error occured while flushing IOs

IllegalStateException - if the context has been destroyed.

See Also:

Context.flushIO()

attachCurrentThread

public void attachCurrentThread()
                         throws CAException,
                                IllegalStateException

Description copied from class: Context

Attach the calling thread to the list of threads allowed to access this context and all its channels.

Specified by:

attachCurrentThread in class Context

Throws:

IllegalStateException - if the context has been destroyed. or if the context doesn't support multiple threads.

CAException

See Also:

Context.attachCurrentThread()

printInfo

public void printInfo(PrintStream out)
               throws IllegalStateException

Description copied from class: Context

Prints detailed information about the Context to the specified output stream.

Overrides:

printInfo in class Context

Parameters:

out - the output stream.

Throws:

IllegalStateException - if the context has been destroyed.

See Also:

Context.printInfo(java.io.PrintStream)

isInitialized

public boolean isInitialized()

Get initialization status.

Returns:

initialization status.

isDestroyed

public boolean isDestroyed()

Get destruction status.

Returns:

destruction status.

getAddressList

public String getAddressList()

Get search address list.

Returns:

get search address list.

isAutoAddressList

public boolean isAutoAddressList()

Get auto search-list flag.

Returns:

auto search-list flag.

getBeaconPeriod

public float getBeaconPeriod()

Get beacon period (in seconds).

Returns:

beacon period (in seconds).

getConnectionTimeout

public float getConnectionTimeout()

Get connection timeout (in seconds).

Returns:

connection timeout (in seconds).

getLogger

public Logger getLogger()

Get logger.

Specified by:

getLogger in interface LoggerProvider

Returns:

logger.

getMaxArrayBytes

public int getMaxArrayBytes()

Get max size of payload.

Returns:

max size of payload.

getRepeaterPort

public int getRepeaterPort()

Get repeater port.

Returns:

repeater port.

getServerPort

public int getServerPort()

Get server port.

Specified by:

getServerPort in interface CAContext

Returns:

server port.

getBroadcastPort

public int getBroadcastPort()

Get broadcast port.

Specified by:

getBroadcastPort in interface CAContext

Returns:

broadcast port.

getMaxSearchInterval

public float getMaxSearchInterval()

Get max. search interval

Returns:

max. search interval

getEventDispatcher

public final EventDispatcher getEventDispatcher()

Get event dispatcher.

Returns:

event dispatcher.

getReactor

public Reactor getReactor()

Get context reactor.

Specified by:

getReactor in interface CAContext

Returns:

context reactor.

getBroadcastTransport

public BroadcastTransport getBroadcastTransport()

Broadcast transport.

Specified by:

getBroadcastTransport in interface CAContext

Returns:

broadcast transport.

getTransportRegistry

public CATransportRegistry getTransportRegistry()

Get CA transport (virtual circuit) registry.

Specified by:

getTransportRegistry in interface CAContext

Returns:

CA transport (virtual circuit) registry.

getTimer

public Timer getTimer()

Get timer.

Specified by:

getTimer in interface CAContext

Returns:

timer.

getChannelSearchManager

public ChannelSearchManager getChannelSearchManager()

Get channel search manager.

Returns:

channel search manager.

getCachedBufferAllocator

public CachedByteBufferAllocator getCachedBufferAllocator()

Get cached byte allocator.

Specified by:

getCachedBufferAllocator in interface CAContext

Returns:

cached byte allocator.

getLeaderFollowersThreadPool

public LeaderFollowersThreadPool getLeaderFollowersThreadPool()

Get LF thread pool.

Specified by:

getLeaderFollowersThreadPool in interface CAContext

Returns:

LF thread pool, can be null if disabled.

isRegistrationConfirmed

public boolean isRegistrationConfirmed()

Get repeater registration status.

Returns:

repeater registration status.

repeaterConfirm

public void repeaterConfirm(InetSocketAddress responseFrom)

Repeater registration confirmation.

Parameters:

responseFrom - response from address.

beaconAnomalyNotify

public void beaconAnomalyNotify()

Called each time beacon anomaly is detected.

searchResponse

public void searchResponse(int cid,
                           int sid,
                           short type,
                           int count,
                           short minorRevision,
                           InetSocketAddress serverAddress)

Search response from server (channel found).

Parameters:

cid - client channel ID.

sid - server channel ID.

type - channel type code.

count - channel element count.

minorRevision - server minor CA revision.

serverAddress - server address.

getTransport

public CATransport getTransport(TransportClient client,
                                InetSocketAddress serverAddress,
                                short minorRevision,
                                short priority)

Get, or create if necessary, transport of given server address.

Parameters:

client - requesting connection (transport).

serverAddress - required transport address

minorRevision - transport revision to be used

priority - process priority.

Returns:

transport for given address

getResponseRequest

public ResponseRequest getResponseRequest(int ioid)

Searches for a response request with given channel IOID.

Parameters:

ioid - I/O ID.

Returns:

request response with given I/O ID.

registerResponseRequest

public int registerResponseRequest(ResponseRequest request)

Register response request.

Parameters:

request - request to register.

Returns:

request ID (IOID).

unregisterResponseRequest

public ResponseRequest unregisterResponseRequest(ResponseRequest request)

Unregister response request.

Parameters:

request - ResponseRequest

Returns:

removed object, can be null

incrementPendingRequests

public int incrementPendingRequests()

Increment pending requests counter.

Returns:

IO sequence number (pendIO sequence number).

decrementPendingRequests

public void decrementPendingRequests(int usedSequenceNumberIO)

Decrement pending requests counter.

Parameters:

usedSequenceNumberIO - IO sequence number returned by incrementPendingRequests

setLastReceivedSequenceNumber

public final void setLastReceivedSequenceNumber(int seqNo)

Set last UDP recived sequence number.

Parameters:

seqNo - last UDP recived sequence number.

getLastReceivedSequenceNumber

public final int getLastReceivedSequenceNumber(int seqNo)

Set last UDP recived sequence number.

Parameters:

seqNo - last UDP recived sequence number.

Returns:

last received sequence number

invalidateLastReceivedSequence

public final void invalidateLastReceivedSequence()

Description copied from interface: CAContext

Invalidate last (UDP) received sequence.

Specified by:

invalidateLastReceivedSequence in interface CAContext

See Also:

CAContext.invalidateLastReceivedSequence()

getBeaconHandler

public CABeaconHandler getBeaconHandler(InetSocketAddress responseFrom)

Get (and if necessary create) beacon handler.

Parameters:

responseFrom - remote source address of received beacon.

Returns:

beacon handler for particular server.

modifyUserName

public void modifyUserName(String userName)

Modifies client username and notifies connected servers about it.

Parameters:

userName - username

getUserName

public String getUserName()

Description copied from interface: CAContext

Get user name (used to report to the server).

Specified by:

getUserName in interface CAContext

Returns:

String username