kio Library API Documentation

KIO::Connection Class Reference

This class provides a simple means for IPC between two applications via a pipe. More...

#include <connection.h>

Inheritance diagram for KIO::Connection:

QObject List of all members.

Public Member Functions

 Connection ()
void init (KSocket *sock)
void init (int fd_in, int fd_out)
void connect (QObject *receiver=0, const char *member=0)
void close ()
int fd_from () const
int fd_to () const
bool inited () const
void send (int cmd, const QByteArray &arr=QByteArray())
bool sendnow (int _cmd, const QByteArray &data)
int read (int *_cmd, QByteArray &data)
void suspend ()
void resume ()
bool suspended () const

Protected Slots

void dequeue ()

Detailed Description

This class provides a simple means for IPC between two applications via a pipe.

It handles a queue of commands to be sent which makes it possible to queue data before an actual connection has been established.

Definition at line 47 of file connection.h.


Constructor & Destructor Documentation

Connection::Connection  ) 
 

Creates a new connection.

See also:
init()

Definition at line 47 of file connection.cpp.

References QPtrList< Task >::setAutoDelete().


Member Function Documentation

void Connection::init KSocket sock  ) 
 

Initialize this connection to use the given socket.

Parameters:
sock the socket to use
See also:
inited()

Definition at line 117 of file connection.cpp.

References QObject::connect(), KSocket::socket(), and suspend().

Referenced by KIO::SlaveBase::connectSlave().

void Connection::init int  fd_in,
int  fd_out
 

Initialize the connection to use the given file descriptors.

Parameters:
fd_in the input file descriptor to use
fd_out the output file descriptor to use
See also:
inited()

Definition at line 135 of file connection.cpp.

References QObject::connect(), and suspend().

void Connection::close  ) 
 

Closes the connection.

Definition at line 78 of file connection.cpp.

References QPtrList< Task >::clear().

int KIO::Connection::fd_from  )  const [inline]
 

Returns the input file descriptor.

Returns:
the input file descriptor

Definition at line 80 of file connection.h.

int KIO::Connection::fd_to  )  const [inline]
 

Returns the output file descriptor.

Returns:
the output file descriptor

Definition at line 85 of file connection.h.

bool KIO::Connection::inited  )  const [inline]
 

Checks whether the connection has been initialized.

Returns:
true if the initialized
See also:
init()

Definition at line 92 of file connection.h.

Referenced by KIO::SlaveBase::connectSlave(), and send().

void Connection::send int  cmd,
const QByteArray arr = QByteArray()
 

Sends/queues the given command to be sent.

Parameters:
cmd the command to set
arr the bytes to send

Definition at line 91 of file connection.cpp.

References QPtrList< Task >::append(), QPtrList< Task >::count(), inited(), and sendnow().

Referenced by KIO::SlaveBase::canResume(), KIO::SlaveBase::connected(), KIO::SlaveBase::data(), KIO::SlaveBase::dataReq(), KIO::SlaveBase::delCachedAuthentication(), KIO::SlaveBase::dropNetwork(), KIO::SlaveBase::error(), KIO::SlaveBase::errorPage(), KIO::SlaveBase::finished(), KIO::SlaveBase::infoMessage(), KIO::SlaveBase::listEntries(), KIO::SlaveBase::messageBox(), KIO::SlaveBase::mimeType(), KIO::SlaveBase::needSubURLData(), KIO::SlaveBase::processedSize(), KIO::SlaveBase::redirection(), KIO::SlaveBase::requestNetwork(), KIO::SlaveBase::sendAuthenticationKey(), KIO::SlaveBase::sendMetaData(), KIO::SlaveBase::slaveStatus(), KIO::SlaveBase::speed(), KIO::SlaveBase::statEntry(), KIO::SlaveBase::totalSize(), and KIO::SlaveBase::warning().

bool Connection::sendnow int  _cmd,
const QByteArray data
 

Sends the given command immediately.

Parameters:
_cmd the command to set
data the bytes to send
Returns:
true if successful, false otherwise

Definition at line 166 of file connection.cpp.

References kdError().

Referenced by KIO::SlaveInterface::openPassDlg(), and send().

int Connection::read int *  _cmd,
QByteArray data
 

Receive data.

Parameters:
_cmd the received command will be written here
data the received data will be written here
Returns:
>=0 indicates the received data size upon success -1 indicates error

Definition at line 197 of file connection.cpp.

References kdError().

Referenced by KIO::SlaveBase::mimeType(), and KIO::SlaveBase::waitForAnswer().

void Connection::suspend  ) 
 

Don't handle incoming data until resumed.

Definition at line 64 of file connection.cpp.

References QSocketNotifier::setEnabled().

Referenced by init().

void Connection::resume  ) 
 

Resume handling of incoming data.

Definition at line 71 of file connection.cpp.

References QSocketNotifier::setEnabled().

bool KIO::Connection::suspended  )  const [inline]
 

Returns status of connection.

Returns:
true if suspended, false otherwise

Definition at line 133 of file connection.h.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kio Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed May 5 07:16:59 2004 by doxygen 1.3.6 written by Dimitri van Heesch, © 1997-2003