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

tdecore

Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes

TDESocket Class Reference

A TCP/IP client socket. More...

#include <ksock.h>

Inheritance diagram for TDESocket:
TQObject

List of all members.

Public Slots

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

Signals

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

Public Member Functions

 TDESocket (int _sock) KDE_DEPRECATED
 TDESocket (const char *_host, unsigned short int _port, int timeOut=30) KDE_DEPRECATED
 TDESocket (const char *_path) KDE_DEPRECATED
virtual ~TDESocket ()
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 TDESocket on this identifier.

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

Author:
Torben Weis <weis@uni-frankfurt.de>

Definition at line 91 of file ksock.h.


Constructor & Destructor Documentation

TDESocket::TDESocket ( int  _sock  ) 

Constructs a TDESocket with the provided file descriptor.

Parameters:
_sock The file descriptor to use.

Definition at line 110 of file ksock.cpp.

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

Creates a socket and connects to a host.

Parameters:
_host The remote host to which to connect.
_port The port on the remote host.
timeOut The number of seconds waiting for connect (default 30).

Definition at line 124 of file ksock.cpp.

TDESocket::TDESocket ( const char *  _path  ) 

Connects to a UNIX domain socket.

Parameters:
_path The filename of the socket.

Definition at line 130 of file ksock.cpp.

TDESocket::~TDESocket (  )  [virtual]

Destructor.

Closes the socket if it is still open.

Definition at line 269 of file ksock.cpp.


Member Function Documentation

void TDESocket::closeEvent ( TDESocket *  s  )  [signal]

Raised when the connection is broken.

Parameters:
s the TDESocket that triggered the event
void TDESocket::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:
enable true to enable reading signals

Definition at line 136 of file ksock.cpp.

void TDESocket::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:
enable true to enable writing signals

Definition at line 152 of file ksock.cpp.

void TDESocket::readEvent ( TDESocket *  s  )  [signal]

Data has arrived for reading.

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

Parameters:
s the TDESocket that triggered the event
void TDESocket::slotRead ( int  x  )  [slot]

Connected to the readNotifier.

Called when the socket is ready for reading.

Parameters:
x ignored

Definition at line 169 of file ksock.cpp.

void TDESocket::slotWrite ( int  x  )  [slot]

Connected to the writeNotifier.

Called when the socket is ready for writing.

Parameters:
x ignored

Definition at line 180 of file ksock.cpp.

int TDESocket::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 TDESocket::writeEvent ( TDESocket *  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:
s the TDESocket that triggered the event

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

tdecore

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

tdecore

Skip menu "tdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdecore by doxygen 1.7.1
This website is maintained by Timothy Pearson.