SocketHandler Class Reference

#include <libmythprotoserver/sockethandler.h>

Inheritance diagram for SocketHandler:

Collaboration diagram for SocketHandler:

Public Member Functions
	SocketHandler (MythSocket *sock, MythSocketManager *parent, QString hostname)
	~SocketHandler () override
bool	DoesBlockShutdown (void) const
bool	GetsStandardEvents (void) const
bool	GetsSystemEvents (void) const
QString	GetHostname (void) const
MythSocket *	GetSocket (void) const
MythSocketManager *	GetParent (void) const
bool	WriteStringList (const QStringList &strlist)
bool	SendReceiveStringList (QStringList &strlist, uint min_reply_length=0)
void	BlockShutdown (bool block)
void	AllowStandardEvents (bool allow)
void	AllowSystemEvents (bool allow)
Public Member Functions inherited from ReferenceCounter
	ReferenceCounter (const QString &debugName, bool logDebug=true)
	Creates reference counter with an initial value of 1. More...
virtual int	IncrRef (void)
	Increments reference count. More...
virtual int	DecrRef (void)
	Decrements reference count and deletes on 0. More...

Private Attributes
bool	m_blockShutdown { false }
bool	m_standardEvents { false }
bool	m_systemEvents { false }
MythSocket *	m_socket { nullptr }
MythSocketManager *	m_parent { nullptr }
QString	m_hostname

Additional Inherited Members
Static Public Member Functions inherited from ReferenceCounter
static void	PrintDebug (void)
	Print out any leaks if that level of debugging is enabled. More...
Protected Member Functions inherited from ReferenceCounter
virtual	~ReferenceCounter (void)
	Called on destruction, will warn if object deleted with references in place. More...
Protected Attributes inherited from ReferenceCounter
bool	m_logDebug
	This is used to suppress creating LoggingItem classes for LoggingItem reference count changes. More...
QAtomicInt	m_referenceCount {1}

Detailed Description

Definition at line 16 of file sockethandler.h.

Constructor & Destructor Documentation

SocketHandler()

SocketHandler::SocketHandler	(	MythSocket *	sock,
		MythSocketManager *	parent,
		QString	hostname
	)

Definition at line 6 of file sockethandler.cpp.

~SocketHandler()

SocketHandler::~SocketHandler ( )

override

Definition at line 16 of file sockethandler.cpp.

Member Function Documentation

AllowStandardEvents()

void SocketHandler::AllowStandardEvents ( bool  allow )

inline

Definition at line 36 of file sockethandler.h.

AllowSystemEvents()

void SocketHandler::AllowSystemEvents ( bool  allow )

inline

Definition at line 37 of file sockethandler.h.

BlockShutdown()

void SocketHandler::BlockShutdown ( bool  block )

inline

Definition at line 35 of file sockethandler.h.

Referenced by FileServerHandler::HandleAnnounce().

DoesBlockShutdown()

bool SocketHandler::DoesBlockShutdown ( void  ) const

inline

Definition at line 23 of file sockethandler.h.

GetHostname()

QString SocketHandler::GetHostname ( void  ) const

inline

Definition at line 27 of file sockethandler.h.

GetParent()

MythSocketManager * SocketHandler::GetParent ( void  ) const

inline

Definition at line 30 of file sockethandler.h.

GetSocket()

MythSocket * SocketHandler::GetSocket ( void  ) const

inline

Definition at line 29 of file sockethandler.h.

Referenced by MythSocketManager::AddSocketHandler(), FileTransfer::RequestBlock(), and FileTransfer::WriteBlock().

GetsStandardEvents()

bool SocketHandler::GetsStandardEvents ( void  ) const

inline

Definition at line 24 of file sockethandler.h.

GetsSystemEvents()

bool SocketHandler::GetsSystemEvents ( void  ) const

inline

Definition at line 25 of file sockethandler.h.

SendReceiveStringList()

bool SocketHandler::SendReceiveStringList	(	QStringList &	strlist,
		uint	min_reply_length = 0
	)

Definition at line 33 of file sockethandler.cpp.

Referenced by FileServerHandler::HandleFileQuery(), and FileServerHandler::HandleGetFileList().

WriteStringList()

bool SocketHandler::WriteStringList

(

const QStringList &

strlist

)

Definition at line 25 of file sockethandler.cpp.

Referenced by FileServerHandler::HandleDeleteFile(), FileServerHandler::HandleDownloadFile(), FileServerHandler::HandleFileQuery(), FileServerHandler::HandleGetFileList(), MessageHandler::HandleInbound(), FileServerHandler::HandleQueryCheckFile(), FileServerHandler::HandleQueryFileExists(), FileServerHandler::HandleQueryFileHash(), FileServerHandler::HandleQueryFileTransfer(), FileServerHandler::HandleQueryFreeSpace(), FileServerHandler::HandleQueryFreeSpaceList(), FileServerHandler::HandleQueryFreeSpaceSummary(), BaseRequestHandler::HandleQueryHostname(), BaseRequestHandler::HandleQueryLoad(), BaseRequestHandler::HandleQueryMemStats(), BaseRequestHandler::HandleQueryTimeZone(), and BaseRequestHandler::HandleQueryUptime().

Member Data Documentation

m_blockShutdown

bool SocketHandler::m_blockShutdown { false }

private

Definition at line 40 of file sockethandler.h.

m_hostname

QString SocketHandler::m_hostname

private

Definition at line 47 of file sockethandler.h.

m_parent

MythSocketManager* SocketHandler::m_parent { nullptr }

private

Definition at line 45 of file sockethandler.h.

m_socket

MythSocket* SocketHandler::m_socket { nullptr }

private

Definition at line 44 of file sockethandler.h.

Referenced by SendReceiveStringList(), SocketHandler(), WriteStringList(), and ~SocketHandler().

m_standardEvents

bool SocketHandler::m_standardEvents { false }

private

Definition at line 41 of file sockethandler.h.

m_systemEvents

bool SocketHandler::m_systemEvents { false }

private

Definition at line 42 of file sockethandler.h.

---

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

• mythtv/libs/libmythprotoserver/sockethandler.h
• mythtv/libs/libmythprotoserver/sockethandler.cpp