CChannel Class Reference

The channel interface class. More...

#include <Channel.h>

Inheritance diagram for CChannel:

Collaboration diagram for CChannel:

Signals
void	sigConnected ()
	emit when the channel is connected.
void	sigDisconnected ()
	emit when the channel is disconnected
void	sigError (int nErr, const QString &szErr)
	emit when the channel is error
void	sigSecurityLevel (CSecurityLevel::Levels level)
	Triggered when the security level changes.
void	sigSend (quint64 counts)
	Send data counts.
void	sigReceive (quint64 counts)
	Receive data counts.

Public Member Functions
	CChannel (QTcpSocket *pSocket, QObject *parent=nullptr)
	CChannel.
virtual bool	open (OpenMode mode) override
virtual void	close () override
virtual QString	GetDetails ()
	Depend on information.

Static Public Member Functions
static int	InitTranslation ()
	Initial translation.
static int	RemoveTranslation ()
	Remove translation.

Protected Member Functions
	CChannel (QObject *parent=nullptr)
virtual qint64	readData (char *data, qint64 maxlen) override
virtual qint64	writeData (const char *data, qint64 len) override
virtual bool	isSequential () const override

Private Slots
void	slotError (QAbstractSocket::SocketError e)

Private Attributes
QTcpSocket *	m_pSocket

Detailed Description

The channel interface class.

This class implements a TCP channel by default.

Definition at line 27 of file Channel.h.

Constructor & Destructor Documentation

CChannel() [1/2]

CChannel::CChannel ( QTcpSocket *  pSocket, QObject *  parent = nullptr  )

explicit

CChannel.

Parameters

pSocket	Its owner is the caller
parent

Definition at line 19 of file Channel.cpp.

~CChannel()

CChannel::~CChannel ( )

virtual

Definition at line 27 of file Channel.cpp.

CChannel() [2/2]

CChannel::CChannel ( QObject *  parent = nullptr )

explicitprotected

Definition at line 14 of file Channel.cpp.

Member Function Documentation

close()

void CChannel::close ( )

overridevirtual

Definition at line 118 of file Channel.cpp.

GetDetails()

QString CChannel::GetDetails ( )

virtual

Depend on information.

Reimplemented in CChannelSSH.

Definition at line 129 of file Channel.cpp.

InitTranslation()

int CChannel::InitTranslation ( )

static

Initial translation.

Definition at line 134 of file Channel.cpp.

isSequential()

bool CChannel::isSequential ( ) const

overrideprotectedvirtual

Definition at line 76 of file Channel.cpp.

open()

bool CChannel::open ( OpenMode  mode )

overridevirtual

Parameters

pSocket

The Owner is the instance of this class.

Reimplemented in CChannelSSH, and CChannelSSHTunnelForward.

Definition at line 92 of file Channel.cpp.

readData()

qint64 CChannel::readData ( char *  data, qint64  maxlen  )

overrideprotectedvirtual

Definition at line 32 of file Channel.cpp.

RemoveTranslation()

int CChannel::RemoveTranslation ( )

static

Remove translation.

Definition at line 142 of file Channel.cpp.

sigReceive

void CChannel::sigReceive ( quint64  counts )

signal

Receive data counts.

Parameters

counts

sigSend

void CChannel::sigSend ( quint64  counts )

signal

Send data counts.

Parameters

counts

slotError

void CChannel::slotError ( QAbstractSocket::SocketError  e )

privateslot

Definition at line 81 of file Channel.cpp.

writeData()

qint64 CChannel::writeData ( const char *  data, qint64  len  )

overrideprotectedvirtual

Definition at line 53 of file Channel.cpp.

Member Data Documentation

m_pSocket

QTcpSocket* CChannel::m_pSocket

private

Definition at line 87 of file Channel.h.

---

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

• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/Channel/Channel.h
• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/Channel/Channel.cpp