#include <VFS_tcp_client.h>

Inheritance diagram for VFS_tcp_client:

Public Slots
virtual void	close ()
	DOCME. More...

virtual void	init ()
	DOCME. More...

void	initSSL ()
	DOCME. More...

void	readyRead ()
	DOCME. More...

Public Slots inherited from VFS_node
virtual void	applyDiff (VFS_request *r)
	Apply a diff received via subscription. More...

virtual void	executeRequest (VFS_request *t)
	Based on the VFS_request::requestType, execute the function associated with an operation. More...

void	notifySubscribers (VFS_node origin, VFS_request t)
	Propagate a diff to subscribers. More...

virtual void	receiveResponse (VFS_request *t)
	Once a VFS_request has been completed, a response will be issued back to its _origin. More...

void	remove (bool andDelete)
	Remove a child node. More...

virtual void	remove (VFS_node node=nullptr, QString name=nullptr, QString user="server")
	Remove a child node from this node. More...

virtual void	subtreeRequest (VFS_request *t)
	find() the target of a VFS_request, and execute the request More...

virtual void	unsubscribeAll (VFS_node *n)
	Remove all references to a subscriber from this node. More...

Signals
void	connected ()
	Emitted when a connection has been made. More...

void	disconnected ()
	Emitted when a connection has been lost. More...

void	error (QAbstractSocket::SocketError)
	Emitted when a socket error occurs. More...

void	moreToRead ()
	Emitted when an incoming message has additional data. More...

void	readyMessage (QByteArray message)
	Emitted when a message is ready for processing. More...

Signals inherited from VFS_node
void	diff (VFS_node origin, VFS_request t)
	Emit a diff, which will trigger notifySubscribers() for a mounted node. More...

void	finished (bool andDelete=false)
	Emitted if a thread fails to create its node, or a node is rm()'d, or any other reason a node has completed its lifecycle. It is deleted if `andDelete==true`. More...

void	mounted ()
	Emitted when a node is mount()ed. More...

void	unmounted (VFS_node *self)
	Emitted when a node is unmount()ed. More...

Public Member Functions
	VFS_tcp_client (QString address, quint16 port, bool ssl=false, QString sslCertPath="")
	VFS_tcp_client constructor for client mode. More...

	VFS_tcp_client (QTcpSocket *socket, bool ssl=false, QSslConfiguration sslConfiguration=QSslConfiguration())
	VFS_tcp_client constructor for client mode. More...

	VFS_tcp_client (QTcpSocket *socket, bool ssl=false, QString sslCertPath="")
	VFS_tcp_client constructor for server mode. More...

virtual	~VFS_tcp_client ()

virtual bool	isContainer ()
	DOCME. More...

virtual QString	reportDetails ()
	Report data about this client. More...

virtual void	write (VFS_request *r)
	DOCME. More...

virtual void	writeMessage (QByteArray data)
	DOCME. More...

Public Member Functions inherited from VFS_node
Q_INVOKABLE	VFS_node ()
	The VFS_node constructor will add its instance to the VFS_node::__allNodes global node registry, observing thread safety rules. More...

virtual	~VFS_node ()
	VFS_node destructor. More...

virtual VFS_node *	append (QString name, VFS_node *node, bool containerCheck=true, QString user="server")
	Append a VFS_node as a child of this node. More...

QString	className ()
	Return the class name of a node. More...

virtual VFS_request *	createRequest (VFS_request::requestType type, QString path, QString user="unknown", QJsonDocument data=QJsonDocument(), QJsonObject metadata=QJsonObject(), bool dontDelete=false)
	Create a new VFS_request with this object as _origin. More...

VFS_node *	find (QString path)
	Find a node by string path. More...

virtual VFS_node *	find (VFS_request *r)
	Find a node using a VFS_request. More...

VFS_node *	findChildWithName (QString name)
	Check if a child with a given name exists. More...

virtual VFS_node *	mount ()
	Mount this node. More...

QString	uniqueChildName (QString name)
	Generate a unique child name. More...

virtual VFS_node *	unmount ()
	Unmount this node. More...

virtual bool	validChildName (QString name)
	Check if a node name is valid. More...

Protected Slots
void	modeChanged (QSslSocket::SslMode mode)
	A slot for when the SSL mode has changed. More...

void	peerVerifyError (const QSslError &error)
	VFS_tcp_client::peerVerifyError. More...

void	sslErrors (const QList< QSslError > &errors)
	VFS_tcp_client::sslErrors. More...

void	sslReady ()
	Signal that an SSL connnection has been established. More...

Protected Attributes
QString	_address
	The address resolved by peerAddress(), or the address to connect to. More...

bool	_initialized
	Has this node been initialized? More...

MESSAGE_SIZE	_messageSize
	The message size received. Will wait for this many bytes before emitting messageReady. More...

quint16	_port
	The port to connect to. More...

QTcpSocket *	_socket
	The socket connection. More...

bool	_ssl
	Use ssl? More...

QString	_sslCertPath
	ssl cert file path. More...

