class KSocket

a TCP/IP client socket. More...

Definition#include <ksock.h>
InheritsQObject (qt)
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Members

Public Slots

Protected Members

Signals


Detailed Description

A TCP/IP client socket. You can connect this socket to any internet address.

The socket gives you three signals: When ready for reading/writing or if the connection is broken. Using socket() you get a file descriptor which you can use with usual unix commands 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 had no success.

KSocket ( int _sock )

Create a KSocket with the provided file descriptor.

Parameters:
_sockthe file descriptor to use.

KSocket ( const char *_host, unsigned short int _port )

Create a socket and connect to a host.

Parameters:
_hostthe remote host to which to connect.
_portthe port on the remote host.

KSocket ( const char *_path )

Connects to a UNIX domain socket.

Parameters:
_paththe filename of the socket

~KSocket ()

Destructor. Closes the socket if it is still open.

int socket ()
[const]

Returns a file descriptor for this socket.

void enableRead ( bool )

Enable 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.

void enableWrite ( bool )

Enable the socket for writing.

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

unsigned long getAddr ()

Return address.

void readEvent ( KSocket * )
[signal]

Data has arrived for reading.

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

void writeEvent ( KSocket * )
[signal]

Socket is ready for writing.

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

void closeEvent ( KSocket * )
[signal]

Raised when the connection is broken.

void slotWrite ( int )
[slot]

Connected to the writeNotifier.

void slotRead ( int )
[slot]

Connected to the readNotifier.

int sock
[protected]

The file descriptor for this socket. sock may be -1. This indicates that it is not connected.