public class connection
extends java.lang.Object
implements java.io.Closeable
A connection to the NDS/NDS2 server
The connection object is used to interact with the NDS (v1 or v2) servers to retrieve
data and channel lists.
Connnection objects have a few main categories of methods:
1. Data retreival (fetch and iterate)
2. Channel listing (find_channels)
In addition there are methods designed to deal with the volume of data and channels in a NDS2 server:
1. Setting limits/epochs on requests (get_epoch, set_epoch, current_epoch)
2. Channel availability checking (get_availability)
Modifier and Type | Field and Description |
---|---|
static int |
AUTO_STRIDE |
static int |
DEFAULT_PORT |
static int |
FAST_STRIDE |
static int |
PROTOCOL_INVALID |
static int |
PROTOCOL_ONE |
static int |
PROTOCOL_TRY |
static int |
PROTOCOL_TWO |
protected boolean |
swigCMemOwn |
Modifier | Constructor and Description |
---|---|
|
connection() |
protected |
connection(long cPtr,
boolean cMemoryOwn) |
|
connection(parameters params) |
|
connection(java.lang.String host) |
|
connection(java.lang.String host,
int port) |
|
connection(java.lang.String host,
int port,
int protocol) |
Modifier and Type | Method and Description |
---|---|
boolean |
check(int gps_start,
int gps_stop,
java.lang.String[] channel_names) |
void |
close() |
long |
countChannels() |
long |
countChannels(java.lang.String channel_glob) |
long |
countChannels(java.lang.String channel_glob,
int channel_type_mask) |
long |
countChannels(java.lang.String channel_glob,
int channel_type_mask,
int data_type_mask) |
long |
countChannels(java.lang.String channel_glob,
int channel_type_mask,
int data_type_mask,
double min_sample_rate) |
long |
countChannels(java.lang.String channel_glob,
int channel_type_mask,
int data_type_mask,
double min_sample_rate,
double max_sample_rate) |
epoch |
currentEpoch() |
void |
delete() |
buffer[] |
fetch(int gps_start,
int gps_stop,
java.lang.String[] channel_names) |
protected void |
finalize() |
channel[] |
findChannels() |
channel[] |
findChannels(java.lang.String channel_glob) |
channel[] |
findChannels(java.lang.String channel_glob,
int channel_type_mask) |
channel[] |
findChannels(java.lang.String channel_glob,
int channel_type_mask,
int data_type_mask) |
channel[] |
findChannels(java.lang.String channel_glob,
int channel_type_mask,
int data_type_mask,
double min_sample_rate) |
channel[] |
findChannels(java.lang.String channel_glob,
int channel_type_mask,
int data_type_mask,
double min_sample_rate,
double max_sample_rate) |
availability_list_type |
getAvailability(java.lang.String[] channel_names) |
protected static long |
getCPtr(connection obj) |
epochs_type |
getEpochs() |
java.lang.String |
getHost() |
java.lang.String |
getParameter(java.lang.String parameter) |
channel_names_type |
getParameters() |
int |
getPort() |
int |
getProtocol() |
SWIGTYPE_p_channel__hash_type |
hash() |
protected connection |
iterate_base(int gps_start,
int gps_stop,
int stride,
java.lang.String[] channel_names) |
protected connection |
iterate_base(int gps_start,
int gps_stop,
java.lang.String[] channel_names) |
protected connection |
iterate_base(int stride,
java.lang.String[] channel_names) |
protected connection |
iterate_base(java.lang.String[] channel_names) |
connection_iterator |
iterate(int Start,
int Stop,
int Stride,
java.lang.String[] Channels) |
connection_iterator |
iterate(int Start,
int Stop,
java.lang.String[] Channels) |
connection_iterator |
iterate(int Stride,
java.lang.String[] Channels) |
connection_iterator |
iterate(java.lang.String[] Channels) |
buffer[] |
next() |
parameters |
parameters() |
boolean |
requestInProgress() |
boolean |
setEpoch(int gps_start,
int gps_stop) |
boolean |
setEpoch(java.lang.String epoch) |
boolean |
setParameter(java.lang.String parameter,
java.lang.String value) |
void |
shutdown() |
protected transient boolean swigCMemOwn
public static final int PROTOCOL_INVALID
public static final int PROTOCOL_ONE
public static final int PROTOCOL_TWO
public static final int PROTOCOL_TRY
public static final int DEFAULT_PORT
public static final int FAST_STRIDE
public static final int AUTO_STRIDE
protected connection(long cPtr, boolean cMemoryOwn)
public connection(java.lang.String host, int port, int protocol)
public connection(java.lang.String host, int port)
public connection(java.lang.String host)
public connection(parameters params)
public connection()
protected static long getCPtr(connection obj)
protected void finalize()
finalize
in class java.lang.Object
public void delete()
public connection_iterator iterate(java.lang.String[] Channels) throws java.lang.UnsupportedOperationException
java.lang.UnsupportedOperationException
public connection_iterator iterate(int Stride, java.lang.String[] Channels) throws java.lang.UnsupportedOperationException
java.lang.UnsupportedOperationException
public connection_iterator iterate(int Start, int Stop, java.lang.String[] Channels) throws java.lang.UnsupportedOperationException
java.lang.UnsupportedOperationException
public connection_iterator iterate(int Start, int Stop, int Stride, java.lang.String[] Channels) throws java.lang.UnsupportedOperationException
java.lang.UnsupportedOperationException
public void close()
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
public long countChannels(java.lang.String channel_glob, int channel_type_mask, int data_type_mask, double min_sample_rate, double max_sample_rate)
public long countChannels(java.lang.String channel_glob, int channel_type_mask, int data_type_mask, double min_sample_rate)
public long countChannels(java.lang.String channel_glob, int channel_type_mask, int data_type_mask)
public long countChannels(java.lang.String channel_glob, int channel_type_mask)
public long countChannels(java.lang.String channel_glob)
public long countChannels()
public channel[] findChannels(java.lang.String channel_glob, int channel_type_mask, int data_type_mask, double min_sample_rate, double max_sample_rate)
public channel[] findChannels(java.lang.String channel_glob, int channel_type_mask, int data_type_mask, double min_sample_rate)
public channel[] findChannels(java.lang.String channel_glob, int channel_type_mask, int data_type_mask)
public channel[] findChannels(java.lang.String channel_glob, int channel_type_mask)
public channel[] findChannels(java.lang.String channel_glob)
public channel[] findChannels()
public epochs_type getEpochs()
public boolean setEpoch(java.lang.String epoch)
public boolean setEpoch(int gps_start, int gps_stop)
public epoch currentEpoch()
public boolean check(int gps_start, int gps_stop, java.lang.String[] channel_names)
public buffer[] fetch(int gps_start, int gps_stop, java.lang.String[] channel_names)
public java.lang.String getHost()
public int getPort()
public int getProtocol()
public boolean setParameter(java.lang.String parameter, java.lang.String value)
public java.lang.String getParameter(java.lang.String parameter)
public channel_names_type getParameters()
public parameters parameters()
public SWIGTYPE_p_channel__hash_type hash()
protected connection iterate_base(int gps_start, int gps_stop, int stride, java.lang.String[] channel_names)
protected connection iterate_base(java.lang.String[] channel_names)
protected connection iterate_base(int stride, java.lang.String[] channel_names)
protected connection iterate_base(int gps_start, int gps_stop, java.lang.String[] channel_names)
public buffer[] next()
public boolean requestInProgress()
public void shutdown()
public availability_list_type getAvailability(java.lang.String[] channel_names)