Protected Attributes inherited from VFS_node
VFS_children	_children
	This node's children. More...

QMutex	_lock
	A recursive mutex that is local to this node. More...

VFS_subscriptionType	_subscribers
	This node's subscribers. These subscribers will receive diff notifications. More...

Friends
class	VFS_tcp_server

Additional Inherited Members
Static Public Member Functions inherited from VFS_node
static bool	__isNode (VFS_node *)
	Check to see if a node is in the global registry. More...

static QString	code (QString nodename, QString libname, QString &error)
	Fetch code or any other resource from a node. More...

Protected Member Functions inherited from VFS_node
virtual void	aclDefaults (VFS_request *r)
	Return default values and features associated wth this node. More...

void	addACLDefault (QJsonObject &acl, bool value, QString description="")
	Add a default value to the acl object. More...

void	addACLFeature (QJsonObject &acl, QString feature, bool value, QString description="")
	Add a feature to the acl object. More...

void	addACLFeatureGroup (QJsonObject &acl, QString feature, QString group, bool value)
	Add a feature group to the acl object. More...

void	addACLFeatureUser (QJsonObject &acl, QString feature, QString user, bool value)
	Add a feature user to the acl object. More...

void	addACLGroup (QJsonObject &acl, QString group, bool value)
	Add a group to the acl object. More...

void	addACLUser (QJsonObject &acl, QString user, bool value)
	Add a user to the acl object. More...

virtual QByteArray	icon ()
	Fetch the icon for a node. More...

virtual void	issueRequest (VFS_node target, VFS_request t)
	Issue a VFS_request to its target. More...

virtual void	issueRequest (VFS_request *t)
	A convenience function. More...

virtual void	issueResponse (VFS_request *t)
	Once a request has been completed, issue a response. More...

virtual void	ls (VFS_request *r)
	List the contents of this node. More...

virtual void	metadata (VFS_request *r)
	Fetch the metadata of this node. More...

virtual void	read (VFS_request *r)
	Return the data contents of this node, or if it's a container call ls() More...

virtual void	releaseLock (VFS_request *r)
	Release a lock on this node. More...

virtual void	report (VFS_request *r)
	Report debugging information about the current state of this node. More...

virtual void	requestLock (VFS_request *r)
	Request a lock on this node. More...

virtual void	rm (VFS_request *r)
	Remove a child entry from a node, or the node itself. More...

virtual void	submit (VFS_request *r)
	Submit a diff to a node. More...

virtual void	subscribe (VFS_request *r)
	Add an entry to this node's _subscription list. More...

virtual void	unsubscribe (VFS_request *r)
	Remove an entry from this node's _subscription list. More...

virtual void	unsubscribePath (QString path)
	Unsubscribe all references to a subpath. More...

Detailed Description

DOCME.

Definition at line 18 of file VFS_tcp_client.h.

Constructor & Destructor Documentation

◆ VFS_tcp_client() [1/3]

VFS_tcp_client::VFS_tcp_client	(	QTcpSocket *	socket,
		bool	ssl = `false`,
		QSslConfiguration	sslConfiguration = `QSslConfiguration()`
	)

explicit

VFS_tcp_client constructor for client mode.

Parameters

socket	The socket returned by a QTcpServer's nextPendingConnection()
ssl	Use ssl?
sslConfiguration	The QSslConfiguration, probably passed from a server

This is for VFS_tcp_client subclasses like VFS_tcp_export, where the socket is constructed by a config file.

Definition at line 144 of file VFS_tcp_client.cpp.

◆ VFS_tcp_client() [2/3]

VFS_tcp_client::VFS_tcp_client	(	QTcpSocket *	socket,
		bool	ssl = `false`,
		QString	sslCertPath = `""`
	)

explicit

VFS_tcp_client constructor for server mode.

Parameters

socket	The socket returned by a QTcpServer's nextPendingConnection()
ssl	Use ssl?
sslCertPath	The sslCertPath on the local filesystem

This is for VFS_tcp_client subclasses returned by a server's VFS_tcp_server::newClient()

Definition at line 27 of file VFS_tcp_client.cpp.

◆ VFS_tcp_client() [3/3]

VFS_tcp_client::VFS_tcp_client	(	QString	address,
		quint16	port,
		bool	ssl = `false`,
		QString	sslCertPath = `""`
	)

explicit

VFS_tcp_client constructor for client mode.

Parameters

address	The address to connect to
port	The port to connect to
ssl	Use ssl?
sslCertPath	The sslCertPath on the local filesystem

This is for VFS_tcp_client subclasses like VFS_tcp_export, where the socket is constructed by a config file.

Definition at line 82 of file VFS_tcp_client.cpp.

◆ ~VFS_tcp_client()

VFS_tcp_client::~VFS_tcp_client ( )

virtual

Definition at line 184 of file VFS_tcp_client.cpp.

Member Function Documentation

◆ close

void VFS_tcp_client::close ( )

virtualslot

DOCME.

Definition at line 271 of file VFS_tcp_client.cpp.

◆ connected

void VFS_tcp_client::connected ( )

