FtpSocket Class Reference

#include <ftp.h>

Inheritance diagram for FtpSocket:

[legend]

List of all members.

Public Member Functions
	FtpSocket (const char *pszName)
	~FtpSocket ()
void	closeSocket ()
int	connectSocket (int iTimeOutSec, bool bControl)
void	debugMessage (const char *pszMsg) const
int	errorMessage (int iErrorCode, const char *pszMsg) const
long	read (void *pData, long iMaxlen)
int	server () const
void	setServer (int i)
bool	setSocketOption (int opt, char *arg, socklen_t len) const
int	sock () const
int	textRead ()
long	write (void *pData, long iMaxlen)

---

Detailed Description

Definition at line 140 of file ftp.h.

---

Constructor & Destructor Documentation

FtpSocket::FtpSocket

(

const char *

pszName

)

[inline]

The one and only public xtor.

The string data passed to the xtor must remain valid during the object's lifetime - it is used in debug messages to identify the socket instance.

Definition at line 151 of file ftp.h.

FtpSocket::~FtpSocket

(

)

[inline]

Definition at line 157 of file ftp.h.

---

Member Function Documentation

void FtpSocket::closeSocket

(

)

Resets the status of the object, also called from xtor.

Definition at line 271 of file ftp.cc.

int FtpSocket::connectSocket	(	int	iTimeOutSec,
		bool	bControl
	)

connect socket and set some options (reuse, keepalive, linger)

Definition at line 237 of file ftp.cc.

void FtpSocket::debugMessage

(

const char *

pszMsg

)

const

output an debug message via kdDebug

Definition at line 226 of file ftp.cc.

int FtpSocket::errorMessage	(	int	iErrorCode,
		const char *	pszMsg
	)			const

output an error message via kdError, returns iErrorCode

Definition at line 231 of file ftp.cc.

long FtpSocket::read	(	void *	pData,
		long	iMaxlen
	)			[inline]

utility to read data from the effective socket, see sock()

Definition at line 204 of file ftp.h.

int FtpSocket::server

(

)

const [inline]

We may have a server connection socket if not in passive mode.

This routine returns the server socket set by setServer. The sock() function will return the server socket - if it is set.

Definition at line 169 of file ftp.h.

void FtpSocket::setServer

(

int

i

)

[inline]

Set the server socket if arg >= 0, otherwise clear it.

Definition at line 174 of file ftp.h.

bool FtpSocket::setSocketOption	(	int	opt,
		char *	arg,
		socklen_t	len
	)			const

utility to simplify calls to setsockopt().

Uses sock().

Definition at line 287 of file ftp.cc.

int FtpSocket::sock

(

)

const [inline]

returns the effective socket that user used for read/write.

See server()

Definition at line 179 of file ftp.h.

int FtpSocket::textRead

(

)

[inline]

Use the inherited FtpTextReader to read a line from the socket.

Definition at line 220 of file ftp.h.

long FtpSocket::write	(	void *	pData,
		long	iMaxlen
	)			[inline]

utility to write data to the effective socket, see sock()

Definition at line 212 of file ftp.h.

---

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

• ftp.h
• ftp.cc