| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*-<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Copyright 2015, 2016 Diamond Light Source Ltd.<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * All rights reserved. This program and the accompanying materials<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * are made available under the terms of the Eclipse Public License v1.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * which accompanies this distribution, and is available at<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * http://www.eclipse.org/legal/epl-v10.html<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> */<a name="line.8"></a> |
| <span class="sourceLineNo">009</span><a name="line.9"></a> |
| <span class="sourceLineNo">010</span>package org.eclipse.january.dataset;<a name="line.10"></a> |
| <span class="sourceLineNo">011</span><a name="line.11"></a> |
| <span class="sourceLineNo">012</span>import java.util.concurrent.TimeUnit;<a name="line.12"></a> |
| <span class="sourceLineNo">013</span><a name="line.13"></a> |
| <span class="sourceLineNo">014</span>import org.eclipse.january.DatasetException;<a name="line.14"></a> |
| <span class="sourceLineNo">015</span><a name="line.15"></a> |
| <span class="sourceLineNo">016</span>/**<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * A dataset connector contains a lazy dataset which exists in a remote<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> * location. It uses a connection to the DataServer to provide the<a name="line.18"></a> |
| <span class="sourceLineNo">019</span> * implementation of the slicing required remotely.<a name="line.19"></a> |
| <span class="sourceLineNo">020</span> * <a name="line.20"></a> |
| <span class="sourceLineNo">021</span> * You may also listen to data changing in the dataset<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> */<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>public interface IDatasetConnector extends IFileConnection, IDynamicShape {<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span> /**<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * The dataset location/name in the file<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * @return Dataset name<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> */<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> public String getDatasetName();<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span> /**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * The dataset location/name in the file<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * @param datasetName<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> */<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> public void setDatasetName(String datasetName);<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> /**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * If set to true the DataServer will not cache the dataset. <a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * If left as false: if the data server can figure out that the <a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * file is writing, it will reshape. However it cannot always <a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * determine this depending on the file and what is writing to <a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * it (SWMR can write without changing date stamp for instance)<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * Setting this boolean ensures that a given path, never will<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * cache on the data server.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Default value is false for MJPG streams and true for standard<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * remote datasets.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @param expectWrite<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> public void setWritingExpected(boolean expectWrite);<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @return true if the remote dataset has been warned that writing is expected.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> public boolean isWritingExpected();<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> <a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> /**<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * Same as calling connect(500, TimeUnit.MILLISECOND)<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * <a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * Cannot will connect with the DataServer to start listening<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * to any updates to the file should it be written in the remote file system.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * When connect it called, the remote file must exist and the dataset properties<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * are read. These properties must not change in the file while you are connected.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * For instance if the file is ints when you connect, it must not change data class.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @return the name of the thread started to run the connection or null if each event<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * is driven from the event thread of the service (for instance web sockets provide the<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * thread and this runs the connection)<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <a name="line.72"></a> |
| <span class="sourceLineNo">073</span> */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> public String connect() throws DatasetException;<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> /**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * Cannot will connect with the DataServer to start listening<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * to any updates to the file should it be written in the remote file system.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * When connect it called, the remote file must exist and the dataset properties<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * are read. These properties must not change in the file while you are connected.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * For instance if the file is ints when you connect, it must not change data class.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @param time<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @param unit<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * @return the name of the thread started to run the connection or null if each event<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * is driven from the event thread of the service (for instance web sockets provide the<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * thread and this runs the connection)<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> */<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> public String connect(long time, TimeUnit unit) throws DatasetException;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> /**<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * Stops listening to the dataset changing and disconnects from the server.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * A remote dataset may be connected and disconnected multiple times.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> */<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> public void disconnect() throws DatasetException;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span>}<a name="line.96"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