signal

Emitted when a connection has been made.

◆ disconnected

void VFS_tcp_client::disconnected ( )

signal

Emitted when a connection has been lost.

◆ error

void VFS_tcp_client::error ( QAbstractSocket::SocketError )

signal

Emitted when a socket error occurs.

◆ init

void VFS_tcp_client::init ( )

virtualslot

DOCME.

Definition at line 196 of file VFS_tcp_client.cpp.

◆ initSSL

void VFS_tcp_client::initSSL ( )

slot

DOCME.

Definition at line 230 of file VFS_tcp_client.cpp.

◆ isContainer()

bool VFS_tcp_client::isContainer ( )

virtual

DOCME.

Returns

Reimplemented from VFS_node.

Reimplemented in VFS_tcp_mount.

Definition at line 367 of file VFS_tcp_client.cpp.

◆ modeChanged

void VFS_tcp_client::modeChanged ( QSslSocket::SslMode mode )

protectedslot

A slot for when the SSL mode has changed.

Parameters

mode	The new SSL mode

This is for subclasses, but is currently unused.

Definition at line 416 of file VFS_tcp_client.cpp.

◆ moreToRead

void VFS_tcp_client::moreToRead ( )

signal

Emitted when an incoming message has additional data.

◆ peerVerifyError

void VFS_tcp_client::peerVerifyError ( const QSslError & error )

protectedslot

VFS_tcp_client::peerVerifyError.

Parameters

error

Definition at line 389 of file VFS_tcp_client.cpp.

◆ readyMessage

void VFS_tcp_client::readyMessage ( QByteArray message )

signal

Emitted when a message is ready for processing.

◆ readyRead

void VFS_tcp_client::readyRead ( )

slot

DOCME.

Definition at line 281 of file VFS_tcp_client.cpp.

◆ reportDetails()

QString VFS_tcp_client::reportDetails ( )

virtual

Report data about this client.

Returns: A string containing the details

Reimplemented from VFS_node.

Definition at line 378 of file VFS_tcp_client.cpp.

◆ sslErrors

void VFS_tcp_client::sslErrors ( const QList< QSslError > & errors )

protectedslot

VFS_tcp_client::sslErrors.

Parameters

errors

Definition at line 403 of file VFS_tcp_client.cpp.

◆ sslReady

void VFS_tcp_client::sslReady ( )

protectedslot

Signal that an SSL connnection has been established.

This prints a log message. Subclasses can do fancy stuff if they want.

Definition at line 429 of file VFS_tcp_client.cpp.

◆ write()

void VFS_tcp_client::write ( VFS_request * r )

virtual

DOCME.

Parameters

r

Reimplemented from VFS_node.

Definition at line 348 of file VFS_tcp_client.cpp.

◆ writeMessage()

void VFS_tcp_client::writeMessage ( QByteArray data )

virtual

DOCME.

Parameters

data

Definition at line 331 of file VFS_tcp_client.cpp.

Friends And Related Function Documentation

◆ VFS_tcp_server

friend class VFS_tcp_server

friend

Definition at line 22 of file VFS_tcp_client.h.

Member Data Documentation

◆ _address

QString VFS_tcp_client::_address

protected

The address resolved by peerAddress(), or the address to connect to.

Definition at line 47 of file VFS_tcp_client.h.

◆ _initialized

bool VFS_tcp_client::_initialized

protected

Has this node been initialized?

Definition at line 46 of file VFS_tcp_client.h.

◆ _messageSize

MESSAGE_SIZE VFS_tcp_client::_messageSize

protected

The message size received. Will wait for this many bytes before emitting messageReady.

Definition at line 44 of file VFS_tcp_client.h.

◆ _port

quint16 VFS_tcp_client::_port

protected

The port to connect to.

Definition at line 48 of file VFS_tcp_client.h.

◆ _socket

QTcpSocket* VFS_tcp_client::_socket

protected

The socket connection.

Definition at line 43 of file VFS_tcp_client.h.

◆ _ssl

bool VFS_tcp_client::_ssl

protected

Use ssl?

Definition at line 49 of file VFS_tcp_client.h.

◆ _sslCertPath

QString VFS_tcp_client::_sslCertPath

protected

ssl cert file path.

Definition at line 50 of file VFS_tcp_client.h.

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

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VFS_tcp_client() [1/3]

◆ VFS_tcp_client() [2/3]

◆ VFS_tcp_client() [3/3]

◆ ~VFS_tcp_client()

Member Function Documentation

◆ close

◆ connected

◆ disconnected

◆ error

◆ init

◆ initSSL

◆ isContainer()

◆ modeChanged

◆ moreToRead

◆ peerVerifyError

◆ readyMessage

◆ readyRead

◆ reportDetails()

◆ sslErrors

◆ sslReady

◆ write()

◆ writeMessage()

Friends And Related Function Documentation

◆ VFS_tcp_server

Member Data Documentation

◆ _address

◆ _initialized

◆ _messageSize

◆ _port

◆ _socket

◆ _ssl

◆ _sslCertPath