class KSocket

A TCP/IP client socket. More...

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

Public Methods

Public Slots

Signals

Public Static Methods

Protected Methods

Protected Members


Detailed Description

You can connect this socket to any Internet address.

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.

 KSocket ( int _sock )

KSocket

Constructs a KSocket with the provided file descriptor.

Parameters:
_sockThe file descriptor to use.

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

KSocket

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

 KSocket ( const char * _path )

KSocket

Connects to a UNIX domain socket.

Parameters:
_pathThe filename of the socket.

 ~KSocket ()

~KSocket

[virtual]

Destructor. Closes the socket if it is still open.

int  socket ()

socket

[const]

Returns a file descriptor for this socket. Returns -1 when an error occured.

void  enableRead ( bool )

enableRead

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.

void  enableWrite ( bool )

enableWrite

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 !

unsigned long  ipv4_addr ()

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

bool  initSockaddr (ksockaddr_in *server_name, const char *hostname, unsigned short int port, int domain = PF_INET)

initSockaddr

[static]

A small wrapper around gethostbyname() and such. Don't use this in new programs. Use KExtendedSocket::lookup

void  readEvent ( KSocket * )

readEvent

[signal]

Data has arrived for reading.

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

void  writeEvent ( KSocket * )

writeEvent

[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 !

void  closeEvent ( KSocket * )

closeEvent

[signal]

Raised when the connection is broken.

void  slotWrite ( int )

slotWrite

[slot]

Connected to the writeNotifier.

Called when the socket is ready for writing.

void  slotRead ( int )

slotRead

[slot]

Connected to the readNotifier.

Called when the socket is ready for reading.

bool  connect ( const QString& _host, unsigned short int _port, int timeout = 0 )

connect

[protected]

bool  connect ( const char *_path )

connect

[protected]

int sock

sock

[protected]