Package uk.ac.gda.client.live.stream

Class LiveStreamConnection

java.lang.Object

uk.ac.gda.client.live.stream.LiveStreamConnection

All Implemented Interfaces:

AutoCloseable, IConnection, ILiveStreamConnection

public class LiveStreamConnection
extends Object
implements IConnection, ILiveStreamConnection

An instance of this class encapsulates a connection to a live stream, i.e. a camera, as defined by a CameraConfiguration and a StreamType.

Publishes OpenConnectionEvent when a connection is created

Instances of this class should be created using LiveStreamConnectionBuilder which will ensure it is attached to a stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LiveStreamConnection.IAxisChangeListener

Method Summary

Modifier and Type	Method	Description
void	addAxisMoveListener(LiveStreamConnection.IAxisChangeListener axisMoveListener)
void	addDataListenerToStream(org.eclipse.january.dataset.IDataListener listener)
org.eclipse.january.dataset.IDatasetConnector	connect()
void	disconnect()	Call to disconnect any resources which we no longer need.
boolean	equals(Object obj)
List<org.eclipse.january.dataset.IDataset>	getAxes()
CameraConfiguration	getCameraConfig()
UUID	getId()	Returns this connection unique id
org.eclipse.january.dataset.IDatasetConnector	getStream()
StreamType	getStreamType()
boolean	hasAxesProvider()
int	hashCode()
boolean	isConnected()	Returns whether this connection is connected.
void	removeAxisMoveListener(LiveStreamConnection.IAxisChangeListener axisMoveListener)
void	removeDataListenerFromStream(org.eclipse.january.dataset.IDataListener listener)
void	setStream(org.eclipse.january.dataset.IDatasetConnector stream)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.scanning.api.event.core.IConnection

close

Method Details

getId

public UUID getId()

Returns this connection unique id

Specified by:

getId in interface ILiveStreamConnection

Returns:

the UUID associated with this connection

connect

public org.eclipse.january.dataset.IDatasetConnector connect()
                                                      throws LiveStreamException

Throws:

LiveStreamException

disconnect

public void disconnect()
                throws LiveStreamException

Description copied from interface: IConnection

Call to disconnect any resources which we no longer need. The resource may have timed out so it might not be connected, in that case it silently returns. Note, that the method IConnection.close(), inherited from AutoCloseable calls this method, which means that if an object of a class implementing IConnection is used with a try-with-resources block this method will be called automatically when exiting that block.

Specified by:

disconnect in interface IConnection

Throws:

LiveStreamException

addAxisMoveListener

public void addAxisMoveListener(LiveStreamConnection.IAxisChangeListener axisMoveListener)

Specified by:

addAxisMoveListener in interface ILiveStreamConnection

removeAxisMoveListener

public void removeAxisMoveListener(LiveStreamConnection.IAxisChangeListener axisMoveListener)

Specified by:

removeAxisMoveListener in interface ILiveStreamConnection

addDataListenerToStream

public void addDataListenerToStream(org.eclipse.january.dataset.IDataListener listener)
                             throws LiveStreamException

Specified by:

addDataListenerToStream in interface ILiveStreamConnection

Throws:

LiveStreamException

removeDataListenerFromStream

public void removeDataListenerFromStream(org.eclipse.january.dataset.IDataListener listener)

Specified by:

removeDataListenerFromStream in interface ILiveStreamConnection

getCameraConfig

public CameraConfiguration getCameraConfig()

Specified by:

getCameraConfig in interface ILiveStreamConnection

getStreamType

public StreamType getStreamType()

Specified by:

getStreamType in interface ILiveStreamConnection

getAxes

public List<org.eclipse.january.dataset.IDataset> getAxes()

isConnected

public boolean isConnected()

Description copied from interface: IConnection

Returns whether this connection is connected. This method returns true until disconnect is called, even if the connection is created lazily.

Specified by:

isConnected in interface IConnection

Returns:

true if connected, false otherwise

hasAxesProvider

public boolean hasAxesProvider()

getStream

public org.eclipse.january.dataset.IDatasetConnector getStream()

setStream

public void setStream(org.eclipse.january.dataset.IDatasetConnector stream)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object