• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KSocket Class Reference

#include <ksock.h>

Inherits TQObject.

Public Slots

void slotWrite (int x)
 
void slotRead (int x)
 

Signals

void readEvent (KSocket *s)
 
void writeEvent (KSocket *s)
 
void closeEvent (KSocket *s)
 

Public Member Functions

 KSocket (int _sock) KDE_DEPRECATED
 
 KSocket (const char *_host, unsigned short int _port, int timeOut=30) KDE_DEPRECATED
 
 KSocket (const char *_path) KDE_DEPRECATED
 
virtual ~KSocket ()
 
int socket () const
 
void enableRead (bool enable)
 
void enableWrite (bool enable)
 

Protected Member Functions

bool connect (const TQString &_host, unsigned short int _port, int timeout=0)
 
bool connect (const char *_path)
 

Protected Attributes

int sock
 

Detailed Description

A TCP/IP client socket.

Deprecated:
You can connect this socket to any Internet address.

This class is deprecated and will be removed in the future. For new programs, please use KExtendedSocket class.

The socket gives you three signals: When ready for reading, ready for writing or if the connection is broken. Using socket() you get a file descriptor which you can use with the usual UNIX function like write() or read(). If you have already such a socket identifier you can construct a KSocket on this identifier.

If socket() delivers a value of -1 or less, the connection was not successful.

Author
Torben Weis weis@.nosp@m.uni-.nosp@m.frank.nosp@m.furt.nosp@m..de

Definition at line 91 of file ksock.h.

Constructor & Destructor Documentation

KSocket::KSocket ( int  _sock)

Constructs a KSocket with the provided file descriptor.

Parameters
_sockThe file descriptor to use.

Definition at line 105 of file ksock.cpp.

KSocket::KSocket ( const char *  _host,
unsigned short int  _port,
int  timeOut = 30 
)

Creates a socket and connects to a host.

Parameters
_hostThe remote host to which to connect.
_portThe port on the remote host.
timeOutThe number of seconds waiting for connect (default 30).

Definition at line 119 of file ksock.cpp.

KSocket::KSocket ( const char *  _path)

Connects to a UNIX domain socket.

Parameters
_pathThe filename of the socket.

Definition at line 125 of file ksock.cpp.

KSocket::~KSocket ( )
virtual

Destructor.

Closes the socket if it is still open.

Definition at line 264 of file ksock.cpp.

Member Function Documentation

void KSocket::closeEvent ( KSocket *  s)
signal

Raised when the connection is broken.

Parameters
sthe KSocket that triggered the event
void KSocket::enableRead ( bool  enable)

Enables the socket for reading.

If you enable read mode, the socket will emit the signal readEvent() whenever there is something to read out of this socket.

Parameters
enabletrue to enable reading signals

Definition at line 131 of file ksock.cpp.

void KSocket::enableWrite ( bool  enable)

Enables the socket for writing.

If you enable write mode, the socket will emit the signal writeEvent() whenever the socket is ready for writing.

Warning: If you forget to call enableWrite(false) when you are not ready to send data, you will get lots of writeEvent() signals, in the order of thousands a second !

Parameters
enabletrue to enable writing signals

Definition at line 147 of file ksock.cpp.

void KSocket::readEvent ( KSocket *  s)
signal

Data has arrived for reading.

This signal will only be raised if enableRead( true ) was called first.

Parameters
sthe KSocket that triggered the event
void KSocket::slotRead ( int  x)
slot

Connected to the readNotifier.

Called when the socket is ready for reading.

Parameters
xignored

Definition at line 164 of file ksock.cpp.

void KSocket::slotWrite ( int  x)
slot

Connected to the writeNotifier.

Called when the socket is ready for writing.

Parameters
xignored

Definition at line 175 of file ksock.cpp.

int KSocket::socket ( ) const
inline

Returns a file descriptor for this socket.

Returns
the file descriptor, or -1 when an error occurred.

Definition at line 123 of file ksock.h.

void KSocket::writeEvent ( KSocket *  s)
signal

Socket is ready for writing.

This signal will only be raised if enableWrite( true ) was called first.

Warning: If you forget to call enableWrite(false) when you are not ready to send data, you will get lots of writeEvent() signals, in the order of thousands a second !

Parameters
sthe KSocket that triggered the event

The documentation for this class was generated from the following files:
  • ksock.h
  • ksock.cpp

kdecore

Skip menu "kdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.8.8
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |