KSocket Class Reference
A TCP/IP client socket. More...
#include <ksock.h>

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) |
unsigned long | ipv4_addr () KDE_DEPRECATED |
Static Public Member Functions | |
static bool | initSockaddr (ksockaddr_in *server_name, const char *hostname, unsigned short int port, int domain=PF_INET) KDE_DEPRECATED |
Protected Member Functions | |
bool | connect (const QString &_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.
Definition at line 87 of file ksock.h.
Constructor & Destructor Documentation
KSocket::KSocket | ( | int | _sock | ) |
KSocket::KSocket | ( | const char * | _host, | |
unsigned short int | _port, | |||
int | timeOut = 30 | |||
) |
KSocket::KSocket | ( | const char * | _path | ) |
KSocket::~KSocket | ( | ) | [virtual] |
Member Function Documentation
void KSocket::closeEvent | ( | KSocket * | s | ) | [signal] |
Raised when the connection is broken.
- Parameters:
-
s the 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:
-
enable true to enable reading signals
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:
-
enable true to enable writing signals
bool KSocket::initSockaddr | ( | ksockaddr_in * | server_name, | |
const char * | hostname, | |||
unsigned short int | port, | |||
int | domain = PF_INET | |||
) | [static] |
A small wrapper around gethostbyname() and such.
Don't use this in new programs. Use KExtendedSocket::lookup
unsigned long KSocket::ipv4_addr | ( | ) |
Return address.
This function is dumb. Don't ever use it if you need the peer address of this socket, use KExtendedSocket::peerAddress(int) instead
void KSocket::readEvent | ( | KSocket * | s | ) | [signal] |
Data has arrived for reading.
This signal will only be raised if enableRead( true
) was called first.
- Parameters:
-
s the KSocket that triggered the event
void KSocket::slotRead | ( | int | x | ) | [slot] |
void KSocket::slotWrite | ( | int | x | ) | [slot] |
int KSocket::socket | ( | ) | const [inline] |
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:
-
s the KSocket that triggered the event
The documentation for this class was generated from the following files: