Remoto - VFS: VFS_tcp_mount_directory Class Reference
Remoto - VFS
VFS_tcp_mount_directory Class Reference

A VFS_node_interface implementation used to route code requests to other VFS instances. More...

#include <VFS_tcp_mount_directory.h>

Inheritance diagram for VFS_tcp_mount_directory:
VFS_node_interface

Public Member Functions

 VFS_tcp_mount_directory (VFS_tcp_mount *mount)
 VFS_tcp_mount_directory constructor. More...
 
virtual VFS_nodecreate (QString type, QVariantMap env, QDomElement child)
 This node create()s nothing, it is used for code registration purposes. More...
 
virtual QStringList provides ()
 This node provide()s nothing, it is used for code registration purposes. More...
 
virtual void registerDirectory (QJsonObject d)
 Register entries to the code directory. More...
 
virtual void unregisterDirectory ()
 Unregister all entries in this directory. More...
 
- Public Member Functions inherited from VFS_node_interface
virtual ~VFS_node_interface ()
 
virtual QString arguments (QString type)
 Describe the arguments needed to create a node. More...
 
virtual QString code (QString nodename, QString libname, QString &error)
 Request code or other resource from a plugin bundle. More...
 
QString describe ()
 Describe all the nodes in a plugin. More...
 
virtual QString description (QString type)
 Descriptive text about an individual node. More...
 
virtual bool initialize ()
 The plugin initializer. More...
 
bool isRemote ()
 If a plugin represents a remote resource, this value will be true. More...
 
virtual bool licensed (QString type)
 A licensing mechanism for node creation. More...
 
VFS_noderemoteNode ()
 Return the node needed to satisfy a remote request. More...
 

Protected Attributes

QJsonObject _directory
 The directory of code registered to this node. More...
 
- Protected Attributes inherited from VFS_node_interface
bool _remote
 Does this plugin exist on another resource? More...
 
VFS_node_remoteNode
 The node responding to requests for remote resources. More...
 

Additional Inherited Members

- Protected Member Functions inherited from VFS_node_interface
 VFS_node_interface (VFS_node *remoteNode=nullptr)
 VFS_node_interface::VFS_node_interface. More...
 
QString argumentString (QMetaObject s)
 Format a constructor string based on a node's metadata object. More...
 

Detailed Description

A VFS_node_interface implementation used to route code requests to other VFS instances.

Definition at line 9 of file VFS_tcp_mount_directory.h.

Constructor & Destructor Documentation

◆ VFS_tcp_mount_directory()

VFS_tcp_mount_directory::VFS_tcp_mount_directory ( VFS_tcp_mount mount)

VFS_tcp_mount_directory constructor.

Parameters
mountThe owning VFS_tcp_mount

Definition at line 18 of file VFS_tcp_mount_directory.cpp.

Member Function Documentation

◆ create()

VFS_node * VFS_tcp_mount_directory::create ( QString  type,
QVariantMap  env,
QDomElement  child 
)
virtual

This node create()s nothing, it is used for code registration purposes.

Parameters
type
env
child
Returns
A nullptr

Reimplemented from VFS_node_interface.

Definition at line 41 of file VFS_tcp_mount_directory.cpp.

◆ provides()

QStringList VFS_tcp_mount_directory::provides ( )
virtual

This node provide()s nothing, it is used for code registration purposes.

Returns
An empty QStringList.

Reimplemented from VFS_node_interface.

Definition at line 28 of file VFS_tcp_mount_directory.cpp.

◆ registerDirectory()

void VFS_tcp_mount_directory::registerDirectory ( QJsonObject  d)
virtual

Register entries to the code directory.

Parameters
dThe directory to register

Definition at line 56 of file VFS_tcp_mount_directory.cpp.

◆ unregisterDirectory()

void VFS_tcp_mount_directory::unregisterDirectory ( )
virtual

Unregister all entries in this directory.

Definition at line 93 of file VFS_tcp_mount_directory.cpp.

Member Data Documentation

◆ _directory

QJsonObject VFS_tcp_mount_directory::_directory
protected

The directory of code registered to this node.

Definition at line 26 of file VFS_tcp_mount_directory.h.


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