k3socks.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2001 George Staikos <staikos@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 version 2 as published by the Free Software Foundation.
 
   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., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
#ifndef _KSOCKS_H_
#define _KSOCKS_H_

#if defined(I_KNOW_KSOCKS_ISNT_PUBLIC)
/* "ksocks.h is not public API" */

#include <kdecore_export.h>

#include <QtCore/QStringList>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/time.h>
#include <unistd.h>

#ifdef Q_OS_UNIX

class KConfigGroup;
struct sockaddr;


class KDECORE_EXPORT KSocks {
public:

   static KSocks *self();

   static bool activated();

   void disableSocks();

   void enableSocks();

   bool usingSocks();

   bool hasSocks();

   bool hasWorkingAsyncConnect();

   /*
    **     REIMPLEMENTATIONS OF LIBC SOCKET FUNCTIONS
    **/
    int     connect     (int sockfd, const sockaddr *serv_addr, 
                                kde_socklen_t addrlen);
    signed long int read  (int fd, void *buf, unsigned long int count);
    signed long int write (int fd, const void *buf, unsigned long int count);
    int     recvfrom    (int s, void *buf, unsigned long int len, int flags, 
                                sockaddr *from, kde_socklen_t *fromlen);
    int     sendto      (int s, const void *msg, unsigned long int len, int flags,
                             const sockaddr *to, kde_socklen_t tolen);
    int     recv        (int s, void *buf, unsigned long int len, int flags);
    int     send        (int s, const void *msg, unsigned long int len, int flags);
    int     getsockname (int s, sockaddr *name, kde_socklen_t *namelen);
    int     getpeername (int s, sockaddr *name, kde_socklen_t *namelen);
    int     accept      (int s, sockaddr *addr, kde_socklen_t *addrlen);
    int     select      (int n, fd_set *readfds, fd_set *writefds, 
                                fd_set *exceptfds, struct timeval *timeout);
    int     listen      (int s, int backlog);

    int     bind        (int sockfd, sockaddr *my_addr, 
                                     kde_socklen_t addrlen);
    int     bind        (int sockfd, const sockaddr *my_addr, 
                                     kde_socklen_t addrlen);

   void die();

   static void disable();

   static void setConfig(const KConfigGroup *config);

private:
   explicit KSocks(const KConfigGroup *config);
   ~KSocks();

   void stopSocks();

   static KSocks *_me;
   static bool _disabled;


   class KSocksPrivate;
   KSocksPrivate * const d;
};

#endif //Q_OS_UNIX

#endif
#endif //_KSOCKS_H_