org.epics.pvmanager.test

Class MockDataSource

java.lang.Object

org.epics.pvmanager.DataSource

org.epics.pvmanager.test.MockDataSource

public class MockDataSource
extends DataSource

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
MockDataSource()

Method Summary

Methods

Modifier and Type	Method and Description
void	connectRead(ReadRecipe recipe) Connects to a set of channels based on the given recipe.
void	connectWrite(WriteRecipe writeRecipe) Prepares the channels defined in the write recipe for writes.
protected ChannelHandler	createChannel(String channelName) Creates a channel handler for the given name.
void	disconnectRead(ReadRecipe recipe) Disconnects the set of channels given by the recipe.
void	disconnectWrite(WriteRecipe writeRecipe) Releases the resources associated with the given write recipe.
List<ChannelReadRecipe>	getConnectedReadRecipes()
List<ChannelWriteRecipe>	getConnectedWriteRecipes()
ReadRecipe	getReadRecipe()
WriteRecipe	getWriteRecipe()
WriteRecipe	getWriteRecipeForWrite()
void	write(WriteRecipe writeRecipe, Runnable callback, ExceptionHandler exceptionHandler) Writes the contents in the given write recipe to the channels of this data sources.

Methods inherited from class org.epics.pvmanager.DataSource

channelHandlerLookupName, channelHandlerRegisterName, close, getChannels, isWriteable

Methods inherited from class java.lang.Object

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

Constructor Detail

MockDataSource

public MockDataSource()

Method Detail

createChannel

protected ChannelHandler createChannel(String channelName)

Description copied from class: DataSource

Creates a channel handler for the given name. In the simplest case, this is the only method a data source needs to implement.

Specified by:

createChannel in class DataSource

Parameters:

channelName - the name for a new channel

Returns:

a new handler

connectRead

public void connectRead(ReadRecipe recipe)

Description copied from class: DataSource

Connects to a set of channels based on the given recipe.

The data source must update the value caches relative to each channel. Before updating any cache, it must lock the collector relative to that cache and after any update it must notify the collector.

Overrides:

connectRead in class DataSource

Parameters:

recipe - the instructions for the data connection

disconnectRead

public void disconnectRead(ReadRecipe recipe)

Description copied from class: DataSource

Disconnects the set of channels given by the recipe.

The disconnect call is guaranteed to be given the same object, so that the recipe itself can be used as a key in a map to retrieve the list of resources needed to be closed.

Overrides:

disconnectRead in class DataSource

Parameters:

recipe - the instructions for the data connection

connectWrite

public void connectWrite(WriteRecipe writeRecipe)

Description copied from class: DataSource

Prepares the channels defined in the write recipe for writes.

If these are channels over the network, it will create the network connections with the underlying libraries.

Overrides:

connectWrite in class DataSource

Parameters:

writeRecipe - the recipe that will contain the write data

disconnectWrite

public void disconnectWrite(WriteRecipe writeRecipe)

Description copied from class: DataSource

Releases the resources associated with the given write recipe.

Will close network channels and deallocate memory needed.

Overrides:

disconnectWrite in class DataSource

Parameters:

writeRecipe - the recipe that will no longer be used

write

public void write(WriteRecipe writeRecipe,
         Runnable callback,
         ExceptionHandler exceptionHandler)

Description copied from class: DataSource

Writes the contents in the given write recipe to the channels of this data sources.

The write recipe needs to be first prepared with DataSource.connectWrite(org.epics.pvmanager.WriteRecipe) and then cleaned up with DataSource.disconnectWrite(org.epics.pvmanager.WriteRecipe).

Overrides:

write in class DataSource

Parameters:

writeRecipe - the recipe containing the data to write

callback - function to call when the write is concluded

exceptionHandler - where to report the exceptions

getReadRecipe

public ReadRecipe getReadRecipe()

getWriteRecipe

public WriteRecipe getWriteRecipe()

getWriteRecipeForWrite

public WriteRecipe getWriteRecipeForWrite()

getConnectedReadRecipes

public List<ChannelReadRecipe> getConnectedReadRecipes()

getConnectedWriteRecipes

public List<ChannelWriteRecipe> getConnectedWriteRecipes()