Open a UDP port in write or read/write mode. More...

#include <VFS_udp_socket.h>

Inheritance diagram for VFS_udp_socket:

Public Slots
virtual bool	listen ()

virtual void	socketError (QAbstractSocket::SocketError error)

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...

Public Member Functions
Q_INVOKABLE	VFS_udp_socket (QHostAddress multicast, quint16 port, QString mode="rw")
	Create a VFS_udp_socket. More...

virtual	~VFS_udp_socket ()

virtual bool	isContainer ()
	A VFS_udp_socket cannot have children. More...

virtual QString	reportDetails ()
	Report details of this node. 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	readyRead ()

Protected Attributes
QHostAddress	_address
	Address used to listen or speak. More...

QString	_mode
	Either "rw" or "w". More...

quint16	_port
	UDP port. More...

QUdpSocket	_socket
	UDP socket. 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...

Private Member Functions
virtual void	write (VFS_request *r)
	Write to this node, which will emit UDP datagrams to the network. More...

Additional Inherited Members
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...

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

Open a UDP port in write or read/write mode.

Todo:: Add SSL options

Definition at line 8 of file VFS_udp_socket.h.

Constructor & Destructor Documentation

◆ VFS_udp_socket()

VFS_udp_socket::VFS_udp_socket	(	QHostAddress	multicast,
		quint16	port,
		QString	mode = `"rw"`
	)

explicit

Create a VFS_udp_socket.

Parameters

multicast	The multicast address to use.
port	The port
mode	The socket mode, which will be either "w" or "rw"

Definition at line 22 of file VFS_udp_socket.cpp.

◆ ~VFS_udp_socket()

VFS_udp_socket::~VFS_udp_socket ( )

virtual

Definition at line 41 of file VFS_udp_socket.cpp.

Member Function Documentation

◆ isContainer()

bool VFS_udp_socket::isContainer ( )

virtual

A VFS_udp_socket cannot have children.

Returns: false

As UDP is stateless, this node will not maintain a list of connected children.

Reimplemented from VFS_node.

Definition at line 53 of file VFS_udp_socket.cpp.

◆ listen

bool VFS_udp_socket::listen ( )

virtualslot

Returns

DOCME

Definition at line 65 of file VFS_udp_socket.cpp.

◆ readyRead

void VFS_udp_socket::readyRead ( )

protectedslot

Returns

DOCME

Definition at line 105 of file VFS_udp_socket.cpp.

◆ reportDetails()

QString VFS_udp_socket::reportDetails ( )

virtual

Report details of this node.

This will include the socket address and port, as well as the open state of the socket.

Reimplemented from VFS_node.

Definition at line 154 of file VFS_udp_socket.cpp.

◆ socketError

void VFS_udp_socket::socketError ( QAbstractSocket::SocketError error )

virtualslot

Parameters

error DOCME

Definition at line 121 of file VFS_udp_socket.cpp.

◆ write()

void VFS_udp_socket::write ( VFS_request * r )

privatevirtual

Write to this node, which will emit UDP datagrams to the network.

Parameters

r	The VFS_request object

Reimplemented from VFS_node.

Definition at line 132 of file VFS_udp_socket.cpp.

Member Data Documentation

◆ _address

QHostAddress VFS_udp_socket::_address

protected

Address used to listen or speak.

Definition at line 20 of file VFS_udp_socket.h.

◆ _mode

QString VFS_udp_socket::_mode

protected

Either "rw" or "w".

Definition at line 23 of file VFS_udp_socket.h.

◆ _port

quint16 VFS_udp_socket::_port

protected

UDP port.

Definition at line 21 of file VFS_udp_socket.h.

◆ _socket

QUdpSocket VFS_udp_socket::_socket

protected

UDP socket.

Definition at line 22 of file VFS_udp_socket.h.

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

Public Slots

Public Member Functions

Protected Slots

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VFS_udp_socket()

◆ ~VFS_udp_socket()

Member Function Documentation

◆ isContainer()

◆ listen

◆ readyRead

◆ reportDetails()

◆ socketError

◆ write()

Member Data Documentation

◆ _address

◆ _mode

◆ _port

◆ _socket