ConnectionProvider::FilesystemConnection Class Reference

class for filesystem connections; returns an object of type Qore::Dir; this can be used to monitor filesystem free space or to ensure a network filesystem is mounted, for example More...

Inheritance diagram for ConnectionProvider::FilesystemConnection:

Public Member Methods
deprecated	constructor (string name, string desc, string url, bool monitor, *hash opts, hash n_urlh)
	DEPRECATED: creates the FilesystemConnection object. More...
	constructor (string name, string description, string url, hash attributes={}, hash options={})
	creates the FilesystemConnection object More...
hash	getOptions ()
	gets options More...
string	getType ()
	returns "dir"
Public Member Methods inherited from ConnectionProvider::AbstractConnection
deprecated	constructor (string n_name, string n_desc, string n_url, bool n_monitor, *hash n_opts, hash n_urlh, *string n_safe_url, *bool n_enabled)
	creates the AbstractConnection object More...
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the AbstractConnection object More...
object	get (bool connect=True, *hash rtopts)
	returns the underlying connection object More...
hash< ConfigInfo >	getConfigHash ()
	returns a ConfigInfo hash of static configuration information about the connection More...
hash< ConnectionConstructorInfo >	getConstructorInfo ()
	returns a ConnectionConstructorInfo hash for creating the connection object dynamically More...
*hash	getDefaultOptions ()
	returns default options
hash< ConnectionInfo >	getInfo (bool with_password=False)
	returns a ConnectionInfo hash of information about the connection More...
*hash	getOptions ()
	returns static / initialization options
*hash	getRealOptions ()
	returns options for saving the connection's configuration information
*hash	getRuntimeOptions ()
	returns runtime options
auto	getTag (string tag)
	returns the value of the given tag or NOTHING if not present
auto	getTagEx (string tag)
	returns the value of the given tag or throws an exception if the tag is not set with a value More...
hash< auto >	getTags ()
	returns all tags associated with the connection
	parseTextOptions ()
	this method is called when parsing connection file definitions from text files when loading into the database More...
hash< PingInfo >	ping (bool throw_exception=False)
	returns a hash with the results of the ping operation More...
hash< auto >	validateOptions (hash< auto > options)
	performs options validation in the constructor More...

Static Public Member Methods
static deprecated FilesystemConnection	make (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	DEPRECATED: static constructor. More...

Public Attributes
const	OptionList = Options.keys()
	FilesystemConnection object connection option list.
const	Options
	FilesystemConnection object connection options.
Public Attributes inherited from ConnectionProvider::AbstractConnection
string	desc
	connection description
bool	enabled = True
	enabled/disabled indicator flag
date	last_check
	date/time of last check/ping
bool	locked = False
	locked/unlocked flag
bool	loopback = False
	set to True for loopback connections
bool	monitor
	monitoring flag
string	name
	connection name
*hash	opts
	connection options
*hash	orig_opts
	original connection options
string	safe_url
	"safe" URL (password information removed)
string	status = "not checked"
	status string; in case of a connection error this string will be the error string
hash< auto >	tags = {}
	connection tags; user-defined key-value pairs
bool	up = False
	connection status flag; set by monitoring or explicit pings/connections
date	updated
	date/time of last update
string	url
	connection URL (potentially with password info)
hash	urlh
	broken down URL hash (as returned by Qore::parse_url())

Private Member Methods
hash< ConnectionConstructorInfo >	getConstructorInfoImpl ()
	returns a hash that can be used to construct the object dynamically More...
Dir	getImpl (bool connect=True, *hash rtopts)
	returns a Qore::Dir object More...
Private Member Methods inherited from ConnectionProvider::AbstractConnection
string	getSafeUrl (hash< auto > urlh)
	creates a "safe" URL string with password information removed More...
hash< UrlInfo >	parseUrl (string url)
	Parse the URL to a hash. More...
hash< PingInfo >	pingIntern (hash< PingInfo > rv)
	performs the ping by executing get(); returns a PingInfo hash

Additional Inherited Members
Static Public Attributes inherited from ConnectionProvider::AbstractConnection
static *code	post_processing
	optional code for default post-processing of objects created by getImpl(); must take the object created and the connection name as arguments

Detailed Description

class for filesystem connections; returns an object of type Qore::Dir; this can be used to monitor filesystem free space or to ensure a network filesystem is mounted, for example

supports the following option:

• "readonly": does not mark the connection as down if the directory is read-only; use for example if the connection should point to a read-only base directory; interface directories should normally be writable

Member Function Documentation

constructor() [1/2]

deprecated ConnectionProvider::FilesystemConnection::constructor	(	string	name,
		string	desc,
		string	url,
		bool	monitor,
		*hash	opts,
		hash	n_urlh
	)

DEPRECATED: creates the FilesystemConnection object.

Parameters

name	the name of the connection
desc	connection description
url	connection URL
monitor	monitoring flag
opts	connection options
n_urlh	broken down URL hash (as returned by Qore::parse_url())

Deprecated:

since Qore 0.9

constructor() [2/2]

ConnectionProvider::FilesystemConnection::constructor	(	string	name,
		string	description,
		string	url,
		hash	attributes = {},
		hash	options = {}
	)

creates the FilesystemConnection object

Parameters

name	the name of the connection
description	connection description
url	connection URL (potentially with password info)
attributes	various attributes. See below
options	connection options

See AbstractConnection::constructor() for attributes and options reference.

getConstructorInfoImpl()

hash<ConnectionConstructorInfo> ConnectionProvider::FilesystemConnection::getConstructorInfoImpl ( )

privatevirtual

returns a hash that can be used to construct the object dynamically

Since

ConnectionProvider 1.1

Implements ConnectionProvider::AbstractConnection.

getImpl()

Dir ConnectionProvider::FilesystemConnection::getImpl ( bool  connect = True, *hash  rtopts  )

privatevirtual

returns a Qore::Dir object

Parameters

connect	if True, then the target directory is checked for existence and if it's writable, if either check fails, an exception is thrown
rtopts	this connection type does not accept any runtime option, so this parameter is ignored

Returns

a Qore::Dir object

Implements ConnectionProvider::AbstractConnection.

getOptions()

hash ConnectionProvider::FilesystemConnection::getOptions

(

)

gets options

Returns

returns a hash with the following supported option:

• "readonly": if True, does not mark the connection as down if the directory is read-only; use for example if the connection should point to a read-only base directory; interface directories should normally be writable (default: False)

make()

static deprecated FilesystemConnection ConnectionProvider::FilesystemConnection::make ( string  name, string  desc, string  url, bool  monitor, *hash  opts, hash  urlh  )

static

DEPRECATED: static constructor.

Deprecated:

since Qore 0.9 in favor of new constructor and Qore::Reflection