MythSocket Class Reference

#include <mythsocket.h>

Inheritance diagram for MythSocket:

Public Types
enum	State { Connected, Connecting, HostLookup, Idle }
Public Member Functions
	MythSocket (int socket=-1, MythSocketCBs *cb=NULL)
void	close (void)
bool	closedByRemote (void)
void	deleteLater (void)
void	UpRef (void)
bool	DownRef (void)
State	state (void) const
QString	stateToString (void) const
QString	stateToString (const State state) const
QString	errorToString (void) const
QString	errorToString (const Error error) const
bool	Validate (uint timeout_ms=kMythSocketLongTimeout, bool error_dialog_desired=false)
void	setValidated (bool isValidated=true)
bool	isValidated (void)
bool	Announce (QStringList &strlist)
QStringList	getAnnounce (void)
void	setAnnounce (QStringList &strlist)
bool	isAnnounced (void)
bool	isExpectingReply (void)
void	setSocket (int socket, Type type=MSocketDevice::Stream)
void	setCallbacks (MythSocketCBs *cb)
void	useReadyReadCallback (bool useReadyReadCallback=true)
qint64	readBlock (char *data, quint64 len)
qint64	writeBlock (const char *data, quint64 len)
	Attempt to write 'len' bytes to socket.
bool	readStringList (QStringList &list, uint timeoutMS=kLongTimeout)
bool	readStringList (QStringList &list, bool quickTimeout)
bool	writeStringList (QStringList &list)
bool	SendReceiveStringList (QStringList &list, uint min_reply_length=0)
bool	readData (char *data, quint64 len)
	Read len bytes to data from socket.
bool	writeData (const char *data, quint64 len)
	Write len bytes to data to socket.
bool	connect (const QHostAddress &hadr, quint16 port)
	connect to host
bool	connect (const QString &host, quint16 port)
	connect to host
void	Lock (void) const
bool	TryLock (bool wakereadyread) const
void	Unlock (bool wakereadyread=true) const
Static Public Attributes
static const uint	kShortTimeout = kMythSocketShortTimeout
static const uint	kLongTimeout = kMythSocketLongTimeout
Protected Member Functions
	~MythSocket ()
void	setState (const State state)
Protected Attributes
MythSocketCBs *	m_cb
bool	m_useReadyReadCallback
State	m_state
QHostAddress	m_addr
quint16	m_port
int	m_ref_count
bool	m_notifyread
QMutex	m_ref_lock
QMutex	m_lock
bool	m_expectingreply
bool	m_isValidated
bool	m_isAnnounced
QStringList	m_announce
Static Protected Attributes
static const uint	kSocketBufferSize = 128000
static QMutex	s_readyread_thread_lock
static MythSocketThread *	s_readyread_thread = NULL
static QMap< QString, QHostAddress::SpecialAddress >	s_loopback_cache
Friends
class	MythSocketThread
class	QList< MythSocket * >
void	ShutdownRRT (void)

Detailed Description

Definition at line 18 of file mythsocket.h.

Member Enumeration Documentation

enum MythSocket::State

Enumerator:

Connected
Connecting
HostLookup
Idle

Definition at line 27 of file mythsocket.h.

Constructor & Destructor Documentation

MythSocket::MythSocket	(	int	socket = `-1`,
		MythSocketCBs *	cb = `NULL`
	)

Definition at line 44 of file mythsocket.cpp.

MythSocket::~MythSocket ( ) [protected]

Definition at line 73 of file mythsocket.cpp.

Member Function Documentation

void MythSocket::close ( void )

Closes the socket and sets the socket identifier to -1 (invalid).

