libdap Updated for version 3.21.1
libdap4 is an implementation of OPeNDAP's DAP protocol.
libdap::D4Connect Class Reference

#include <D4Connect.h>

Collaboration diagram for libdap::D4Connect:
Collaboration graph

Suppress the C++ defaults for these.

 D4Connect ()
 
 D4Connect (const D4Connect &)
 
D4Connectoperator= (const D4Connect &)
 
 D4Connect (const std::string &url, std::string uname="", std::string password="")
 Create an instance of Connect.
 
virtual ~D4Connect ()
 
bool is_local () const
 
virtual std::string URL () const
 
virtual std::string CE () const
 
void set_credentials (std::string u, std::string p)
 Set the credentials for responding to challenges while dereferencing URLs.
 
void set_accept_deflate (bool deflate)
 
void set_xdap_protocol (int major, int minor)
 
void set_cache_enabled (bool enabled)
 
bool is_cache_enabled ()
 
void set_xdap_accept (int major, int minor)
 
std::string get_version ()
 
std::string get_protocol ()
 
virtual void request_dmr (DMR &dmr, const std::string expr="")
 
virtual void request_dap4_data (DMR &dmr, const std::string expr="")
 
virtual void read_dmr (DMR &dmr, Response &rs)
 
virtual void read_dmr_no_mime (DMR &dmr, Response &rs)
 
virtual void read_data (DMR &data, Response &rs)
 
virtual void read_data_no_mime (DMR &data, Response &rs)
 

Detailed Description

Definition at line 39 of file D4Connect.h.

Constructor & Destructor Documentation

◆ D4Connect() [1/3]

libdap::D4Connect::D4Connect ( )
protected

◆ D4Connect() [2/3]

libdap::D4Connect::D4Connect ( const D4Connect & )
protected

◆ D4Connect() [3/3]

libdap::D4Connect::D4Connect ( const std::string & url,
std::string uname = "",
std::string password = "" )

Create an instance of Connect.

The D4Connect constructor requires a URL or local file.

Parameters
nThe URL for the virtual connection.
unameUse this username for authentication. Null by default.
passwordPassword to use for authentication. Null by default.

Definition at line 235 of file D4Connect.cc.

◆ ~D4Connect()

libdap::D4Connect::~D4Connect ( )
virtual

Definition at line 274 of file D4Connect.cc.

Member Function Documentation

◆ CE()

virtual std::string libdap::D4Connect::CE ( ) const
inlinevirtual

Definition at line 72 of file D4Connect.h.

◆ get_protocol()

std::string libdap::D4Connect::get_protocol ( )
inline

Return the DAP protocol version of the most recent response. Before a response is made, this contains the std::string "2.0."

Definition at line 97 of file D4Connect.h.

◆ get_version()

std::string libdap::D4Connect::get_version ( )
inline

Return the protocol/implementation version of the most recent response. This is a poorly designed method, but it returns information that is useful when used correctly. Before a response is made, this contains the std::string "unknown." This should ultimately hold the protocol version; it currently holds the implementation version.

@see get_protocol()
@deprecated 

Definition at line 92 of file D4Connect.h.

◆ is_cache_enabled()

bool libdap::D4Connect::is_cache_enabled ( )

Definition at line 492 of file D4Connect.cc.

◆ is_local()

bool libdap::D4Connect::is_local ( ) const
inline

Definition at line 69 of file D4Connect.h.

◆ operator=()

D4Connect & libdap::D4Connect::operator= ( const D4Connect & )
protected

◆ read_data()

void libdap::D4Connect::read_data ( DMR & data,
Response & rs )
virtual

Definition at line 432 of file D4Connect.cc.

◆ read_data_no_mime()

void libdap::D4Connect::read_data_no_mime ( DMR & data,
Response & rs )
virtual

Definition at line 440 of file D4Connect.cc.

◆ read_dmr()

void libdap::D4Connect::read_dmr ( DMR & dmr,
Response & rs )
virtual

Definition at line 408 of file D4Connect.cc.

◆ read_dmr_no_mime()

void libdap::D4Connect::read_dmr_no_mime ( DMR & dmr,
Response & rs )
virtual

Definition at line 416 of file D4Connect.cc.

◆ request_dap4_data()

void libdap::D4Connect::request_dap4_data ( DMR & dmr,
const std::string expr = "" )
virtual

Definition at line 345 of file D4Connect.cc.

◆ request_dmr()

void libdap::D4Connect::request_dmr ( DMR & dmr,
const std::string expr = "" )
virtual

Definition at line 305 of file D4Connect.cc.

◆ set_accept_deflate()

void libdap::D4Connect::set_accept_deflate ( bool deflate)

Set the accept deflate property.

Parameters
deflateTrue if the client can accept compressed responses, False otherwise.

Definition at line 469 of file D4Connect.cc.

◆ set_cache_enabled()

void libdap::D4Connect::set_cache_enabled ( bool cache)

Disable any further use of the client-side cache. In a future version of this software, this should be handled so that the www library is not initialized with the cache running by default.

Definition at line 487 of file D4Connect.cc.

◆ set_credentials()

void libdap::D4Connect::set_credentials ( std::string u,
std::string p )

Set the credentials for responding to challenges while dereferencing URLs.

Parameters
uThe username.
pThe password.
See also
extract_auth_info()

Definition at line 461 of file D4Connect.cc.

◆ set_xdap_accept()

void libdap::D4Connect::set_xdap_accept ( int major,
int minor )

◆ set_xdap_protocol()

void libdap::D4Connect::set_xdap_protocol ( int major,
int minor )

Set the XDAP-Accept property/header. This is used to send to a server the (highest) DAP protocol version number that this client understands.

Parameters
majorThe client dap protocol major version
minorThe client dap protocol minor version

Definition at line 479 of file D4Connect.cc.

◆ URL()

virtual std::string libdap::D4Connect::URL ( ) const
inlinevirtual

Definition at line 71 of file D4Connect.h.


The documentation for this class was generated from the following files: