CChannelSSHTunnelForward Class Reference

Includes SSH tunneling and a local socket service for forwarding data. More...

#include <ChannelSSHTunnelForward.h>

Inheritance diagram for CChannelSSHTunnelForward:

Collaboration diagram for CChannelSSHTunnelForward:

Public Types
enum class	SOCKET_TYPE { UnixSocket , Socket }

Signals
void	sigServer (QString szHost, quint16 nPort)
void	sigServer (QString szUnixDomainSocket)
Signals inherited from CChannel
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

Public Member Functions
	CChannelSSHTunnelForward (CParameterSSHTunnel *parameter, CParameterNet *remote, CBackend *pBackend, QObject *parent=nullptr)
virtual bool	open (OpenMode mode) override
virtual void	close () override
virtual int	Process ()
Public Member Functions inherited from CChannelSSHTunnel
	CChannelSSHTunnel (CParameterSSHTunnel *parameter, CParameterNet *remote, CBackend *pBackend, bool bWakeUp=true, QObject *parent=nullptr)
int	Process ()
virtual int	DoWait (bool bWrite, int timeout)
int	GetSocket ()
Public Member Functions inherited from CChannelSSH
	CChannelSSH (CBackend *pBackend, CParameterSSH *pPara, bool bWakeUp=true, QObject *parent=nullptr)
virtual int	WakeUp ()
virtual QString	GetDetails () override
	Depend on information.
Public Member Functions inherited from CChannel
	CChannel (QTcpSocket *pSocket, QObject *parent=nullptr)
	CChannel.

Private Member Functions
int	CloseSocket (socket_t &s)
int	AcceptConnect ()
int	ReadConnect ()
int	SSHReadyRead ()
int	OpenSocket ()

Private Attributes
socket_t	m_Listen
socket_t	m_Connector
SOCKET_TYPE	m_SocketType
char *	m_pBuffer
const int	m_BufferLength = 1024

Additional Inherited Members
Static Public Member Functions inherited from CChannel
static int	InitTranslation ()
	Initial translation.
static int	RemoveTranslation ()
	Remove translation.
Protected Member Functions inherited from CChannelSSHTunnel
virtual qint64	readData (char *data, qint64 maxlen) override
virtual qint64	writeData (const char *data, qint64 len) override
Protected Member Functions inherited from CChannel
	CChannel (QObject *parent=nullptr)
virtual bool	isSequential () const override
Protected Attributes inherited from CChannelSSH
ssh_session	m_Session
ssh_channel	m_Channel
CBackend *	m_pBackend
CParameterSSH *	m_pParameter
Channel::CEvent *	m_pEvent

Detailed Description

Includes SSH tunneling and a local socket service for forwarding data.

Data is forwarded over a local socket and SSH tunnel. It is suitable for cases where the library does not implement a transport layer interface, only socket.

Note

It is only used in CSSHTunnelThread

See also

CSSHTunnelThread

Definition at line 22 of file ChannelSSHTunnelForward.h.

Member Enumeration Documentation

SOCKET_TYPE

enum class CChannelSSHTunnelForward::SOCKET_TYPE

strong

Definition at line 38 of file ChannelSSHTunnelForward.h.

Constructor & Destructor Documentation

~CChannelSSHTunnelForward()

CChannelSSHTunnelForward::~CChannelSSHTunnelForward ( )

virtual

Definition at line 44 of file ChannelSSHTunnelForward.cpp.

Member Function Documentation

AcceptConnect()

int CChannelSSHTunnelForward::AcceptConnect ( )

private

Definition at line 241 of file ChannelSSHTunnelForward.cpp.

close()

void CChannelSSHTunnelForward::close ( )

overridevirtual

Reimplemented from CChannelSSH.

Definition at line 215 of file ChannelSSHTunnelForward.cpp.

CloseSocket()

int CChannelSSHTunnelForward::CloseSocket ( socket_t &  s )

private

Definition at line 225 of file ChannelSSHTunnelForward.cpp.

open()

bool CChannelSSHTunnelForward::open ( OpenMode  mode )

overridevirtual

Parameters

pSocket

The Owner is the instance of this class.

Reimplemented from CChannelSSH.

Definition at line 201 of file ChannelSSHTunnelForward.cpp.

OpenSocket()

int CChannelSSHTunnelForward::OpenSocket ( )

private

Definition at line 51 of file ChannelSSHTunnelForward.cpp.

Process()

int CChannelSSHTunnelForward::Process ( )

virtual

Returns

• >= 0: continue, Interval call time (msec)
• = -1: stop
• < -1: error

Definition at line 372 of file ChannelSSHTunnelForward.cpp.

ReadConnect()

int CChannelSSHTunnelForward::ReadConnect ( )

private

Definition at line 276 of file ChannelSSHTunnelForward.cpp.

SSHReadyRead()

int CChannelSSHTunnelForward::SSHReadyRead ( )

private

Definition at line 324 of file ChannelSSHTunnelForward.cpp.

Member Data Documentation

m_BufferLength

const int CChannelSSHTunnelForward::m_BufferLength = 1024

private

Definition at line 62 of file ChannelSSHTunnelForward.h.

m_Connector

socket_t CChannelSSHTunnelForward::m_Connector

private

Definition at line 49 of file ChannelSSHTunnelForward.h.

m_Listen

socket_t CChannelSSHTunnelForward::m_Listen

private

Definition at line 48 of file ChannelSSHTunnelForward.h.

m_pBuffer

char* CChannelSSHTunnelForward::m_pBuffer

private

Definition at line 61 of file ChannelSSHTunnelForward.h.

m_SocketType

SOCKET_TYPE CChannelSSHTunnelForward::m_SocketType

private

Definition at line 51 of file ChannelSSHTunnelForward.h.

---

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

• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/SSH/ChannelSSHTunnelForward.h
• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/SSH/ChannelSSHTunnelForward.cpp