(This function ignores errors; if there are any then a file descriptor leakage might result. As far as we know, the only error that can arise is EBADF, and that would of course not cause leakage. There may be OS-specific errors that we haven't come across, however.)

See also:: open()

Reimplemented from MSocketDevice.

Definition at line 210 of file mythsocket.cpp.

Referenced by connect(), MythSocketManager::HandleDone(), MainServer::HandleDone(), readBlock(), ZMClient::readData(), readData(), readStringList(), MythSocketThread::ReadyToBeRead(), setSocket(), ZMClient::shutdown(), LCD::shutdown(), writeBlock(), writeData(), and ~MythSocket().

bool MythSocket::closedByRemote ( void )

Definition at line 221 of file mythsocket.cpp.

Referenced by MythSocketThread::ReadyToBeRead().

void MythSocket::deleteLater ( void )

void MythSocket::UpRef ( void )

Definition at line 95 of file mythsocket.cpp.

Referenced by MythSocketThread::AddToReadyRead(), ProcessRequestRunnable::ProcessRequestRunnable(), PlaybackSock::SendReceiveStringList(), and SocketHandler::SocketHandler().

bool MythSocket::DownRef ( void )

MythSocket::State MythSocket::state ( void ) const

Definition at line 126 of file mythsocket.cpp.

Referenced by MythCoreContext::AllowShutdown(), MythCoreContext::BlockShutdown(), connect(), MythCoreContext::ConnectEventSocket(), OutboundRequestHandler::DoConnectToMaster(), readBlock(), readData(), readStringList(), MythCoreContext::readyRead(), MainServer::reconnectTimeout(), LCD::sendToServer(), setSocket(), writeBlock(), writeData(), and writeStringList().

QString MythSocket::stateToString ( void ) const [inline]

Definition at line 42 of file mythsocket.h.

Referenced by setState(), and stateToString().

QString MythSocket::stateToString ( const State state ) const

Definition at line 142 of file mythsocket.cpp.

QString MythSocket::errorToString ( void ) const [inline]

Definition at line 45 of file mythsocket.h.

Referenced by connect(), LCD::connectionFailed(), errorToString(), ZMClient::readData(), readData(), readStringList(), writeData(), and writeStringList().

QString MythSocket::errorToString ( const Error error ) const

Definition at line 159 of file mythsocket.cpp.

bool MythSocket::Validate	(	uint	timeout_ms = `kMythSocketLongTimeout`,
		bool	error_dialog_desired = `false`
	)

Definition at line 853 of file mythsocket.cpp.

Referenced by OutboundRequestHandler::DoConnectToMaster().

void MythSocket::setValidated ( bool isValidated = true ) [inline]

Definition at line 50 of file mythsocket.h.

Referenced by MythSocketManager::HandleVersion(), and Validate().

bool MythSocket::isValidated ( void ) [inline]

Definition at line 51 of file mythsocket.h.

Referenced by MythSocketManager::ProcessRequestWork().

bool MythSocket::Announce ( QStringList & strlist )

Definition at line 903 of file mythsocket.cpp.

Referenced by ControlRequestHandler::AnnounceSocket().

QStringList MythSocket::getAnnounce ( void ) [inline]

Definition at line 54 of file mythsocket.h.

void MythSocket::setAnnounce ( QStringList & strlist )

Definition at line 935 of file mythsocket.cpp.

Referenced by BaseRequestHandler::HandleAnnounce().

bool MythSocket::isAnnounced ( void ) [inline]

Definition at line 56 of file mythsocket.h.

Referenced by MythSocketManager::ProcessRequestWork().

bool MythSocket::isExpectingReply ( void ) [inline]

Definition at line 58 of file mythsocket.h.

Referenced by MythSocketManager::ProcessRequest(), and MythSocketManager::readyRead().

void MythSocket::setSocket	(	int	socket,
		Type	type = `MSocketDevice::Stream`
	)			`[virtual]`

Sets the socket device to operate on the existing socket socket.

The type argument must match the actual socket type; use MSocketDevice::Stream for a reliable, connection-oriented TCP socket, or MSocketDevice::Datagram for an unreliable, connectionless UDP socket.

Any existing socket is closed.