nds2.connection

All Implemented Interfaces:: Closeable, AutoCloseable

public class connection extends Object implements 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)

Field Summary

Fields

Modifier and Type

Field

Description

static final int

AUTO_STRIDE

static final int

DEFAULT_PORT

static final int

FAST_STRIDE

static final int

PROTOCOL_INVALID

static final int

PROTOCOL_ONE

static final int

PROTOCOL_TRY

static final int

PROTOCOL_TWO

protected boolean

swigCMemOwn
Constructor Summary

Constructors

Modifier

Constructor

Description

connection()

protected

connection(long cPtr, boolean cMemoryOwn)

connection(String host)

connection(String host, int port)

connection(String host, int port, int protocol)

connection(parameters params)
Method Summary

Modifier and Type

Method

Description

boolean

check(int gps_start, int gps_stop, String[] channel_names)

void

close()

long

countChannels()

long

countChannels(String channel_glob)

long

countChannels(String channel_glob, int channel_type_mask)

long

countChannels(String channel_glob, int channel_type_mask, int data_type_mask)

long

countChannels(String channel_glob, int channel_type_mask, int data_type_mask, double min_sample_rate)

long

countChannels(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, String[] channel_names)

protected void

finalize()

channel[]

findChannels()

channel[]

findChannels(String channel_glob)

channel[]

findChannels(String channel_glob, int channel_type_mask)

channel[]

findChannels(String channel_glob, int channel_type_mask, int data_type_mask)

channel[]

findChannels(String channel_glob, int channel_type_mask, int data_type_mask, double min_sample_rate)

channel[]

findChannels(String channel_glob, int channel_type_mask, int data_type_mask, double min_sample_rate, double max_sample_rate)

availability_list_type

getAvailability(String[] channel_names)

protected static long

getCPtr(connection obj)

epochs_type

getEpochs()

String

getHost()

String

getParameter(String parameter)

channel_names_type

getParameters()

int

getPort()

int

getProtocol()

SWIGTYPE_p_channel__hash_type

hash()

connection_iterator

iterate(int Start, int Stop, int Stride, String[] Channels)

connection_iterator

iterate(int Start, int Stop, String[] Channels)

connection_iterator

iterate(int Stride, String[] Channels)

connection_iterator

iterate(String[] Channels)

protected connection

iterate_base(int gps_start, int gps_stop, int stride, String[] channel_names)

protected connection

iterate_base(int gps_start, int gps_stop, String[] channel_names)

protected connection

iterate_base(int stride, String[] channel_names)

protected connection

iterate_base(String[] channel_names)

buffer[]

next()

parameters

parameters()

boolean

requestInProgress()

boolean

setEpoch(int gps_start, int gps_stop)

boolean

setEpoch(String epoch)

boolean

setParameter(String parameter, String value)

void

shutdown()

protected static long

swigRelease(connection obj)

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- swigCMemOwn
  
  protected transient boolean swigCMemOwn
- PROTOCOL_INVALID
  
  public static final int PROTOCOL_INVALID
- PROTOCOL_ONE
  
  public static final int PROTOCOL_ONE
- PROTOCOL_TWO
  
  public static final int PROTOCOL_TWO
- PROTOCOL_TRY
  
  public static final int PROTOCOL_TRY
- DEFAULT_PORT
  
  public static final int DEFAULT_PORT
- FAST_STRIDE
  
  public static final int FAST_STRIDE
- AUTO_STRIDE
  
  public static final int AUTO_STRIDE
Constructor Details
- connection
  
  protected connection(long cPtr, boolean cMemoryOwn)
- connection
  
  public connection(String host, int port, int protocol)
- connection
  
  public connection(String host, int port)
- connection
  
  public connection(String host)
- connection
  
  public connection(parameters params)
- connection
  
  public connection()
Method Details
- getCPtr
  
  protected static long getCPtr(connection obj)
- swigRelease
  
  protected static long swigRelease(connection obj)
- finalize
  
  protected void finalize()
  
  Overrides:
  
  finalize in class Object
- delete
  
  public void delete()
- iterate
  
  public connection_iterator iterate(String[] Channels) throws UnsupportedOperationException
  
  Throws:
  
  UnsupportedOperationException
