# Source: connection.h |
Annotated List
Files
Globals
Hierarchy
Index

    // -*- c++ -*-
    /* This file is part of the KDE libraries
        Copyright (C) 2000 Stephan Kulow <coolo@kde.org>
                           David Faure <faure@kde.org>

        This library is free software; you can redistribute it and/or
        modify it under the terms of the GNU Library General Public
        License as published by the Free Software Foundation; either
        version 2 of the License, or (at your option) any later version.

        This library is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
        Library General Public License for more details.

        You should have received a copy of the GNU Library General Public License
        along with this library; see the file COPYING.LIB.  If not, write to
        the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
        Boston, MA 02111-1307, USA.
    */

    #ifndef __connection_h__
    #define __connection_h__ "$Id: connection.h,v 1.18 2000/11/19 12:24:29 hausmann Exp $"

    #include <sys/types.h>

    #include <stdio.h>
    #include <kprocess.h>

    class KSocket;
    class QSocketNotifier;

    namespace KIO {

        struct Task {
    	int cmd;
    	QByteArray data;
        };

        /**
         * This class provides a simple means for IPC between two applications
         * via a pipe.
         * It handles a queue of commands to be sent, and has a internal signal
         * called after a command has been sent, to send the next one (FIFO).
         */
        class Connection : public QObject
        {
    	Q_OBJECT
        public:
    	Connection();
    	virtual ~Connection();

    	void init(KSocket *sock);
    	void connect(QObject *receiver = 0, const char *member = 0);
    	void close();

    	int fd_from() const { return fd_in; }
            int fd_to() const { return fileno( f_out ); }

    	void init(int fd_in, int fd_out);

    	bool inited() const { return (fd_in != -1) && (f_out != 0); }

    	// send (queues the command to be sent)
    	void send(int cmd, const QByteArray &arr = QByteArray());

    	// send (without queue)
    	bool sendnow( int _cmd, const QByteArray &data );

    	/**
    	 * Receive data
    	 *
    	 * @return >=0 indicates the received data size upon success
    	 *         -1  indicates error
    	 */
    	int read( int* _cmd, QByteArray & );

            /**
             * Don't handle incoming data until resumed
             */
            void suspend();

            /**
             * Resume handling of incoming data
             */
            void resume();

            /**
             * Returns status of connection
             */
            bool suspended() const { return m_suspended; }

    	void queueOnly(bool queue);

        protected slots:
            void dequeue();

        protected:

        private:
    	bool queueonly;
    	int fd_in;
    	FILE *f_out;
    	KSocket *socket;
    	QSocketNotifier *notifier;
    	QObject *receiver;
    	const char *member;
    	QList<Task> tasks;
    	int unqueuedTasks;
            bool m_suspended;
        };

    };

    #endif

Generated by: root@sparc.ports.openbsd.org on Wed May 2 09:40:40 2001, using kdoc 2.0a53.