- iterate
  
  public connection_iterator iterate(int Stride, String[] Channels) throws UnsupportedOperationException
  
  Throws:
  
  UnsupportedOperationException
- iterate
  
  public connection_iterator iterate(int Start, int Stop, String[] Channels) throws UnsupportedOperationException
  
  Throws:
  
  UnsupportedOperationException
- iterate
  
  public connection_iterator iterate(int Start, int Stop, int Stride, String[] Channels) throws UnsupportedOperationException
  
  Throws:
  
  UnsupportedOperationException
- close
  
  public void close()
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface Closeable
- countChannels
  
  public long countChannels(String channel_glob, int channel_type_mask, int data_type_mask, double min_sample_rate, double max_sample_rate)
- countChannels
  
  public long countChannels(String channel_glob, int channel_type_mask, int data_type_mask, double min_sample_rate)
- countChannels
  
  public long countChannels(String channel_glob, int channel_type_mask, int data_type_mask)
- countChannels
  
  public long countChannels(String channel_glob, int channel_type_mask)
- countChannels
  
  public long countChannels(String channel_glob)
- countChannels
  
  public long countChannels()
- findChannels
  
  public channel[] findChannels(String channel_glob, int channel_type_mask, int data_type_mask, double min_sample_rate, double max_sample_rate)
- findChannels
  
  public channel[] findChannels(String channel_glob, int channel_type_mask, int data_type_mask, double min_sample_rate)
- findChannels
  
  public channel[] findChannels(String channel_glob, int channel_type_mask, int data_type_mask)
- findChannels
  
  public channel[] findChannels(String channel_glob, int channel_type_mask)
- findChannels
  
  public channel[] findChannels(String channel_glob)
- findChannels
  
  public channel[] findChannels()
- getEpochs
  
  public epochs_type getEpochs()
- setEpoch
  
  public boolean setEpoch(String epoch)
- setEpoch
  
  public boolean setEpoch(int gps_start, int gps_stop)
- currentEpoch
  
  public epoch currentEpoch()
- check
  
  public boolean check(int gps_start, int gps_stop, String[] channel_names)
- fetch
  
  public buffer[] fetch(int gps_start, int gps_stop, String[] channel_names)
- getHost
  
  public String getHost()
- getPort
  
  public int getPort()
- getProtocol
  
  public int getProtocol()
- setParameter
  
  public boolean setParameter(String parameter, String value)
- getParameter
  
  public String getParameter(String parameter)
- getParameters
  
  public channel_names_type getParameters()
- parameters
  
  public parameters parameters()
- hash
  
  public SWIGTYPE_p_channel__hash_type hash()
- iterate_base
  
  protected connection iterate_base(int gps_start, int gps_stop, int stride, String[] channel_names)
- iterate_base
  
  protected connection iterate_base(String[] channel_names)
- iterate_base
  
  protected connection iterate_base(int stride, String[] channel_names)
- iterate_base
  
  protected connection iterate_base(int gps_start, int gps_stop, String[] channel_names)
- next
  
  public buffer[] next()
- requestInProgress
  
  public boolean requestInProgress()
- shutdown
  
  public void shutdown()
- getAvailability
  
  public availability_list_type getAvailability(String[] channel_names)

Class connection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

swigCMemOwn

PROTOCOL_INVALID

PROTOCOL_ONE

PROTOCOL_TWO

PROTOCOL_TRY

DEFAULT_PORT

FAST_STRIDE

AUTO_STRIDE

Constructor Details

connection

connection

connection

connection

connection

connection

Method Details

getCPtr

swigRelease

finalize

delete

iterate

iterate

iterate

iterate

close

countChannels

countChannels

countChannels

countChannels

countChannels

countChannels

findChannels

findChannels

findChannels

findChannels

findChannels

findChannels

getEpochs

setEpoch

setEpoch

currentEpoch

check

fetch

getHost

getPort

getProtocol

setParameter

getParameter

getParameters

parameters

hash

iterate_base

iterate_base

iterate_base

iterate_base

next

requestInProgress

shutdown

getAvailability